package/gonum
1
0
Fork 0
mirror of https://github.com/gonum/gonum.git synced 2025-10-06 07:37:03 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

spatial/{r2,r3}: fix/clarify doc comments

Browse Source
This commit is contained in:
Dan Kortschak
2021-06-20 11:51:44 +09:30
parent d920954870
commit f2a128f642
2 changed files with 6 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
spatial/r3/vector.go
View File

@@ -67,7 +67,7 @@ func Norm(p Vec) float64 {
return math.Hypot(p.X, math.Hypot(p.Y, p.Z))
}
// Norm returns the Euclidean squared norm of p
// Norm2 returns the Euclidean squared norm of p
// |p|^2 = p_x^2 + p_y^2 + p_z^2.
func Norm2(p Vec) float64 {
return p.X*p.X + p.Y*p.Y + p.Z*p.Z
@@ -121,7 +121,8 @@ func NewRotation(alpha float64, axis Vec) Rotation {
return Rotation(q)
}
// Rotate returns the rotated vector according to the definition of rot.
// Rotate returns p rotated according to the parameters used to construct
// the receiver.
func (r Rotation) Rotate(p Vec) Vec {
if r.isIdentity() {
return p