minor doc changes

This commit is contained in:
faiface 2017-06-11 01:17:37 +02:00
parent 6a9211310a
commit 51cd0314d5
1 changed files with 6 additions and 6 deletions

View File

@ -49,11 +49,6 @@ func (u Vec) XY() (x, y float64) {
return u.X, u.Y return u.X, u.Y
} }
// Normal returns a vector normal to u (rotated by math.pi/2)
func (u Vec) Normal() Vec {
return Vec{X: u.Y, Y: -u.X}
}
// Add returns the sum of vectors u and v. // Add returns the sum of vectors u and v.
func (u Vec) Add(v Vec) Vec { func (u Vec) Add(v Vec) Vec {
return Vec{ return Vec{
@ -70,7 +65,7 @@ func (u Vec) Sub(v Vec) Vec {
} }
} }
// To returns the vector from vector u to vector v, equivalent to v.Sub(u). // To returns the vector from u to v. Equivalent to v.Sub(u).
func (u Vec) To(v Vec) Vec { func (u Vec) To(v Vec) Vec {
return Vec{ return Vec{
v.X - u.X, v.X - u.X,
@ -115,6 +110,11 @@ func (u Vec) Rotated(angle float64) Vec {
} }
} }
// Normal returns a vector normal to u. Equivalent to u.Rotated(math.Pi / 2).
func (u Vec) Normal() Vec {
return Vec{X: u.Y, Y: -u.X}
}
// Dot returns the dot product of vectors u and v. // Dot returns the dot product of vectors u and v.
func (u Vec) Dot(v Vec) float64 { func (u Vec) Dot(v Vec) float64 {
return u.X*v.X + u.Y*v.Y return u.X*v.X + u.Y*v.Y