From 993b37ed19593b16dd9de8c539d57a0fa3a4f5d8 Mon Sep 17 00:00:00 2001 From: Michael Bayne Date: Fri, 11 May 2012 08:40:30 -0700 Subject: [PATCH] Reinstate implementation detail notes plus {@inheritDoc}. --- src/main/java/pythagoras/f/Matrix3.java | 12 +++++++----- src/main/java/pythagoras/f/Matrix4.java | 9 +++++++++ 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/src/main/java/pythagoras/f/Matrix3.java b/src/main/java/pythagoras/f/Matrix3.java index 21824c6..3a6c38b 100644 --- a/src/main/java/pythagoras/f/Matrix3.java +++ b/src/main/java/pythagoras/f/Matrix3.java @@ -471,11 +471,8 @@ public class Matrix3 implements IMatrix3, Serializable } /** - * Inverts this matrix and places the result in the given object. This code is based on the - * examples in the Matrix and - * Quaternion FAQ. - * - * @return a reference to the result matrix, for chaining. + * @{@inheritDoc} This code is based on the examples in the + * Matrix and Quaternion FAQ. */ @Override // from IMatrix3 public Matrix3 invert (Matrix3 result) throws SingularMatrixException { @@ -641,6 +638,11 @@ public class Matrix3 implements IMatrix3, Serializable return result.set(m00*vx + m10*vy, m01*vx + m11*vy); } + /** + * {@inheritDoc} This uses the iterative polar decomposition algorithm described by + * Ken + * Shoemake. + */ @Override // from IMatrix3 public float extractRotation () { // start with the contents of the upper 2x2 portion of the matrix diff --git a/src/main/java/pythagoras/f/Matrix4.java b/src/main/java/pythagoras/f/Matrix4.java index bf15ac5..2dff095 100644 --- a/src/main/java/pythagoras/f/Matrix4.java +++ b/src/main/java/pythagoras/f/Matrix4.java @@ -705,6 +705,10 @@ public final class Matrix4 implements IMatrix4, Serializable return invert(new Matrix4()); } + /** + * {@inheritDoc} This code is based on the examples in the + * Matrix and Quaternion FAQ. + */ @Override // from IMatrix4 public Matrix4 invert (Matrix4 result) throws SingularMatrixException { float m00 = this.m00, m10 = this.m10, m20 = this.m20, m30 = this.m30; @@ -917,6 +921,11 @@ public final class Matrix4 implements IMatrix4, Serializable return extractRotation(new Quaternion()); } + /** + * {@inheritDoc} This uses the iterative polar decomposition algorithm described by + * Ken + * Shoemake. + */ @Override // from IMatrix4 public Quaternion extractRotation (Quaternion result) throws SingularMatrixException { // start with the contents of the upper 3x3 portion of the matrix