Skip to content

Commit

Permalink
added missing docstring for TransSlice
Browse files Browse the repository at this point in the history
  • Loading branch information
pebbe committed Aug 31, 2019
1 parent e533068 commit 3d77007
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions v5/proj.go
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,17 @@ func (p *PJ) Trans(direction Direction, u1, v1, w1, t1 float64) (u2, v2, w2, t2
return float64(u), float64(v), float64(w), float64(t), nil
}

/*
Transform a series of coordinates, where the individual coordinate dimension may be represented by a slice that is either
1. fully populated
2. nil and/or a length of zero, which will be treated as a fully populated slice of zeroes
3. of length one, i.e. a constant, which will be treated as a fully populated slice of that constant value
TODO: what if input is constant, but output is not?
*/
func (p *PJ) TransSlice(direction Direction, u1, v1, w1, t1 []float64) (u2, v2, w2, t2 []float64, err error) {
if !p.opened {
return nil, nil, nil, nil, errProjectionClosed
Expand Down

0 comments on commit 3d77007

Please sign in to comment.