org.monospark.geometrix.matrix

Class MatHelper

java.lang.Object

org.monospark.geometrix.matrix.MatHelper

public final class MatHelper
extends java.lang.Object

This class contains static helper methods for Mat objects.

See Also:

Mat

Method Summary

Modifier and Type	Method and Description
static <R extends OneMin,C extends OneMin> Mat<R,C>	divide(Mat<R,C> m, double s) Divides a matrix by a scalar
static <R extends OneMin,C extends OneMin> java.util.Optional<Mat<R,C>>	divideOptional(Mat<R,C> m, double s) Divides a matrix by a scalar
static <R1 extends OneMin,C1 extends OneMin,R2 extends OneMin,C2 extends OneMin> Mat<R1,C2>	multiply(Mat<R1,C1> m1, Mat<R2,C2> m2) Multiplies a two matrices with each other.
static <R extends OneMin,C extends OneMin> Mat<R,C>	multiply(Mat<R,C> m, double s) Multiplies a matrix with a scalar
static <R1 extends OneMin,C1 extends OneMin,R2 extends OneMin,C2 extends OneMin> java.util.Optional<Mat<R1,C2>>	multiplyOptional(Mat<R1,C1> m1, Mat<R2,C2> m2) Multiplies a two matrices with each other.
static <R extends OneMin,C extends OneMin> java.util.Optional<Mat<R,C>>	multiplyOptional(Mat<R,C> m, double s) Multiplies a matrix with a scalar
static <R extends OneMin,C extends OneMin> double[]	toArray(Mat<R,C> m, Mat.ElementOrder order) Returns the elements of a matrix in an ordered array.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

multiply

public static <R extends OneMin,C extends OneMin> Mat<R,C> multiply(Mat<R,C> m,
                                                                    double s)

Multiplies a matrix with a scalar

Parameters:

m - the matrix

s - the scalar

Returns:

the result of m * s

Throws:

java.lang.NullPointerException - if m is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

java.lang.IllegalArgumentException - if an element of the resulting matrix is infinite

multiplyOptional

public static <R extends OneMin,C extends OneMin> java.util.Optional<Mat<R,C>> multiplyOptional(Mat<R,C> m,
                                                                                                double s)

Multiplies a matrix with a scalar

Parameters:

m - the matrix

s - the scalar

Returns:

the result of m * s. If one element of the resulting matrix is infinite, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if m is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

multiply

public static <R1 extends OneMin,C1 extends OneMin,R2 extends OneMin,C2 extends OneMin> Mat<R1,C2> multiply(Mat<R1,C1> m1,
                                                                                                            Mat<R2,C2> m2)

Multiplies a two matrices with each other.

Parameters:

m1 - the first matrix

m2 - the second matrix

Returns:

the result of m1 * m2

Throws:

java.lang.NullPointerException - if m1 or m2 is null

java.lang.IllegalArgumentException - if an element of the resulting matrix is infinite

multiplyOptional

public static <R1 extends OneMin,C1 extends OneMin,R2 extends OneMin,C2 extends OneMin> java.util.Optional<Mat<R1,C2>> multiplyOptional(Mat<R1,C1> m1,
                                                                                                                                        Mat<R2,C2> m2)

Multiplies a two matrices with each other.

Parameters:

m1 - the first matrix

m2 - the second matrix

Returns:

the result of m1 * m2. If one element of the resulting matrix is infinite, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if m1 or m2 is null

divide

public static <R extends OneMin,C extends OneMin> Mat<R,C> divide(Mat<R,C> m,
                                                                  double s)

Divides a matrix by a scalar

Parameters:

m - the matrix

s - the scalar

Returns:

the result of m / s

Throws:

java.lang.NullPointerException - if m is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

java.lang.IllegalArgumentException - if an element of the resulting matrix is infinite

divideOptional

public static <R extends OneMin,C extends OneMin> java.util.Optional<Mat<R,C>> divideOptional(Mat<R,C> m,
                                                                                              double s)

Divides a matrix by a scalar

Parameters:

m - the matrix

s - the scalar

Returns:

the result of m / s. If one element of the resulting matrix is infinite, an empty Optional will be returned.

Throws:

java.lang.NullPointerException - if m is null

java.lang.IllegalArgumentException - if s is equal to (+/-)Infinity or NaN

toArray

public static <R extends OneMin,C extends OneMin> double[] toArray(Mat<R,C> m,
                                                                   Mat.ElementOrder order)

Returns the elements of a matrix in an ordered array.

Parameters:

m - the matrix which should be converted to an row-major array

order - the order in which the elements of the matrix should be filled into the array

Returns:

a double array containing the values of the matrix in the specified order

Throws:

java.lang.NullPointerException - if m or order is null