asfgit closed pull request #27: Numbers 89: Standardize Method Names with commons-geometry URL: https://github.com/apache/commons-numbers/pull/27
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java index 6df0bb8d..80fee262 100644 --- a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java +++ b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Quaternion.java @@ -27,7 +27,11 @@ * This class implements <a href="http://mathworld.wolfram.com/Quaternion.html";> * quaternions</a> (Hamilton's hypercomplex numbers). * - * <p>Instance of this class are guaranteed to be immutable.</p> + * <p>Wherever quaternion components are listed in sequence, this class follows the + * convention of placing the scalar ({@code w}) component first, e.g. [{@code w, x, y, z}]. + * Other libraries and textbooks may place the {@code w} component last.</p> + * + * <p>Instances of this class are guaranteed to be immutable.</p> */ public final class Quaternion implements Serializable { /** Zero quaternion. */ @@ -153,21 +157,21 @@ boolean isUnit(Quaternion q, * Builds a quaternion from its components. * * @param type Quaternion type. - * @param a Scalar component. - * @param b First vector component. - * @param c Second vector component. - * @param d Third vector component. + * @param w Scalar component. + * @param x First vector component. + * @param y Second vector component. + * @param z Third vector component. */ private Quaternion(Type type, - final double a, - final double b, - final double c, - final double d) { + final double w, + final double x, + final double y, + final double z) { this.type = type; - w = a; - x = b; - y = c; - z = d; + this.w = w; + this.x = x; + this.y = y; + this.z = z; } /** @@ -188,18 +192,18 @@ private Quaternion(Type type, /** * Builds a quaternion from its components. * - * @param a Scalar component. - * @param b First vector component. - * @param c Second vector component. - * @param d Third vector component. + * @param w Scalar component. + * @param x First vector component. + * @param y Second vector component. + * @param z Third vector component. * @return a quaternion instance. */ - public static Quaternion of(final double a, - final double b, - final double c, - final double d) { + public static Quaternion of(final double w, + final double x, + final double y, + final double z) { return new Quaternion(Type.DEFAULT, - a, b, c, d); + w, x, y, z); } /** @@ -338,7 +342,7 @@ public Quaternion subtract(final Quaternion q) { * @param q2 Quaternion. * @return the dot product of {@code q1} and {@code q2}. */ - public static double dotProduct(final Quaternion q1, + public static double dot(final Quaternion q1, final Quaternion q2) { return q1.w * q2.w + q1.x * q2.x + @@ -352,8 +356,8 @@ public static double dotProduct(final Quaternion q1, * @param q Quaternion. * @return the dot product of this instance and {@code q}. */ - public double dotProduct(final Quaternion q) { - return dotProduct(this, q); + public double dot(final Quaternion q) { + return dot(this, q); } /** diff --git a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java index a7096ea1..33325503 100644 --- a/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java +++ b/commons-numbers-quaternion/src/main/java/org/apache/commons/numbers/quaternion/Slerp.java @@ -51,7 +51,7 @@ public Slerp(Quaternion start, this.start = start.positivePolarForm(); final Quaternion e = end.positivePolarForm(); - double dot = this.start.dotProduct(e); + double dot = this.start.dot(e); // If the dot product is negative, then the interpolation won't follow the shortest // angular path between the two quaterions. In this case, invert the end quaternion diff --git a/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/QuaternionTest.java b/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/QuaternionTest.java index 5d5f99b4..f1d96b8b 100644 --- a/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/QuaternionTest.java +++ b/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/QuaternionTest.java @@ -221,8 +221,8 @@ public final void testDotProductQuaternionQuaternion() { final Quaternion q1 = Quaternion.of(1, 2, 2, 1); final Quaternion q2 = Quaternion.of(3, -2, -1, -3); - final double actual1 = Quaternion.dotProduct(q1, q2); - final double actual2 = q1.dotProduct(q2); + final double actual1 = Quaternion.dot(q1, q2); + final double actual2 = q1.dot(q2); Assert.assertEquals(expected, actual1, EPS); Assert.assertEquals(expected, actual2, EPS); diff --git a/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/SlerpTest.java b/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/SlerpTest.java index c966fe3e..ef9e0137 100644 --- a/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/SlerpTest.java +++ b/commons-numbers-quaternion/src/test/java/org/apache/commons/numbers/quaternion/SlerpTest.java @@ -146,7 +146,7 @@ public void testSlerp_inputQuaternionsHaveMinusOneDotProduct() { Slerp slerp = new Slerp(q1, q2); // act/assert - Assert.assertEquals(-1.0, q1.dotProduct(q2), EPS); + Assert.assertEquals(-1.0, q1.dot(q2), EPS); Quaternion expected = q1.positivePolarForm(); ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
