From 5e5ae7aa3bee21ba15c517746b18cb6f8f494568 Mon Sep 17 00:00:00 2001 From: Oleg Ignatenko Date: Wed, 19 Apr 2017 11:53:33 +0300 Subject: [PATCH 1/2] IGNITE-5018 Javadocs in Ignite ML module. - verified with diffs overview and execution of code style inspections. --- .../org/apache/ignite/ml/math/Algebra.java | 18 +++++----- .../org/apache/ignite/ml/math/Constants.java | 35 ++++++++++++++----- .../org/apache/ignite/ml/math/Matrix.java | 8 ++--- .../org/apache/ignite/ml/math/MurmurHash.java | 31 ++++++++-------- .../apache/ignite/ml/math/ValueMapper.java | 6 ++-- .../decompositions/CholeskyDecomposition.java | 2 +- .../decompositions/EigenDecomposition.java | 17 ++++++--- .../math/decompositions/LUDecomposition.java | 12 +++++-- .../ignite/ml/math/functions/Functions.java | 7 ++-- .../functions/IntIntDoubleToVoidFunction.java | 7 +++- .../ml/math/impls/matrix/CacheMatrix.java | 19 +++++----- .../math/impls/matrix/PivotedMatrixView.java | 32 ++++++++++------- .../impls/matrix/SparseDistributedMatrix.java | 17 ++++----- .../storage/matrix/CacheMatrixStorage.java | 10 +++--- .../matrix/DenseOffHeapMatrixStorage.java | 11 ++++-- .../storage/vector/CacheVectorStorage.java | 8 ++--- .../storage/vector/DelegateVectorStorage.java | 15 ++++++-- .../storage/vector/MatrixVectorStorage.java | 18 +++++----- .../SparseLocalOffHeapVectorStorage.java | 5 ++- .../ml/math/impls/vector/AbstractVector.java | 15 ++++++-- .../ml/math/impls/vector/CacheVector.java | 10 +++--- .../ml/math/impls/vector/ConstantVector.java | 4 +-- .../math/impls/vector/DelegatingVector.java | 2 +- .../math/impls/vector/MatrixVectorView.java | 12 +++---- .../math/impls/vector/PivotedVectorView.java | 20 +++++++---- .../ml/math/impls/vector/RandomVector.java | 10 +++--- .../impls/vector/SingleElementVector.java | 8 ++--- .../impls/vector/SingleElementVectorView.java | 4 +-- .../math/impls/vector/SparseLocalVector.java | 4 +-- .../ml/math/impls/matrix/CacheMatrixTest.java | 4 +-- .../math/impls/vector/AbstractVectorTest.java | 6 ++-- 31 files changed, 231 insertions(+), 146 deletions(-) diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/Algebra.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/Algebra.java index a31503f44a7c5..b13d9fc32ccfd 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/Algebra.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/Algebra.java @@ -250,8 +250,8 @@ public class Algebra extends Constants { *
  • else: {@code (n * n-1 * ... * n-k+1 ) / ( 1 * 2 * ... * k)}.
    • * * - * @param n - * @param k + * @param n Size of set. + * @param k Size of subset. * @return Binomial coefficient. */ public static double binomial(double n, long k) { @@ -281,8 +281,8 @@ public static double binomial(double n, long k) { * * - * @param n - * @param k + * @param n Size of set. + * @param k Size of subset. * @return Binomial coefficient. */ public static double binomial(long n, long k) { @@ -328,7 +328,8 @@ public static double binomial(long n, long k) { *
    Examples: {@code 1.0 -> 1, 1.2 -> 2, 1.9 -> 2}. This * method is safer than using (long) Math.ceil(value), because of possible rounding error.
    * - * @param val + * @param val Value for ceil. + * @return Ceil of the given value. */ public static long ceil(double val) { return Math.round(Math.ceil(val)); @@ -428,7 +429,7 @@ public static double log2(double val) { /** * Returns {@code log(k!)}. Tries to avoid overflows. For {@code k<30} simply looks up a table in O(1). - * For {@code k>=30} uses stirlings approximation. + * For {@code k>=30} uses Stirling's approximation. * * @param k must hold {@code k >= 0}. */ @@ -549,8 +550,9 @@ public static double evalPoly(double x, double[] coef, int n) { /** * Gets sqrt(a^2 + b^2) without under/overflow. * - * @param a - * @param b + * @param a First side value. + * @param b Second side value. + * @return Hypotenuse value. */ public static double hypot(double a, double b) { double r; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/Constants.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/Constants.java index e20c139b2bbe1..f9b6c8854f7ef 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/Constants.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/Constants.java @@ -30,13 +30,30 @@ * Math constants. Lifted from Apache Mahout. */ public class Constants { - /** */ public static final double MACHEP = 1.11022302462515654042E-16; - /** */ public static final double MAXLOG = 7.09782712893383996732E2; - /** */ public static final double MINLOG = -7.451332191019412076235E2; - /** */ public static final double MAXGAM = 171.624376956302725; - /** */ public static final double SQTPI = 2.50662827463100050242E0; - /** */ public static final double SQRTH = 7.07106781186547524401E-1; - /** */ public static final double LOGPI = 1.14472988584940017414; - /** */ public static final double BIG = 4.503599627370496e15; - /** */ public static final double BIGINV = 2.22044604925031308085e-16; + /** Constant for {@code 2**-53}. */ + public static final double MACHEP = 1.11022302462515654042E-16; + + /** Constant for {@code log(2**1024)}. */ + public static final double MAXLOG = 7.09782712893383996732E2; + + /** Constant for {@code log(2**-1022)}. */ + public static final double MINLOG = -7.451332191019412076235E2; + + /** Constant for gamma function. */ + public static final double MAXGAM = 171.624376956302725; + + /** Constant for {@code 1/(sqrt(2*pi))}. */ + public static final double SQTPI = 2.50662827463100050242E0; + + /** Constant for {@code sqrt(2)/2}. */ + public static final double SQRTH = 7.07106781186547524401E-1; + + /** Constant for {@code log(Pi)}. */ + public static final double LOGPI = 1.14472988584940017414; + + /** Constant for big value. */ + public static final double BIG = 4.503599627370496e15; + + /** Constant for inverse of big value. */ + public static final double BIGINV = 2.22044604925031308085e-16; } diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/Matrix.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/Matrix.java index 10394849407ec..cc858b72a691b 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/Matrix.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/Matrix.java @@ -474,10 +474,10 @@ interface Element { /** * Creates new view into this matrix. Changes to the view will be propagated to this matrix. * - * @param rowOff - * @param rows - * @param colOff - * @param cols + * @param rowOff View offset in rows. + * @param rows Amount of rows in the view. + * @param colOff View offset in columns. + * @param cols Amount of columns in the view. * @return New view. * @throws CardinalityException Thrown if cardinalities mismatch. * @throws IndexException Thrown in case of offset is out of bound. diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/MurmurHash.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/MurmurHash.java index 0cbcbdfb6b613..c7dd36ba099ca 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/MurmurHash.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/MurmurHash.java @@ -41,10 +41,10 @@ private MurmurHash() { * * See also http://github.com/yonik/java_util for future updates to this method. * - * @param data - * @param off - * @param len - * @param seed + * @param data Data to hash. + * @param off Where to start munging. + * @param len How many bytes to process. + * @param seed The seed to start with. * @return 32 bit hash platform compatible with C++ MurmurHash3 implementation on x86. */ public static int hash3X86(byte[] data, int off, int len, int seed) { @@ -101,7 +101,7 @@ public static int hash3X86(byte[] data, int off, int len, int seed) { * Hashes an int. * * @param data The int to hash. - * @param seed The seed for the hash. + * @param seed The seed to start with. * @return The 32 bit hash of the bytes in question. */ public static int hash(int data, int seed) { @@ -119,7 +119,7 @@ public static int hash(int data, int seed) { * Hashes bytes in an array. * * @param data The bytes to hash. - * @param seed The seed for the hash. + * @param seed The seed to start with. * @return The 32 bit hash of the bytes in question. */ public static int hash(byte[] data, int seed) { @@ -143,7 +143,7 @@ public static int hash(byte[] data, int off, int len, int seed) { * Hashes the bytes in a buffer from the current position to the limit. * * @param buf The bytes to hash. - * @param seed The seed for the hash. + * @param seed The seed to start with. * @return The 32 bit murmur hash of the bytes in the buffer. */ public static int hash(ByteBuffer buf, int seed) { @@ -185,26 +185,27 @@ public static int hash(ByteBuffer buf, int seed) { } /** - * @param data - * @param seed + * @param data The data to hash. + * @param seed The seed to start with. + * @return Hash value for given data and seed. */ public static long hash64A(byte[] data, int seed) { return hash64A(ByteBuffer.wrap(data), seed); } /** - * @param data - * @param off - * @param len - * @param seed + * @param data The data to hash. + * @param off Where to start munging. + * @param len How many bytes to process. + * @param seed The seed to start with. */ public static long hash64A(byte[] data, int off, int len, int seed) { return hash64A(ByteBuffer.wrap(data, off, len), seed); } /** - * @param buf - * @param seed + * @param buf The data to hash. + * @param seed The seed to start with. */ public static long hash64A(ByteBuffer buf, int seed) { ByteOrder byteOrder = buf.order(); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/ValueMapper.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/ValueMapper.java index 2b62c0b865efb..f0776a3c23a90 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/ValueMapper.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/ValueMapper.java @@ -24,12 +24,14 @@ */ public interface ValueMapper extends Serializable { /** - * @param v + * @param v Value to map from double. + * @return Mapped value. */ public V fromDouble(double v); /** - * @param v + * @param v Value to map to double. + * @return Mapped value. */ public double toDouble(V v); } diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/CholeskyDecomposition.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/CholeskyDecomposition.java index bc1830773fd9e..59ebbe00cc7f9 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/CholeskyDecomposition.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/CholeskyDecomposition.java @@ -138,7 +138,7 @@ public CholeskyDecomposition(final Matrix mtx, final double relSymmetryThreshold } } - /** */ + /** {@inheritDoc} */ @Override public void destroy() { if (cachedL != null) cachedL.destroy(); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java index 01af9892b9f9b..4ce9dd84bb3f2 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java @@ -39,12 +39,19 @@ public class EigenDecomposition extends DecompositionSupport { /** Array for internal storage of eigenvalues. */ private final Vector e; - /** */ + /** + * + * @param matrix Matrix to decompose. + */ public EigenDecomposition(Matrix matrix) { this(matrix, isSymmetric(matrix)); } - /** */ + /** + * + * @param matrix Matrix to decompose. + * @param isSymmetric {@code true} if matrix passes symmetry check, {@code false otherwise}. + */ public EigenDecomposition(Matrix matrix, boolean isSymmetric) { n = matrix.columnSize(); @@ -69,7 +76,7 @@ public EigenDecomposition(Matrix matrix, boolean isSymmetric) { } /** - * Return the eigen vector matrix + * Return the eigen vector matrix. * * @return V */ @@ -85,7 +92,9 @@ public Vector getRealEigenValues() { } /** - * Return the imaginary parts of the eigenvalues + * Return the imaginary parts of the eigenvalues. + * + * @return Vector of imaginary parts. */ public Vector getImagEigenvalues() { return e; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java index b1efc099d90cb..ab97525c34e00 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java @@ -274,7 +274,11 @@ public double determinant() { return determinant; } - /** */ + /** + * + * @param b Vector to solve using this decomposition. + * @return Solution vector. + */ public Vector solve(Vector b) { final int m = pivot.size(); @@ -310,7 +314,11 @@ public Vector solve(Vector b) { return b.like(m).assign(bp); } - /** */ + /** + * + * @param b Matrix to solve using this decomposition. + * @return Solution matrix. + */ public Matrix solve(Matrix b) { final int m = pivot.size(); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/Functions.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/Functions.java index cd48daad0cf47..2693fcece5fdd 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/Functions.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/Functions.java @@ -86,7 +86,7 @@ public final class Functions { /** * Function that returns {@code a + b}. {@code a} is a variable, {@code b} is fixed. * - * @param b + * @param b Value to add. */ public static IgniteDoubleFunction plus(final double b) { return (a) -> a + b; @@ -95,7 +95,7 @@ public static IgniteDoubleFunction plus(final double b) { /** * Function that returns {@code a * b}. {@code a} is a variable, {@code b} is fixed. * - * @param b + * @param b Value to multiply to. */ public static IgniteDoubleFunction mult(final double b) { return (a) -> a * b; @@ -123,7 +123,8 @@ public static IgniteBiFunction minusMult(double constant } /** - * @param b + * @param b Power value. + * @return Function for given power. */ public static IgniteDoubleFunction pow(final double b) { return (a) -> { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java index a9b3f9c566f01..3cfa2d07db206 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java @@ -23,6 +23,11 @@ * Setter function for matrices. */ public interface IntIntDoubleToVoidFunction extends Serializable { - /** */ + /** + * + * @param x Row index in the matrix. + * @param y Column index in the matrix. + * @param v Value to set at given row and column. + */ public void apply(int x, int y, double v); } diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrix.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrix.java index 73a34935c91be..a7f0afcfc3afa 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrix.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrix.java @@ -42,11 +42,11 @@ public CacheMatrix() { /** * Creates new matrix over existing cache. * - * @param rows - * @param cols - * @param cache - * @param keyMapper - * @param valMapper + * @param rows Amount of rows in matrix. + * @param cols Amount of columns in matrix. + * @param cache Ignite cache. + * @param keyMapper {@link MatrixKeyMapper} to validate cache key. + * @param valMapper {@link ValueMapper} to obtain value for given cache key. */ public CacheMatrix( int rows, @@ -90,7 +90,7 @@ private CacheMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param d + * @param d Value to divide to. */ @Override public Matrix divide(double d) { return mapOverValues((Double v) -> v / d); @@ -99,7 +99,7 @@ private CacheMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param x + * @param x Value to add. */ @Override public Matrix plus(double x) { return mapOverValues((Double v) -> v + x); @@ -108,7 +108,7 @@ private CacheMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param x + * @param x Value to multiply to. */ @Override public Matrix times(double x) { return mapOverValues((Double v) -> v * x); @@ -146,7 +146,8 @@ private CacheMatrixStorage storage() { } /** - * @param mapper + * @param mapper Mapping function. + * @return Matrix with mapped values. */ private Matrix mapOverValues(IgniteFunction mapper) { CacheMatrixStorage sto = storage(); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java index b9a3b1732a0fb..1a882f64cadbd 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java @@ -43,9 +43,9 @@ public PivotedMatrixView() { } /** - * @param mtx - * @param rowPivot - * @param colPivot + * @param mtx Parent matrix. + * @param rowPivot Pivot array for rows. + * @param colPivot Pivot array for columns. */ public PivotedMatrixView(Matrix mtx, int[] rowPivot, int[] colPivot) { super(new PivotedMatrixStorage(mtx == null ? null : mtx.getStorage(), rowPivot, colPivot)); @@ -54,7 +54,7 @@ public PivotedMatrixView(Matrix mtx, int[] rowPivot, int[] colPivot) { } /** - * @param mtx + * @param mtx Parent matrix. */ public PivotedMatrixView(Matrix mtx) { super(new PivotedMatrixStorage(mtx == null ? null : mtx.getStorage())); @@ -63,8 +63,8 @@ public PivotedMatrixView(Matrix mtx) { } /** - * @param mtx - * @param pivot + * @param mtx Parent matrix. + * @param pivot Pivot array for rows and columns. */ public PivotedMatrixView(Matrix mtx, int[] pivot) { super(new PivotedMatrixStorage(mtx == null ? null : mtx.getStorage(), pivot)); @@ -129,7 +129,7 @@ public Matrix swap(int i, int j) { /** * - * + * @return Parent matrix. */ public Matrix getBaseMatrix() { return mtx; @@ -137,7 +137,7 @@ public Matrix getBaseMatrix() { /** * - * + * @return Pivot array for rows. */ public int[] rowPivot() { return storage().rowPivot(); @@ -145,35 +145,41 @@ public int[] rowPivot() { /** * - * + * @return Pivot array for columns. */ public int[] columnPivot() { return storage().columnPivot(); } /** - * @param i + * + * @param i Index for row pivot. + * @return Row pivot for given index. */ public int rowPivot(int i) { return storage().rowPivot()[i]; } /** - * @param i + * + * @param i Index for column pivot. + * @return Column pivot for given index. */ public int columnPivot(int i) { return storage().columnPivot()[i]; } /** - * @param i + * @param i Index for row unpivot. + * @return Row unpivot for given index. */ public int rowUnpivot(int i) { return storage().rowUnpivot()[i]; } /** - * @param i + * @param i Index for column unpivot. + * @return Column unpivot for given index. */ public int columnUnpivot(int i) { return storage().columnUnpivot()[i]; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/SparseDistributedMatrix.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/SparseDistributedMatrix.java index 8a7cffef4be6c..cd75b8351abf4 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/SparseDistributedMatrix.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/SparseDistributedMatrix.java @@ -55,10 +55,10 @@ public SparseDistributedMatrix() { } /** - * @param rows - * @param cols - * @param stoMode - * @param acsMode + * @param rows Amount of rows in the matrix. + * @param cols Amount of columns in the matrix. + * @param stoMode Matrix storage mode. + * @param acsMode Matrix elements access mode. */ public SparseDistributedMatrix(int rows, int cols, int stoMode, int acsMode) { assert rows > 0; @@ -80,7 +80,7 @@ private SparseDistributedMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param d + * @param d Value to divide to. */ @Override public Matrix divide(double d) { return mapOverValues((Double v) -> v / d); @@ -89,7 +89,7 @@ private SparseDistributedMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param x + * @param x Value to add. */ @Override public Matrix plus(double x) { return mapOverValues((Double v) -> v + x); @@ -98,7 +98,7 @@ private SparseDistributedMatrixStorage storage() { /** * Return the same matrix with updates values (broken contract). * - * @param x + * @param x Value to multiply. */ @Override public Matrix times(double x) { return mapOverValues((Double v) -> v * x); @@ -115,7 +115,8 @@ private SparseDistributedMatrixStorage storage() { } /** - * @param mapper + * @param mapper Mapping function. + * @return Matrix with mapped values. */ private Matrix mapOverValues(IgniteFunction mapper) { CacheUtils.sparseMap(storage().cache().getName(), mapper); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/CacheMatrixStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/CacheMatrixStorage.java index 510c4cf2b16f0..1eec6f50fbd4d 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/CacheMatrixStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/CacheMatrixStorage.java @@ -44,11 +44,11 @@ public CacheMatrixStorage() { } /** - * @param rows - * @param cols - * @param cache - * @param keyMapper - * @param valMapper + * @param rows Amount of rows in matrix. + * @param cols Amount of columns in matrix. + * @param cache Ignite cache. + * @param keyMapper {@link MatrixKeyMapper} to validate cache key. + * @param valMapper {@link ValueMapper} to obtain value for given cache key. */ public CacheMatrixStorage(int rows, int cols, IgniteCache cache, MatrixKeyMapper keyMapper, ValueMapper valMapper) { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java index 74952a9c184c9..1630c295ca791 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java @@ -38,7 +38,11 @@ public DenseOffHeapMatrixStorage() { // No-op. } - /** */ + /** + * + * @param rows Amount of rows in the matrix. + * @param cols Amount of columns in the matrix. + */ public DenseOffHeapMatrixStorage(int rows, int cols) { assert rows > 0; assert cols > 0; @@ -49,7 +53,10 @@ public DenseOffHeapMatrixStorage(int rows, int cols) { allocateMemory(rows, cols); } - /** */ + /** + * + * @param data Backing data array. + */ public DenseOffHeapMatrixStorage(double[][] data) { assert data != null; assert data[0] != null; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/CacheVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/CacheVectorStorage.java index 7aa317cedc8b3..f99a216151d21 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/CacheVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/CacheVectorStorage.java @@ -47,10 +47,10 @@ public CacheVectorStorage() { } /** - * @param size - * @param cache - * @param keyMapper - * @param valMapper + * @param size Vector size. + * @param cache Ignite cache. + * @param keyMapper {@link VectorKeyMapper} to validate cache key. + * @param valMapper {@link ValueMapper} to obtain value for given cache key. */ public CacheVectorStorage(int size, IgniteCache cache, VectorKeyMapper keyMapper, ValueMapper valMapper) { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java index c431bdbe0052a..50cc0ef90ccd4 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java @@ -57,17 +57,26 @@ public DelegateVectorStorage(VectorStorage sto, int off, int len) { this.len = len; } - /** */ + /** + * + * @return Backing vector storage. + */ public VectorStorage delegate() { return sto; } - /** */ + /** + * + * @return Offset into the backing vector. + */ public int offset() { return off; } - /** */ + /** + * + * @return Vector length. + */ public int length() { return len; } diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java index a7d7e26c94f9f..28469dfa8a7fb 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java @@ -46,11 +46,11 @@ public MatrixVectorStorage() { } /** - * @param parent - * @param row - * @param col - * @param rowStride - * @param colStride + * @param parent Parent matrix. + * @param row Starting row in the view. + * @param col Starting column in the view. + * @param rowStride Rows stride in the view. + * @param colStride Columns stride in the view. */ public MatrixVectorStorage(Matrix parent, int row, int col, int rowStride, int colStride) { assert parent != null; @@ -76,7 +76,7 @@ public MatrixVectorStorage(Matrix parent, int row, int col, int rowStride, int c /** * - * + * @return Starting row in the view. */ int row() { return row; @@ -84,7 +84,7 @@ int row() { /** * - * + * @return Starting column in the view. */ int column() { return col; @@ -92,7 +92,7 @@ int column() { /** * - * + * @return Rows stride in the view. */ int rowStride() { return rowStride; @@ -100,7 +100,7 @@ int rowStride() { /** * - * + * @return Columns stride in the view. */ int columnStride() { return colStride; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java index 7b3da78e95514..a1890c85e4bad 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java @@ -43,7 +43,10 @@ public SparseLocalOffHeapVectorStorage() { //No-op. } - /** */ + /** + * + * @param cap Initial capacity. + */ public SparseLocalOffHeapVectorStorage(int cap) { assert cap > 0; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java index 3c075f49b8432..c2dc9b3276050 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java @@ -707,19 +707,28 @@ private boolean idxNextInitialized() { return foldMap(vec, Functions.PLUS, Functions.MINUS_SQUARED, 0d); } - /** */ + /** + * + * @param vec Vector to check for valid cardinality. + */ protected void checkCardinality(Vector vec) { if (vec.size() != size()) throw new CardinalityException(size(), vec.size()); } - /** */ + /** + * + * @param vec Array to check for valid cardinality. + */ protected void checkCardinality(double[] vec) { if (vec.length != size()) throw new CardinalityException(size(), vec.length); } - /** */ + /** + * + * @param arr Array to check for valid cardinality. + */ protected void checkCardinality(int[] arr) { if (arr.length != size()) throw new CardinalityException(size(), arr.length); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/CacheVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/CacheVector.java index 7e2379166a26e..f78113ccfbad4 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/CacheVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/CacheVector.java @@ -43,10 +43,10 @@ public CacheVector() { /** * Creates new vector over existing cache. * - * @param size - * @param cache - * @param keyFunc - * @param valMapper + * @param size Vector size. + * @param cache Ignite cache. + * @param keyFunc {@link VectorKeyMapper} to validate cache key. + * @param valMapper {@link ValueMapper} to obtain value for given cache key. */ public CacheVector( int size, @@ -57,7 +57,7 @@ public CacheVector( } /** - * @param mapper + * @param mapper Mapping function. */ private Vector mapOverCache(IgniteFunction mapper) { CacheVectorStorage sto = storage(); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/ConstantVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/ConstantVector.java index 71c9c3e9758eb..5038f1334844d 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/ConstantVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/ConstantVector.java @@ -35,8 +35,8 @@ public ConstantVector() { } /** - * @param size - * @param val + * @param size Vector size. + * @param val Value of the constant. */ public ConstantVector(int size, double val) { super(new ConstantVectorStorage(size, val)); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/DelegatingVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/DelegatingVector.java index 891eb8e84ceb8..c8681609923dc 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/DelegatingVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/DelegatingVector.java @@ -51,7 +51,7 @@ public DelegatingVector() { } /** - * @param dlg + * @param dlg Parent vector. */ public DelegatingVector(Vector dlg) { assert dlg != null; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/MatrixVectorView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/MatrixVectorView.java index 723c585b9c863..1eda7d8ffd61a 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/MatrixVectorView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/MatrixVectorView.java @@ -33,7 +33,7 @@ public class MatrixVectorView extends AbstractVector { /** */ private int row; /** */ private int col; - + /** */ private int rowStride; /** */ private int colStride; @@ -45,11 +45,11 @@ public MatrixVectorView() { } /** - * @param parent - * @param row - * @param col - * @param rowStride - * @param colStride + * @param parent Parent matrix. + * @param row Starting row in the view. + * @param col Starting column in the view. + * @param rowStride Rows stride in the view. + * @param colStride Columns stride in the view. */ public MatrixVectorView(Matrix parent, int row, int col, int rowStride, int colStride) { assert parent != null; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java index 607bb72ca2120..ce485cd5ff378 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java @@ -33,7 +33,7 @@ public class PivotedVectorView extends AbstractVector { /** */ private Vector vec; /** - * @param vec + * @param vec Parent vector. * @param pivot Mapping from external index to internal. * @param unpivot Mapping from internal index to external. */ @@ -47,8 +47,8 @@ public PivotedVectorView(Vector vec, int[] pivot, int[] unpivot) { } /** - * @param vec - * @param pivot + * @param vec Parent vector. + * @param pivot Mapping from external index to internal. */ public PivotedVectorView(Vector vec, int[] pivot) { setStorage(new PivotedVectorStorage(vec.getStorage(), pivot)); @@ -75,28 +75,34 @@ public PivotedVectorView() { /** * - * + * @return Parent vector. */ public Vector getBaseVector() { return vec; } /** - * @param i + * + * @param i Index to pivot. + * @return Mapping from external index to internal for given index. */ public int pivot(int i) { return storage().pivot()[i]; } /** - * @param i + * + * @param i Index to unpivot. + * @return Mapping from internal index to external for given index. */ public int unpivot(int i) { return storage().unpivot()[i]; } /** - * @param idx + * + * @param idx Index of vector element. + * @return Vector element at given index. */ protected Vector.Element makeElement(int idx) { checkIndex(idx); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/RandomVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/RandomVector.java index 08292eb060755..d216a90f91330 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/RandomVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/RandomVector.java @@ -37,7 +37,7 @@ public class RandomVector extends AbstractReadOnlyVector { /** * @param size Vector cardinality. - * @param fastHash + * @param fastHash Whether or not to use fast hashing or Murmur hashing. */ private VectorStorage mkStorage(int size, boolean fastHash) { this.fastHash = fastHash; @@ -46,22 +46,22 @@ private VectorStorage mkStorage(int size, boolean fastHash) { } /** - * @param size - * @param fastHash + * @param size Vector cardinality. + * @param fastHash Whether or not to use fast hashing or Murmur hashing. */ public RandomVector(int size, boolean fastHash) { setStorage(mkStorage(size, fastHash)); } /** - * @param size + * @param size Vector cardinality. */ public RandomVector(int size) { this(size, true); } /** - * @param args + * @param args Parameters to create new vector instance. */ public RandomVector(Map args) { assert args != null; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVector.java index cae5ca38482c8..b47dad8573a3d 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVector.java @@ -35,16 +35,16 @@ public SingleElementVector() { } /** - * @param size - * @param idx - * @param val + * @param size Parent vector size. + * @param idx Index of the parent vector element. + * @param val Value of the vector element. */ public SingleElementVector(int size, int idx, double val) { super(new SingleElementVectorStorage(size, idx, val)); } /** - * @param args + * @param args Parameters to create new vector instance. */ public SingleElementVector(Map args) { assert args != null; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVectorView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVectorView.java index 0fb41059eee80..c2c648b8008e9 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVectorView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SingleElementVectorView.java @@ -35,8 +35,8 @@ public SingleElementVectorView() { } /** - * @param vec - * @param idx + * @param vec Parent vector. + * @param idx Index of the parent vector element. */ public SingleElementVectorView(Vector vec, int idx) { super(new SingleElementVectorDelegateStorage(vec, idx)); diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SparseLocalVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SparseLocalVector.java index d60eea80c8d8b..e188f70f594d9 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SparseLocalVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/SparseLocalVector.java @@ -35,8 +35,8 @@ public SparseLocalVector() { } /** - * @param size - * @param acsMode + * @param size Vector size. + * @param acsMode Vector elements access mode. */ public SparseLocalVector(int size, int acsMode) { assertAccessMode(acsMode); diff --git a/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrixTest.java b/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrixTest.java index 3d4d05e088fdb..52badbcac4cb8 100644 --- a/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrixTest.java +++ b/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/matrix/CacheMatrixTest.java @@ -210,13 +210,11 @@ public void testTimes() { public void testSum() { IgniteUtils.setCurrentIgniteName(ignite.configuration().getIgniteInstanceName()); - double initVal = 1; - MatrixKeyMapper keyMapper = getKeyMapper(rows, cols); IgniteCache cache = getCache(); CacheMatrix cacheMatrix = new CacheMatrix<>(rows, cols, cache, keyMapper, new IdentityValueMapper()); - double sum = 0; + double sum; initMatrix(cacheMatrix); sum = cacheMatrix.sum(); diff --git a/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/vector/AbstractVectorTest.java b/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/vector/AbstractVectorTest.java index fa667694c982f..7d127734476fa 100644 --- a/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/vector/AbstractVectorTest.java +++ b/modules/ml/src/test/java/org/apache/ignite/ml/math/impls/vector/AbstractVectorTest.java @@ -262,12 +262,12 @@ public void foldMapWithSecondVector() { AbstractVector testVector1 = getAbstractVector(storage1); - String testVal = ""; + StringBuilder testVal = new StringBuilder(); for (int i = 0; i < data0.length; i++) - testVal += data0[i] + data1[i]; + testVal.append(data0[i] + data1[i]); - assertEquals(MathTestConstants.VAL_NOT_EQUALS, testVector.foldMap(testVector1, (string, xi) -> string.concat(xi.toString()), Functions.PLUS, ""), testVal); + assertEquals(MathTestConstants.VAL_NOT_EQUALS, testVector.foldMap(testVector1, (string, xi) -> string.concat(xi.toString()), Functions.PLUS, ""), testVal.toString()); } /** */ From da01a6534b84f009a6e3aae7f99fb18e63281a4c Mon Sep 17 00:00:00 2001 From: Oleg Ignatenko Date: Wed, 19 Apr 2017 15:49:51 +0300 Subject: [PATCH 2/2] IGNITE-5018 Javadocs in Ignite ML module. - javadoc formatting cleanup per pull request review comments - verified with diffs overview and execution of code style inspections. --- .../ml/math/decompositions/EigenDecomposition.java | 10 +++++----- .../ignite/ml/math/decompositions/LUDecomposition.java | 8 +++----- .../ml/math/functions/IntIntDoubleToVoidFunction.java | 1 - .../ignite/ml/math/impls/matrix/PivotedMatrixView.java | 10 +--------- .../storage/matrix/DenseOffHeapMatrixStorage.java | 2 -- .../impls/storage/vector/DelegateVectorStorage.java | 3 --- .../math/impls/storage/vector/MatrixVectorStorage.java | 9 +-------- .../vector/SparseLocalOffHeapVectorStorage.java | 1 - .../ignite/ml/math/impls/vector/AbstractVector.java | 7 +------ .../ignite/ml/math/impls/vector/PivotedVectorView.java | 9 +-------- 10 files changed, 12 insertions(+), 48 deletions(-) diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java index 4ce9dd84bb3f2..0353bff3ea319 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/EigenDecomposition.java @@ -24,8 +24,8 @@ /** * This class provides EigenDecomposition of given matrix. The class is based on * class with similar name from Apache Mahout library. - * - * @see MathWorld + *

    + * @see MathWorld

    */ public class EigenDecomposition extends DecompositionSupport { /** Row and column dimension (square matrix). */ @@ -40,7 +40,6 @@ public class EigenDecomposition extends DecompositionSupport { private final Vector e; /** - * * @param matrix Matrix to decompose. */ public EigenDecomposition(Matrix matrix) { @@ -48,7 +47,6 @@ public EigenDecomposition(Matrix matrix) { } /** - * * @param matrix Matrix to decompose. * @param isSymmetric {@code true} if matrix passes symmetry check, {@code false otherwise}. */ @@ -294,7 +292,9 @@ private Matrix orthes(Matrix matrix) { return hessenBerg; } - /** Symmetric tridiagonal QL algorithm. */ + /** + * Symmetric tridiagonal QL algorithm. + */ private void tql2() { // This is derived from the Algol procedures tql2, by // Bowdler, Martin, Reinsch, and Wilkinson, Handbook for diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java index ab97525c34e00..4e9730c6b3abc 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/decompositions/LUDecomposition.java @@ -24,9 +24,9 @@ /** * Calculates the LU-decomposition of a square matrix. - * - * This class inspired by class from Apache Common Math with similar name. - * + *

    + * This class is inspired by class from Apache Common Math with similar name. + *

    * @see MathWorld * @see Wikipedia */ @@ -275,7 +275,6 @@ public double determinant() { } /** - * * @param b Vector to solve using this decomposition. * @return Solution vector. */ @@ -315,7 +314,6 @@ public Vector solve(Vector b) { } /** - * * @param b Matrix to solve using this decomposition. * @return Solution matrix. */ diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java index 3cfa2d07db206..7487a54cc5695 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/functions/IntIntDoubleToVoidFunction.java @@ -24,7 +24,6 @@ */ public interface IntIntDoubleToVoidFunction extends Serializable { /** - * * @param x Row index in the matrix. * @param y Column index in the matrix. * @param v Value to set at given row and column. diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java index 1a882f64cadbd..334291e4899ec 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/matrix/PivotedMatrixView.java @@ -128,7 +128,6 @@ public Matrix swap(int i, int j) { } /** - * * @return Parent matrix. */ public Matrix getBaseMatrix() { @@ -136,7 +135,6 @@ public Matrix getBaseMatrix() { } /** - * * @return Pivot array for rows. */ public int[] rowPivot() { @@ -144,7 +142,6 @@ public int[] rowPivot() { } /** - * * @return Pivot array for columns. */ public int[] columnPivot() { @@ -152,7 +149,6 @@ public int[] columnPivot() { } /** - * * @param i Index for row pivot. * @return Row pivot for given index. */ @@ -161,7 +157,6 @@ public int rowPivot(int i) { } /** - * * @param i Index for column pivot. * @return Column pivot for given index. */ @@ -199,10 +194,7 @@ public int columnUnpivot(int i) { mtx = (Matrix)in.readObject(); } - /** - * - * - */ + /** */ private PivotedMatrixStorage storage() { return (PivotedMatrixStorage)getStorage(); } diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java index 1630c295ca791..c9e8de8be3918 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/matrix/DenseOffHeapMatrixStorage.java @@ -39,7 +39,6 @@ public DenseOffHeapMatrixStorage() { } /** - * * @param rows Amount of rows in the matrix. * @param cols Amount of columns in the matrix. */ @@ -54,7 +53,6 @@ public DenseOffHeapMatrixStorage(int rows, int cols) { } /** - * * @param data Backing data array. */ public DenseOffHeapMatrixStorage(double[][] data) { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java index 50cc0ef90ccd4..6775d44759263 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/DelegateVectorStorage.java @@ -58,7 +58,6 @@ public DelegateVectorStorage(VectorStorage sto, int off, int len) { } /** - * * @return Backing vector storage. */ public VectorStorage delegate() { @@ -66,7 +65,6 @@ public VectorStorage delegate() { } /** - * * @return Offset into the backing vector. */ public int offset() { @@ -74,7 +72,6 @@ public int offset() { } /** - * * @return Vector length. */ public int length() { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java index 28469dfa8a7fb..66aa04912352e 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/MatrixVectorStorage.java @@ -75,7 +75,6 @@ public MatrixVectorStorage(Matrix parent, int row, int col, int rowStride, int c } /** - * * @return Starting row in the view. */ int row() { @@ -83,7 +82,6 @@ int row() { } /** - * * @return Starting column in the view. */ int column() { @@ -91,7 +89,6 @@ int column() { } /** - * * @return Rows stride in the view. */ int rowStride() { @@ -99,17 +96,13 @@ int rowStride() { } /** - * * @return Columns stride in the view. */ int columnStride() { return colStride; } - /** - * - * - */ + /** */ private int getSize() { if (rowStride != 0 && colStride != 0) { int n1 = (parent.rowSize() - row) / rowStride; diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java index a1890c85e4bad..035a56543a14c 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/storage/vector/SparseLocalOffHeapVectorStorage.java @@ -44,7 +44,6 @@ public SparseLocalOffHeapVectorStorage() { } /** - * * @param cap Initial capacity. */ public SparseLocalOffHeapVectorStorage(int cap) { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java index c2dc9b3276050..83ac837488d02 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/AbstractVector.java @@ -71,9 +71,7 @@ public abstract class AbstractVector implements Vector { /** Read-only error message. */ private static final String RO_MSG = "Vector is read-only."; - /** - * - */ + /** */ private void ensureReadOnly() { if (readOnly) throw new UnsupportedOperationException(RO_MSG); @@ -708,7 +706,6 @@ private boolean idxNextInitialized() { } /** - * * @param vec Vector to check for valid cardinality. */ protected void checkCardinality(Vector vec) { @@ -717,7 +714,6 @@ protected void checkCardinality(Vector vec) { } /** - * * @param vec Array to check for valid cardinality. */ protected void checkCardinality(double[] vec) { @@ -726,7 +722,6 @@ protected void checkCardinality(double[] vec) { } /** - * * @param arr Array to check for valid cardinality. */ protected void checkCardinality(int[] arr) { diff --git a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java index ce485cd5ff378..5ad6b890fabe3 100644 --- a/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java +++ b/modules/ml/src/main/java/org/apache/ignite/ml/math/impls/vector/PivotedVectorView.java @@ -58,10 +58,7 @@ public PivotedVectorView(Vector vec, int[] pivot) { this.vec = vec; } - /** - * - * - */ + /** */ private PivotedVectorStorage storage() { return (PivotedVectorStorage)getStorage(); } @@ -74,7 +71,6 @@ public PivotedVectorView() { } /** - * * @return Parent vector. */ public Vector getBaseVector() { @@ -82,7 +78,6 @@ public Vector getBaseVector() { } /** - * * @param i Index to pivot. * @return Mapping from external index to internal for given index. */ @@ -91,7 +86,6 @@ public int pivot(int i) { } /** - * * @param i Index to unpivot. * @return Mapping from internal index to external for given index. */ @@ -100,7 +94,6 @@ public int unpivot(int i) { } /** - * * @param idx Index of vector element. * @return Vector element at given index. */