Hadamard product for complex matrices

Author: stefan-zobel

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020, 2021 Stefan Zobel
+ * Copyright 2020, 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.
@@ -637,6 +637,19 @@ public interface ComplexMatrixD extends Dimensions, ComplexMatrixDConduct {
      */
     ComplexMatrixD expm();
 
+    /**
+     * Hadamard product {@code C = A} ∘ {@code B} (also known as
+     * element-wise product) of this matrix (A) and B.
+     * 
+     * @param B
+     *            the matrix this matrix is multiplied with
+     * @param out
+     *            output matrix for the result of the multiplication
+     * @return {@code out}
+     * @since 1.3.1
+     */
+    ComplexMatrixD hadamard(ComplexMatrixD B, ComplexMatrixD out);
+
     /**
      * Computes the singular value decomposition of this matrix.
      * 

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

@@ -597,6 +597,28 @@ public ComplexMatrixD expm() {
         return Expm.expmComplexD(this, normMaxAbs());
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ComplexMatrixD hadamard(ComplexMatrixD B, ComplexMatrixD out) {
+        Checks.checkEqualDimension(this, B);
+        Checks.checkEqualDimension(this, out);
+        double[] _a = a;
+        double[] _b = B.getArrayUnsafe();
+        double[] _c = out.getArrayUnsafe();
+        ZdImpl a = new ZdImpl(0.0);
+        ZdImpl b = new ZdImpl(0.0);
+        for (int i = 0; i < _a.length; i += 2) {
+            a.set(_a[i], _a[i + 1]);
+            b.set(_b[i], _b[i + 1]);
+            a.mul(b);
+            _c[i] = a.re();
+            _c[i + 1] = a.im();
+        }
+        return out;
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -940,6 +962,14 @@ public ComplexMatrixD conjugateTransposedTimes(ComplexMatrixD B) {
         return conjTransAmult(B, create(cols, B.numColumns()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ComplexMatrixD hadamard(ComplexMatrixD B) {
+        return hadamard(B, create(rows, cols));
+    }
+
     /**
      * {@inheritDoc}
      */

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

@@ -338,6 +338,17 @@ public interface ComplexMatrixDConduct {
      */
     ComplexMatrixD inverse();
 
+    /**
+     * Hadamard product {@code A} ∘ {@code B} (also known as
+     * element-wise product) of this matrix (A) and B.
+     * 
+     * @param B
+     *            the matrix this matrix is multiplied with
+     * @return the result of the Hadamard multiplication
+     * @since 1.3.1
+     */
+    ComplexMatrixD hadamard(ComplexMatrixD B);
+
     /**
      * Reshapes this matrix into a new matrix of dimension {@code rows x cols}
      * where the elements in this matrix are read in Fortran-style column-major

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

@@ -1,5 +1,5 @@
 /*
- * Copyright 2020, 2021 Stefan Zobel
+ * Copyright 2020, 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.
@@ -637,6 +637,19 @@ public interface ComplexMatrixF extends Dimensions, ComplexMatrixFConduct {
      */
     ComplexMatrixF expm();
 
+    /**
+     * Hadamard product {@code C = A} ∘ {@code B} (also known as
+     * element-wise product) of this matrix (A) and B.
+     * 
+     * @param B
+     *            the matrix this matrix is multiplied with
+     * @param out
+     *            output matrix for the result of the multiplication
+     * @return {@code out}
+     * @since 1.3.1
+     */
+    ComplexMatrixF hadamard(ComplexMatrixF B, ComplexMatrixF out);
+
     /**
      * Computes the singular value decomposition of this matrix.
      * 

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

@@ -597,6 +597,28 @@ public ComplexMatrixF expm() {
         return Expm.expmComplexF(this, normMaxAbs());
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ComplexMatrixF hadamard(ComplexMatrixF B, ComplexMatrixF out) {
+        Checks.checkEqualDimension(this, B);
+        Checks.checkEqualDimension(this, out);
+        float[] _a = a;
+        float[] _b = B.getArrayUnsafe();
+        float[] _c = out.getArrayUnsafe();
+        ZfImpl a = new ZfImpl(0.0f);
+        ZfImpl b = new ZfImpl(0.0f);
+        for (int i = 0; i < _a.length; i += 2) {
+            a.set(_a[i], _a[i + 1]);
+            b.set(_b[i], _b[i + 1]);
+            a.mul(b);
+            _c[i] = a.re();
+            _c[i + 1] = a.im();
+        }
+        return out;
+    }
+
     /**
      * {@inheritDoc}
      */
@@ -939,6 +961,14 @@ public ComplexMatrixF conjugateTransposedTimes(ComplexMatrixF B) {
         return conjTransAmult(B, create(cols, B.numColumns()));
     }
 
+    /**
+     * {@inheritDoc}
+     */
+    @Override
+    public ComplexMatrixF hadamard(ComplexMatrixF B) {
+        return hadamard(B, create(rows,cols));
+    }
+
     /**
      * {@inheritDoc}
      */

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

@@ -338,6 +338,17 @@ public interface ComplexMatrixFConduct {
      */
     ComplexMatrixF inverse();
 
+    /**
+     * Hadamard product {@code A} ∘ {@code B} (also known as
+     * element-wise product) of this matrix (A) and B.
+     * 
+     * @param B
+     *            the matrix this matrix is multiplied with
+     * @return the result of the Hadamard multiplication
+     * @since 1.3.1
+     */
+    ComplexMatrixF hadamard(ComplexMatrixF B);
+
     /**
      * Reshapes this matrix into a new matrix of dimension {@code rows x cols}
      * where the elements in this matrix are read in Fortran-style column-major