From 422242d4b39479020f47831f0516aa916ed69cc6 Mon Sep 17 00:00:00 2001 From: httpdigest Date: Tue, 25 Jul 2023 09:58:53 +0200 Subject: [PATCH] Refactor mentions of specific vector classes in JavaDocs --- src/main/java/org/joml/Vector2d.java | 16 ++++++++-------- src/main/java/org/joml/Vector2dc.java | 14 +++++++------- src/main/java/org/joml/Vector2f.java | 12 ++++++------ src/main/java/org/joml/Vector2fc.java | 14 +++++++------- src/main/java/org/joml/Vector3d.java | 20 ++++++++++---------- src/main/java/org/joml/Vector3dc.java | 12 ++++++------ src/main/java/org/joml/Vector3f.java | 18 +++++++++--------- src/main/java/org/joml/Vector3fc.java | 14 +++++++------- 8 files changed, 60 insertions(+), 60 deletions(-) diff --git a/src/main/java/org/joml/Vector2d.java b/src/main/java/org/joml/Vector2d.java index 251849d5..12edcef3 100644 --- a/src/main/java/org/joml/Vector2d.java +++ b/src/main/java/org/joml/Vector2d.java @@ -649,7 +649,7 @@ public Vector2d mul(double scalar, Vector2d dest) { } /** - * Multiply the components of this Vector2d by the given scalar values and store the result in this. + * Multiply the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to multiply this vector by @@ -668,7 +668,7 @@ public Vector2d mul(double x, double y, Vector2d dest) { } /** - * Multiply this Vector2d component-wise by another Vector2d. + * Multiply this vector component-wise by another vector. * * @param v * the vector to multiply by @@ -685,7 +685,7 @@ public Vector2d mul(Vector2dc v, Vector2d dest) { } /** - * Divide this Vector2d by the given scalar value. + * Divide this vector by the given scalar value. * * @param scalar * the scalar to divide this vector by @@ -703,7 +703,7 @@ public Vector2d div(double scalar, Vector2d dest) { } /** - * Divide the components of this Vector2d by the given scalar values and store the result in this. + * Divide the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to divide this vector by @@ -722,7 +722,7 @@ public Vector2d div(double x, double y, Vector2d dest) { } /** - * Divide this Vector2d component-wise by another Vector2dc. + * Divide this vector component-wise by another vector. * * @param v * the vector to divide by @@ -733,7 +733,7 @@ public Vector2d div(Vector2dc v) { } /** - * Divide this Vector3d component-wise by another Vector2fc. + * Divide this vector component-wise by another Vector2fc. * * @param v * the vector to divide by @@ -794,7 +794,7 @@ public Vector2d mul(Matrix2fc mat, Vector2d dest) { } /** - * Multiply the transpose of the given matrix with this Vector2d and store the result in this. + * Multiply the transpose of the given matrix with this vector and store the result in this. * * @param mat * the matrix @@ -813,7 +813,7 @@ public Vector2d mulTranspose(Matrix2dc mat, Vector2d dest) { } /** - * Multiply the transpose of the given matrix with this Vector2d and store the result in this. + * Multiply the transpose of the given matrix with this vector and store the result in this. * * @param mat * the matrix diff --git a/src/main/java/org/joml/Vector2dc.java b/src/main/java/org/joml/Vector2dc.java index b888ae70..a262d0f9 100644 --- a/src/main/java/org/joml/Vector2dc.java +++ b/src/main/java/org/joml/Vector2dc.java @@ -172,7 +172,7 @@ public interface Vector2dc { Vector2d mul(double scalar, Vector2d dest); /** - * Multiply the components of this Vector2d by the given scalar values and store the result in dest. + * Multiply the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to multiply this vector by @@ -185,7 +185,7 @@ public interface Vector2dc { Vector2d mul(double x, double y, Vector2d dest); /** - * Multiply this Vector2d component-wise by another Vector2d and store the result in dest. + * Multiply this vector component-wise by another vector and store the result in dest. * * @param v * the vector to multiply by @@ -196,7 +196,7 @@ public interface Vector2dc { Vector2d mul(Vector2dc v, Vector2d dest); /** - * Divide this Vector2d by the given scalar value and store the result in dest. + * Divide this vector by the given scalar value and store the result in dest. * * @param scalar * the scalar to divide this vector by @@ -207,7 +207,7 @@ public interface Vector2dc { Vector2d div(double scalar, Vector2d dest); /** - * Divide the components of this Vector3f by the given scalar values and store the result in dest. + * Divide the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to divide this vector by @@ -220,7 +220,7 @@ public interface Vector2dc { Vector2d div(double x, double y, Vector2d dest); /** - * Divide this Vector2d component-wise by another Vector2f and store the result in dest. + * Divide this vector component-wise by another vector and store the result in dest. * * @param v * the vector to divide by @@ -272,7 +272,7 @@ public interface Vector2dc { Vector2d mul(Matrix2fc mat, Vector2d dest); /** - * Multiply the transpose of the given matrix with this Vector2f and store the result in dest. + * Multiply the transpose of the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M^T * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -286,7 +286,7 @@ public interface Vector2dc { Vector2d mulTranspose(Matrix2dc mat, Vector2d dest); /** - * Multiply the transpose of the given matrix with this Vector2f and store the result in dest. + * Multiply the transpose of the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M^T * this, where M is the provided matrix * and thus interprets this as a column vector. diff --git a/src/main/java/org/joml/Vector2f.java b/src/main/java/org/joml/Vector2f.java index 63057c88..dd2c5d25 100644 --- a/src/main/java/org/joml/Vector2f.java +++ b/src/main/java/org/joml/Vector2f.java @@ -864,7 +864,7 @@ public Vector2f mul(float scalar, Vector2f dest) { } /** - * Multiply the components of this Vector2f by the given scalar values and store the result in this. + * Multiply the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to multiply this vector by @@ -883,7 +883,7 @@ public Vector2f mul(float x, float y, Vector2f dest) { } /** - * Multiply this Vector2f component-wise by another Vector2f. + * Multiply this vector component-wise by another Vector2f. * * @param v * the vector to multiply by @@ -900,7 +900,7 @@ public Vector2f mul(Vector2fc v, Vector2f dest) { } /** - * Divide this Vector2f component-wise by another Vector2fc. + * Divide this vector component-wise by another Vector2fc. * * @param v * the vector to divide by @@ -936,7 +936,7 @@ public Vector2f div(float scalar, Vector2f dest) { } /** - * Divide the components of this Vector2f by the given scalar values and store the result in this. + * Divide the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to divide this vector by @@ -955,7 +955,7 @@ public Vector2f div(float x, float y, Vector2f dest) { } /** - * Multiply the given matrix with this Vector2f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. * * @param mat * the matrix @@ -974,7 +974,7 @@ public Vector2f mul(Matrix2fc mat, Vector2f dest) { } /** - * Multiply the given matrix with this Vector2f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. * * @param mat * the matrix diff --git a/src/main/java/org/joml/Vector2fc.java b/src/main/java/org/joml/Vector2fc.java index 57c0d1d0..9f589b92 100644 --- a/src/main/java/org/joml/Vector2fc.java +++ b/src/main/java/org/joml/Vector2fc.java @@ -287,7 +287,7 @@ public interface Vector2fc { Vector2f mul(float scalar, Vector2f dest); /** - * Multiply the components of this Vector2f by the given scalar values and store the result in dest. + * Multiply the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to multiply this vector by @@ -300,7 +300,7 @@ public interface Vector2fc { Vector2f mul(float x, float y, Vector2f dest); /** - * Multiply this Vector2f component-wise by another Vector2f and store the result in dest. + * Multiply this vector component-wise by another vector and store the result in dest. * * @param v * the vector to multiply by @@ -323,7 +323,7 @@ public interface Vector2fc { Vector2f div(float scalar, Vector2f dest); /** - * Divide this Vector2f component-wise by another Vector2fc + * Divide this vector component-wise by another Vector2fc * and store the result in dest. * * @param v @@ -335,7 +335,7 @@ public interface Vector2fc { Vector2f div(Vector2fc v, Vector2f dest); /** - * Divide the components of this Vector2f by the given scalar values and store the result in dest. + * Divide the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to divide this vector by @@ -348,7 +348,7 @@ public interface Vector2fc { Vector2f div(float x, float y, Vector2f dest); /** - * Multiply the given matrix with this Vector2f and store the result in dest. + * Multiply the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -362,7 +362,7 @@ public interface Vector2fc { Vector2f mul(Matrix2fc mat, Vector2f dest); /** - * Multiply the given matrix with this Vector2f and store the result in dest. + * Multiply the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -376,7 +376,7 @@ public interface Vector2fc { Vector2f mul(Matrix2dc mat, Vector2f dest); /** - * Multiply the transpose of the given matrix with this Vector3f and store the result in dest. + * Multiply the transpose of the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M^T * this, where M is the provided matrix * and thus interprets this as a column vector. diff --git a/src/main/java/org/joml/Vector3d.java b/src/main/java/org/joml/Vector3d.java index 7f1a5a97..b223e7ec 100644 --- a/src/main/java/org/joml/Vector3d.java +++ b/src/main/java/org/joml/Vector3d.java @@ -925,7 +925,7 @@ public Vector3d mulAdd(Vector3fc a, Vector3dc b, Vector3d dest) { } /** - * Multiply this Vector3d component-wise by another Vector3dc. + * Multiply this vector component-wise by another Vector3dc. * * @param v * the vector to multiply by @@ -936,7 +936,7 @@ public Vector3d mul(Vector3dc v) { } /** - * Multiply this Vector3d component-wise by another Vector3fc. + * Multiply this vector component-wise by another Vector3fc. * * @param v * the vector to multiply by @@ -961,7 +961,7 @@ public Vector3d mul(Vector3dc v, Vector3d dest) { } /** - * Divide this Vector3d component-wise by another Vector3dc. + * Divide this vector component-wise by another Vector3dc. * * @param v * the vector to divide by @@ -972,7 +972,7 @@ public Vector3d div(Vector3dc v) { } /** - * Divide this Vector3d component-wise by another Vector3fc. + * Divide this vector component-wise by another Vector3fc. * * @param v * the vector to divide by @@ -1263,7 +1263,7 @@ public Vector3d mul(Matrix3fc mat, Vector3d dest) { } /** - * Multiply the given matrix with this Vector3d by assuming a third row in the matrix of (0, 0, 1) + * Multiply the given matrix with this vector by assuming a third row in the matrix of (0, 0, 1) * and store the result in this. * * @param mat @@ -1284,7 +1284,7 @@ public Vector3d mul(Matrix3x2dc mat, Vector3d dest) { } /** - * Multiply the given matrix with this Vector3d by assuming a third row in the matrix of (0, 0, 1) + * Multiply the given matrix with this vector by assuming a third row in the matrix of (0, 0, 1) * and store the result in this. * * @param mat @@ -1892,7 +1892,7 @@ public Vector3d mulTransposeDirection(Matrix4fc mat, Vector3d dest) { } /** - * Multiply this Vector3d by the given scalar value. + * Multiply this vector by the given scalar value. * * @param scalar * the scalar to multiply this vector by @@ -1910,7 +1910,7 @@ public Vector3d mul(double scalar, Vector3d dest) { } /** - * Multiply the components of this Vector3d by the given scalar values and store the result in this. + * Multiply the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to multiply this vector by @@ -2067,7 +2067,7 @@ public Vector3d rotateZ(double angle, Vector3d dest) { } /** - * Divide this Vector3d by the given scalar value. + * Divide this vector by the given scalar value. * * @param scalar * the scalar to divide this vector by @@ -2086,7 +2086,7 @@ public Vector3d div(double scalar, Vector3d dest) { } /** - * Divide the components of this Vector3d by the given scalar values and store the result in this. + * Divide the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to divide this vector by diff --git a/src/main/java/org/joml/Vector3dc.java b/src/main/java/org/joml/Vector3dc.java index 279ff94c..27afed27 100644 --- a/src/main/java/org/joml/Vector3dc.java +++ b/src/main/java/org/joml/Vector3dc.java @@ -390,7 +390,7 @@ public interface Vector3dc { Vector3d mulAdd(Vector3fc a, Vector3dc b, Vector3d dest); /** - * Multiply this Vector3d component-wise by another Vector3f and store the result in dest. + * Multiply this vector component-wise by another vector and store the result in dest. * * @param v * the vector to multiply by @@ -412,7 +412,7 @@ public interface Vector3dc { Vector3d mul(Vector3dc v, Vector3d dest); /** - * Divide this Vector3d component-wise by another Vector3f and store the result in dest. + * Divide this vector component-wise by another vector and store the result in dest. * * @param v * the vector to divide by @@ -1094,7 +1094,7 @@ public interface Vector3dc { Vector3d mulTransposeDirection(Matrix4fc mat, Vector3d dest); /** - * Multiply this Vector3d by the given scalar value and store the result in dest. + * Multiply this vector by the given scalar value and store the result in dest. * * @param scalar * the scalar factor @@ -1105,7 +1105,7 @@ public interface Vector3dc { Vector3d mul(double scalar, Vector3d dest); /** - * Multiply the components of this Vector3f by the given scalar values and store the result in dest. + * Multiply the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to multiply this vector by @@ -1227,7 +1227,7 @@ public interface Vector3dc { Vector3d rotateZ(double angle, Vector3d dest); /** - * Divide this Vector3d by the given scalar value and store the result in dest. + * Divide this vector by the given scalar value and store the result in dest. * * @param scalar * the scalar to divide this vector by @@ -1238,7 +1238,7 @@ public interface Vector3dc { Vector3d div(double scalar, Vector3d dest); /** - * Divide the components of this Vector3f by the given scalar values and store the result in dest. + * Divide the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to divide this vector by diff --git a/src/main/java/org/joml/Vector3f.java b/src/main/java/org/joml/Vector3f.java index fd610b2e..bceb9034 100644 --- a/src/main/java/org/joml/Vector3f.java +++ b/src/main/java/org/joml/Vector3f.java @@ -812,7 +812,7 @@ public Vector3f mulAdd(float a, Vector3fc b, Vector3f dest) { } /** - * Multiply this Vector3f component-wise by another Vector3fc. + * Multiply this vector component-wise by another Vector3fc. * * @param v * the vector to multiply by @@ -830,7 +830,7 @@ public Vector3f mul(Vector3fc v, Vector3f dest) { } /** - * Divide this Vector3f component-wise by another Vector3fc. + * Divide this vector component-wise by another Vector3fc. * * @param v * the vector to divide by @@ -1028,7 +1028,7 @@ public Vector3f mulProjectGeneric(Matrix4dc mat, Vector3f dest) { } /** - * Multiply the given matrix with this Vector3f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -1050,7 +1050,7 @@ public Vector3f mul(Matrix3fc mat, Vector3f dest) { } /** - * Multiply the given matrix with this Vector3f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -1072,7 +1072,7 @@ public Vector3f mul(Matrix3dc mat, Vector3f dest) { } /** - * Multiply the given matrix with this Vector3f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -1094,7 +1094,7 @@ public Vector3f mul(Matrix3x2fc mat, Vector3f dest) { } /** - * Multiply the given matrix with this Vector3f and store the result in this. + * Multiply the given matrix with this vector and store the result in this. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -1116,7 +1116,7 @@ public Vector3f mul(Matrix3x2dc mat, Vector3f dest) { } /** - * Multiply the transpose of the given matrix with this Vector3f store the result in this. + * Multiply the transpose of the given matrix with this vector store the result in this. *

* Note that this method performs the operation M^T * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -1710,7 +1710,7 @@ public Vector3f mul(float scalar, Vector3f dest) { } /** - * Multiply the components of this Vector3f by the given scalar values and store the result in this. + * Multiply the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to multiply this vector by @@ -1752,7 +1752,7 @@ public Vector3f div(float scalar, Vector3f dest) { } /** - * Divide the components of this Vector3f by the given scalar values and store the result in this. + * Divide the components of this vector by the given scalar values and store the result in this. * * @param x * the x component to divide this vector by diff --git a/src/main/java/org/joml/Vector3fc.java b/src/main/java/org/joml/Vector3fc.java index 646747b1..e5762760 100644 --- a/src/main/java/org/joml/Vector3fc.java +++ b/src/main/java/org/joml/Vector3fc.java @@ -243,7 +243,7 @@ public interface Vector3fc { Vector3f mulAdd(float a, Vector3fc b, Vector3f dest); /** - * Multiply this Vector3f component-wise by another Vector3f and store the result in dest. + * Multiply this vector component-wise by another vector and store the result in dest. * * @param v * the vector to multiply by @@ -254,7 +254,7 @@ public interface Vector3fc { Vector3f mul(Vector3fc v, Vector3f dest); /** - * Divide this Vector3f component-wise by another Vector3f and store the result in dest. + * Divide this vector component-wise by another vector and store the result in dest. * * @param v * the vector to divide by @@ -415,7 +415,7 @@ public interface Vector3fc { Vector3f mulProjectGeneric(Matrix4dc mat, Vector3f dest); /** - * Multiply the given matrix with this Vector3f and store the result in dest. + * Multiply the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -429,7 +429,7 @@ public interface Vector3fc { Vector3f mul(Matrix3fc mat, Vector3f dest); /** - * Multiply the given matrix with this Vector3f and store the result in dest. + * Multiply the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -473,7 +473,7 @@ public interface Vector3fc { Vector3f mul(Matrix3x2dc mat, Vector3f dest); /** - * Multiply the transpose of the given matrix with this Vector3f and store the result in dest. + * Multiply the transpose of the given matrix with this vector and store the result in dest. *

* Note that this method performs the operation M^T * this, where M is the provided matrix * and thus interprets this as a column vector. @@ -834,7 +834,7 @@ public interface Vector3fc { Vector3f mul(float scalar, Vector3f dest); /** - * Multiply the components of this Vector3f by the given scalar values and store the result in dest. + * Multiply the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to multiply this vector by @@ -861,7 +861,7 @@ public interface Vector3fc { Vector3f div(float scalar, Vector3f dest); /** - * Divide the components of this Vector3f by the given scalar values and store the result in dest. + * Divide the components of this vector by the given scalar values and store the result in dest. * * @param x * the x component to divide this vector by