You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by er...@apache.org on 2019/11/24 23:09:54 UTC
[commons-geometry] 03/04: fixing VectorXD.linearCombination() docs
This is an automated email from the ASF dual-hosted git repository.
erans pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-geometry.git
commit 3ec296329122ab64a10d5bef5b850629a5bc62d9
Author: Matt Juntunen <ma...@hotmail.com>
AuthorDate: Sun Nov 24 15:02:14 2019 -0500
fixing VectorXD.linearCombination() docs
---
.../commons/geometry/euclidean/oned/Vector1D.java | 49 +++++++++++-----------
.../geometry/euclidean/threed/Vector3D.java | 48 ++++++++++-----------
.../commons/geometry/euclidean/twod/Vector2D.java | 48 ++++++++++-----------
3 files changed, 72 insertions(+), 73 deletions(-)
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Vector1D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Vector1D.java
index 57ff97d..d62e0a6 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Vector1D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/oned/Vector1D.java
@@ -326,9 +326,9 @@ public class Vector1D extends EuclideanVector<Vector1D> {
* corresponding scale factors.
* </p>
*
- * @param a scale factor for first coordinate
- * @param c first coordinate
- * @return vector with coordinates calculated by {@code a * c}
+ * @param a scale factor for first vector
+ * @param c first vector
+ * @return vector calculated by {@code a * c}
*/
public static Vector1D linearCombination(final double a, final Vector1D c) {
return new Vector1D(a * c.x);
@@ -340,11 +340,11 @@ public class Vector1D extends EuclideanVector<Vector1D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2)}
*/
public static Vector1D linearCombination(final double a1, final Vector1D v1,
final double a2, final Vector1D v2) {
@@ -359,13 +359,13 @@ public class Vector1D extends EuclideanVector<Vector1D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
*/
public static Vector1D linearCombination(final double a1, final Vector1D v1,
final double a2, final Vector1D v2,
@@ -381,15 +381,15 @@ public class Vector1D extends EuclideanVector<Vector1D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @param a4 scale factor for fourth coordinate
- * @param v4 fourth coordinate
- * @return point with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @param a4 scale factor for fourth vector
+ * @param v4 fourth vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
*/
public static Vector1D linearCombination(final double a1, final Vector1D v1,
final double a2, final Vector1D v2,
@@ -405,7 +405,6 @@ public class Vector1D extends EuclideanVector<Vector1D> {
* This allows optimizations to be performed for certain operations.
*/
public static final class Unit extends Vector1D {
-
/** Unit vector (coordinates: 1). */
public static final Unit PLUS = new Unit(1d);
/** Negation of unit vector (coordinates: -1). */
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
index a8b8d47..da6f7a6 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/threed/Vector3D.java
@@ -521,9 +521,9 @@ public class Vector3D extends MultiDimensionalEuclideanVector<Vector3D> {
* corresponding scale factors.
* </p>
*
- * @param a scale factor for first coordinate
- * @param c first coordinate
- * @return vector with coordinates calculated by {@code a * c}
+ * @param a scale factor for first vector
+ * @param c first vector
+ * @return vector calculated by {@code a * c}
*/
public static Vector3D linearCombination(final double a, final Vector3D c) {
return c.multiply(a);
@@ -535,11 +535,11 @@ public class Vector3D extends MultiDimensionalEuclideanVector<Vector3D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2)}
*/
public static Vector3D linearCombination(final double a1, final Vector3D v1,
final double a2, final Vector3D v2) {
@@ -555,13 +555,13 @@ public class Vector3D extends MultiDimensionalEuclideanVector<Vector3D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
*/
public static Vector3D linearCombination(final double a1, final Vector3D v1,
final double a2, final Vector3D v2,
@@ -578,15 +578,15 @@ public class Vector3D extends MultiDimensionalEuclideanVector<Vector3D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @param a4 scale factor for fourth coordinate
- * @param v4 fourth coordinate
- * @return point with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @param a4 scale factor for fourth vector
+ * @param v4 fourth vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
*/
public static Vector3D linearCombination(final double a1, final Vector3D v1,
final double a2, final Vector3D v2,
diff --git a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
index 15ab254..6e60fcf 100644
--- a/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
+++ b/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/Vector2D.java
@@ -464,9 +464,9 @@ public class Vector2D extends MultiDimensionalEuclideanVector<Vector2D> {
* corresponding scale factors.
* </p>
*
- * @param a scale factor for first coordinate
- * @param c first coordinate
- * @return vector with coordinates calculated by {@code a * c}
+ * @param a scale factor for first vector
+ * @param c first vector
+ * @return vector calculated by {@code a * c}
*/
public static Vector2D linearCombination(final double a, final Vector2D c) {
return new Vector2D(a * c.x, a * c.y);
@@ -478,11 +478,11 @@ public class Vector2D extends MultiDimensionalEuclideanVector<Vector2D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2)}
*/
public static Vector2D linearCombination(final double a1, final Vector2D v1,
final double a2, final Vector2D v2) {
@@ -497,13 +497,13 @@ public class Vector2D extends MultiDimensionalEuclideanVector<Vector2D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @return vector with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3)}
*/
public static Vector2D linearCombination(final double a1, final Vector2D v1,
final double a2, final Vector2D v2,
@@ -519,15 +519,15 @@ public class Vector2D extends MultiDimensionalEuclideanVector<Vector2D> {
* corresponding scale factors.
* </p>
*
- * @param a1 scale factor for first coordinate
- * @param v1 first coordinate
- * @param a2 scale factor for second coordinate
- * @param v2 second coordinate
- * @param a3 scale factor for third coordinate
- * @param v3 third coordinate
- * @param a4 scale factor for fourth coordinate
- * @param v4 fourth coordinate
- * @return point with coordinates calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
+ * @param a1 scale factor for first vector
+ * @param v1 first vector
+ * @param a2 scale factor for second vector
+ * @param v2 second vector
+ * @param a3 scale factor for third vector
+ * @param v3 third vector
+ * @param a4 scale factor for fourth vector
+ * @param v4 fourth vector
+ * @return vector calculated by {@code (a1 * v1) + (a2 * v2) + (a3 * v3) + (a4 * v4)}
*/
public static Vector2D linearCombination(final double a1, Vector2D v1,
final double a2, final Vector2D v2,