Merge pull request #2 from stefan-zobel/Tensors

Merge Tensors branch

Author: stefan-zobel

pom.xml

@@ -4,7 +4,7 @@
     <groupId>net.sourceforge.streamsupport</groupId>
     <artifactId>jamu</artifactId>
     <packaging>jar</packaging>
-    <version>1.3.1</version>
+    <version>1.4.0-SNAPSHOT</version>
     <name>JAMU</name>
     <description>Java Matrix Utilities built on top of Intel MKL</description>
     <url>https://github.com/stefan-zobel/JAMU/</url>
@@ -33,7 +33,7 @@
         <dependency>
             <groupId>net.sourceforge.streamsupport</groupId>
             <artifactId>dedekind-mkl</artifactId>
-            <version>1.0.1</version>
+            <version>1.1.0</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>

src/main/java/net/jamu/matrix/Checks.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2019, 2021 Stefan Zobel
+ * Copyright 2019, 2023 Stefan Zobel
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -293,20 +293,20 @@ static void checkStdDev(double stdDev) {
         }
     }
 
-    static void throwInfiniteOrNan(Dimensions A, int index) {
+    static void throwInfiniteOrNan(MatrixDimensions A, int index) {
         int row = rowIdx(A, index);
         int col = colIdx(A, index, row);
         throw new IllegalArgumentException("Infinite or NaN at (" + row + ", " + col + ")");
     }
 
-    static int rowIdx(Dimensions A, int index) {
+    static int rowIdx(MatrixDimensions A, int index) {
         if (A.isComplex()) {
             index = index / 2;
         }
         return index % A.numRows();
     }
 
-    static int colIdx(Dimensions A, int index, int rowIdx) {
+    static int colIdx(MatrixDimensions A, int index, int rowIdx) {
         if (A.isComplex()) {
             index = index / 2;
         }

src/main/java/net/jamu/matrix/ComplexMatrixD.java

@@ -25,7 +25,7 @@
  * layout. The addressing is zero based. All operations throw a
  * {@code NullPointerException} if any of the method arguments is {@code null}.
  */
-public interface ComplexMatrixD extends Dimensions, ComplexMatrixDConduct {
+public interface ComplexMatrixD extends MatrixDimensions, ComplexMatrixDConduct {
 
     /**
      * Get the single element as a scalar if this matrix is 1-by-1.

src/main/java/net/jamu/matrix/ComplexMatrixDConduct.java

@@ -154,7 +154,7 @@ public interface ComplexMatrixDConduct {
     ComplexMatrixD mrdivide(ComplexMatrixD B);
 
     /**
-     * {@code A * B} convenience multiplication. None of the operands is
+     * {@code A * B} convenience multiplication. None of the operands are
      * mutated.
      * 
      * @param B
@@ -166,7 +166,7 @@ public interface ComplexMatrixDConduct {
     /**
      * {@code A * B * C} convenience multiplication. The optimal
      * parenthesization of the involved product of 3 matrices will be determined
-     * automatically. None of the operands is mutated.
+     * automatically. None of the operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -181,7 +181,7 @@ public interface ComplexMatrixDConduct {
      * multiplication. This is much more efficient than the equivalent
      * {@code A.times(B1).times(B2).times(B3) ... .times(Bn)} multiplication as
      * the cheapest sequence for performing these multiplications is determined
-     * automatically by this method. None of the operands is mutated.
+     * automatically by this method. None of the operands are mutated.
      * 
      * @param m
      *            the first matrix to right-multiply (the {@code B1} from above)
@@ -196,7 +196,7 @@ public interface ComplexMatrixDConduct {
     /**
      * <code>A * A<sup>*</sup></code> multiplication. This is much more
      * efficient than the equivalent {@code A.times(A.conjugateTranspose())}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A<sup>*</sup> * A</code> use {@link #conjugateTransposedTimes()}.
      * 
      * @return the result of the multiplication
@@ -207,7 +207,7 @@ public interface ComplexMatrixDConduct {
     /**
      * <code>A * B<sup>*</sup></code> multiplication. This is much more
      * efficient than the equivalent {@code A.times(B.conjugateTranspose())}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A<sup>*</sup> * B</code> use
      * {@link #conjugateTransposedTimes(ComplexMatrixD)}.
      * 
@@ -221,7 +221,7 @@ public interface ComplexMatrixDConduct {
     /**
      * <code>A<sup>*</sup> * A</code> multiplication. This is much more
      * efficient than the equivalent {@code A.conjugateTranspose().times(A)}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A * A<sup>*</sup></code> use {@link #timesConjugateTransposed()}.
      * 
      * @return the result of the multiplication
@@ -232,7 +232,7 @@ public interface ComplexMatrixDConduct {
     /**
      * <code>A<sup>*</sup> * B</code> multiplication. This is much more
      * efficient than the equivalent {@code A.conjugateTranspose().times(B)}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A * B<sup>*</sup></code> use
      * {@link #timesConjugateTransposed(ComplexMatrixD)}.
      * 
@@ -246,7 +246,7 @@ public interface ComplexMatrixDConduct {
     /**
      * Multiply this matrix {@code A} with a real matrix {@code B} returning
      * the result of the multiplication {@code A * B} as a complex matrix. None
-     * of the operands is mutated.
+     * of the operands are mutated.
      * 
      * @param B
      *            second multiplicand (a real matrix)
@@ -255,7 +255,7 @@ public interface ComplexMatrixDConduct {
     ComplexMatrixD times(MatrixD B);
 
     /**
-     * {@code A + B} convenience addition. None of the operands is mutated.
+     * {@code A + B} convenience addition. None of the operands are mutated.
      * 
      * @param B
      *            the addend
@@ -265,7 +265,7 @@ public interface ComplexMatrixDConduct {
 
     /**
      * {@code A * B + C} convenience multiplication plus addition. None of the
-     * operands is mutated.
+     * operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -277,7 +277,7 @@ public interface ComplexMatrixDConduct {
 
     /**
      * {@code A * B - C} convenience multiplication and subtraction. None of
-     * the operands is mutated.
+     * the operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -289,7 +289,7 @@ public interface ComplexMatrixDConduct {
     ComplexMatrixD timesMinus(ComplexMatrixD B, ComplexMatrixD C);
 
     /**
-     * {@code A - B} convenience subtraction. None of the operands is mutated.
+     * {@code A - B} convenience subtraction. None of the operands are mutated.
      * 
      * @param B
      *            the subtrahend
@@ -298,7 +298,7 @@ public interface ComplexMatrixDConduct {
     ComplexMatrixD minus(ComplexMatrixD B);
 
     /**
-     * Unary minus {@code -A} convenience method. None of the operands is
+     * Unary minus {@code -A} convenience method. None of the operands are
      * mutated.
      * 
      * @return {@code -A}
@@ -308,29 +308,29 @@ public interface ComplexMatrixDConduct {
     /**
      * Returns {@code |A|}, i.e. a matrix where all elements
      * <code>a<sub>ij</sub></code> have been replaced by their absolute value
-     * <code>|a<sub>ij</sub>|</code>. None of the operands is mutated.
+     * <code>|a<sub>ij</sub>|</code>. None of the operands are mutated.
      * 
      * @return {@code |A|}, the matrix of absolute values of {@code A}
      */
     ComplexMatrixD abs();
 
     /**
-     * Returns <code>A<sup>*</sup></code>. None of the operands is mutated.
+     * Returns <code>A<sup>*</sup></code>. None of the operands are mutated.
      * 
      * @return the conjugate transpose of this matrix
      */
     ComplexMatrixD conjugateTranspose();
 
     /**
-     * Returns <code>A<sup>T</sup></code>. None of the operands is mutated.
+     * Returns <code>A<sup>T</sup></code>. None of the operands are mutated.
      * 
      * @return the transposed matrix
      */
     ComplexMatrixD transpose();
 
     /**
      * Returns <code>A<sup>-1</sup></code> for quadratic matrices. None of the
-     * operands is mutated.
+     * operands are mutated.
      * 
      * @return the inverse of this matrix if it is quadratic
      * @throws IllegalArgumentException
@@ -375,7 +375,7 @@ public interface ComplexMatrixDConduct {
      * The new shape must be compatible with the original shape in the sense
      * that {@code rows x cols == this.numRows() x this.numColumns()} is
      * required, otherwise an {@code IllegalArgumentException} is thrown. None
-     * of the operands is mutated.
+     * of the operands are mutated.
      * 
      * @param rows
      *            the desired number of rows of the reshaped matrix

src/main/java/net/jamu/matrix/ComplexMatrixF.java

@@ -25,7 +25,7 @@
  * layout. The addressing is zero based. All operations throw a
  * {@code NullPointerException} if any of the method arguments is {@code null}.
  */
-public interface ComplexMatrixF extends Dimensions, ComplexMatrixFConduct {
+public interface ComplexMatrixF extends MatrixDimensions, ComplexMatrixFConduct {
 
     /**
      * Get the single element as a scalar if this matrix is 1-by-1.

src/main/java/net/jamu/matrix/ComplexMatrixFConduct.java

@@ -154,7 +154,7 @@ public interface ComplexMatrixFConduct {
     ComplexMatrixF mrdivide(ComplexMatrixF B);
 
     /**
-     * {@code A * B} convenience multiplication. None of the operands is
+     * {@code A * B} convenience multiplication. None of the operands are
      * mutated.
      * 
      * @param B
@@ -166,7 +166,7 @@ public interface ComplexMatrixFConduct {
     /**
      * {@code A * B * C} convenience multiplication. The optimal
      * parenthesization of the involved product of 3 matrices will be determined
-     * automatically. None of the operands is mutated.
+     * automatically. None of the operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -181,7 +181,7 @@ public interface ComplexMatrixFConduct {
      * multiplication. This is much more efficient than the equivalent
      * {@code A.times(B1).times(B2).times(B3) ... .times(Bn)} multiplication as
      * the cheapest sequence for performing these multiplications is determined
-     * automatically by this method. None of the operands is mutated.
+     * automatically by this method. None of the operands are mutated.
      * 
      * @param m
      *            the first matrix to right-multiply (the {@code B1} from above)
@@ -196,7 +196,7 @@ public interface ComplexMatrixFConduct {
     /**
      * <code>A * A<sup>*</sup></code> multiplication. This is much more
      * efficient than the equivalent {@code A.times(A.conjugateTranspose())}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A<sup>*</sup> * A</code> use {@link #conjugateTransposedTimes()}.
      * 
      * @return the result of the multiplication
@@ -207,7 +207,7 @@ public interface ComplexMatrixFConduct {
     /**
      * <code>A * B<sup>*</sup></code> multiplication. This is much more
      * efficient than the equivalent {@code A.times(B.conjugateTranspose())}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A<sup>*</sup> * B</code> use
      * {@link #conjugateTransposedTimes(ComplexMatrixF)}.
      * 
@@ -221,7 +221,7 @@ public interface ComplexMatrixFConduct {
     /**
      * <code>A<sup>*</sup> * A</code> multiplication. This is much more
      * efficient than the equivalent {@code A.conjugateTranspose().times(A)}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A * A<sup>*</sup></code> use {@link #timesConjugateTransposed()}.
      * 
      * @return the result of the multiplication
@@ -232,7 +232,7 @@ public interface ComplexMatrixFConduct {
     /**
      * <code>A<sup>*</sup> * B</code> multiplication. This is much more
      * efficient than the equivalent {@code A.conjugateTranspose().times(B)}.
-     * None of the operands is mutated. For the reversed order multiplication
+     * None of the operands are mutated. For the reversed order multiplication
      * <code>A * B<sup>*</sup></code> use
      * {@link #timesConjugateTransposed(ComplexMatrixF)}.
      * 
@@ -246,7 +246,7 @@ public interface ComplexMatrixFConduct {
     /**
      * Multiply this matrix {@code A} with a real matrix {@code B} returning
      * the result of the multiplication {@code A * B} as a complex matrix. None
-     * of the operands is mutated.
+     * of the operands are mutated.
      * 
      * @param B
      *            second multiplicand (a real matrix)
@@ -255,7 +255,7 @@ public interface ComplexMatrixFConduct {
     ComplexMatrixF times(MatrixF B);
 
     /**
-     * {@code A + B} convenience addition. None of the operands is mutated.
+     * {@code A + B} convenience addition. None of the operands are mutated.
      * 
      * @param B
      *            the addend
@@ -265,7 +265,7 @@ public interface ComplexMatrixFConduct {
 
     /**
      * {@code A * B + C} convenience multiplication plus addition. None of the
-     * operands is mutated.
+     * operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -277,7 +277,7 @@ public interface ComplexMatrixFConduct {
 
     /**
      * {@code A * B - C} convenience multiplication and subtraction. None of
-     * the operands is mutated.
+     * the operands are mutated.
      * 
      * @param B
      *            second multiplicand
@@ -289,7 +289,7 @@ public interface ComplexMatrixFConduct {
     ComplexMatrixF timesMinus(ComplexMatrixF B, ComplexMatrixF C);
 
     /**
-     * {@code A - B} convenience subtraction. None of the operands is mutated.
+     * {@code A - B} convenience subtraction. None of the operands are mutated.
      * 
      * @param B
      *            the subtrahend
@@ -298,7 +298,7 @@ public interface ComplexMatrixFConduct {
     ComplexMatrixF minus(ComplexMatrixF B);
 
     /**
-     * Unary minus {@code -A} convenience method. None of the operands is
+     * Unary minus {@code -A} convenience method. None of the operands are
      * mutated.
      * 
      * @return {@code -A}
@@ -308,29 +308,29 @@ public interface ComplexMatrixFConduct {
     /**
      * Returns {@code |A|}, i.e. a matrix where all elements
      * <code>a<sub>ij</sub></code> have been replaced by their absolute value
-     * <code>|a<sub>ij</sub>|</code>. None of the operands is mutated.
+     * <code>|a<sub>ij</sub>|</code>. None of the operands are mutated.
      * 
      * @return {@code |A|}, the matrix of absolute values of {@code A}
      */
     ComplexMatrixF abs();
 
     /**
-     * Returns <code>A<sup>*</sup></code>. None of the operands is mutated.
+     * Returns <code>A<sup>*</sup></code>. None of the operands are mutated.
      * 
      * @return the conjugate transpose of this matrix
      */
     ComplexMatrixF conjugateTranspose();
 
     /**
-     * Returns <code>A<sup>T</sup></code>. None of the operands is mutated.
+     * Returns <code>A<sup>T</sup></code>. None of the operands are mutated.
      * 
      * @return the transposed matrix
      */
     ComplexMatrixF transpose();
 
     /**
      * Returns <code>A<sup>-1</sup></code> for quadratic matrices. None of the
-     * operands is mutated.
+     * operands are mutated.
      * 
      * @return the inverse of this matrix if it is quadratic
      * @throws IllegalArgumentException
@@ -375,7 +375,7 @@ public interface ComplexMatrixFConduct {
      * The new shape must be compatible with the original shape in the sense
      * that {@code rows x cols == this.numRows() x this.numColumns()} is
      * required, otherwise an {@code IllegalArgumentException} is thrown. None
-     * of the operands is mutated.
+     * of the operands are mutated.
      * 
      * @param rows
      *            the desired number of rows of the reshaped matrix