Class CommonOps_DDRM
public class CommonOps_DDRM
extends java.lang.Object
Common matrix operations are contained here. Which specific underlying algorithm is used is not specified just the out come of the operation. Nor should calls to these functions reply on the underlying implementation. Which algorithm is used can depend on the matrix being passed in.
For more exotic and specialized generic operations see SpecializedOps_DDRM.
-
Constructor Summary
Constructors Constructor Description CommonOps_DDRM() -
Method Summary
Modifier and Type Method Description static voidabs(org.ejml.data.DMatrixD1 a)Performs absolute value of a matrix:
a = abs(a)
aij = abs(aij)static voidabs(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 c)Performs absolute value of a matrix:
c = abs(a)
cij = abs(aij)static <T extends org.ejml.data.DMatrixD1>
Tadd(double alpha, T a, double beta, T b, T output)Performs the following operation:
c = α * a + β * b
cij = α * aij + β * bijstatic <T extends org.ejml.data.DMatrixD1>
Tadd(double alpha, T a, T b, T output)Performs the following operation:
c = α * a + b
cij = α * aij + bijstatic voidadd(org.ejml.data.DMatrixD1 a, double val)Performs an in-place scalar addition:
a = a + val
aij = aij + valstatic <T extends org.ejml.data.DMatrixD1>
Tadd(T a, double val, T output)Performs scalar addition:
c = a + val
cij = aij + valstatic <T extends org.ejml.data.DMatrixD1>
Tadd(T a, double beta, T b, T output)Performs the following operation:
c = a + β * b
cij = aij + β * bijstatic <T extends org.ejml.data.DMatrixD1>
Tadd(T a, T b, T output)Performs the following operation:
c = a + b
cij = aij + bijstatic voidaddEquals(org.ejml.data.DMatrixD1 a, double beta, org.ejml.data.DMatrixD1 b)Performs the following operation:
a = a + β * b
aij = aij + β * bijstatic voidaddEquals(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs the following operation:
a = a + b
aij = aij + bijstatic org.ejml.data.DMatrixRMajapply(org.ejml.data.DMatrixRMaj input, org.ejml.ops.DOperatorUnary func)static org.ejml.data.DMatrixRMajapply(org.ejml.data.DMatrixRMaj input, org.ejml.ops.DOperatorUnary func, @Nullable org.ejml.data.DMatrixRMaj output)This applies a given unary function on every value stored in the matrixstatic voidchangeSign(org.ejml.data.DMatrixD1 a)Changes the sign of every element in the matrix.
aij = -aijstatic <T extends org.ejml.data.DMatrixD1>
TchangeSign(T input, T output)Changes the sign of every element in the matrix.
outputij = -inputijstatic org.ejml.data.DMatrixRMaj[]columnsToVector(org.ejml.data.DMatrixRMaj A, @Nullable org.ejml.data.DMatrixRMaj[] v)Converts the columns in a matrix into a set of vectors.static org.ejml.data.DMatrixRMajconcatColumns(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, @Nullable org.ejml.data.DMatrixRMaj output)output = [a , b]static org.ejml.data.DMatrixRMajconcatColumnsMulti(org.ejml.data.DMatrixRMaj... m)Concatinates all the matrices together along their columns.static voidconcatRows(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj output)output = [a ; b]static org.ejml.data.DMatrixRMajconcatRowsMulti(org.ejml.data.DMatrixRMaj... m)Concatinates all the matrices together along their columns.static intcountTrue(org.ejml.data.BMatrixRMaj A)Counts the number of elements in A which are truestatic doubledet(org.ejml.data.DMatrixRMaj mat)Returns the determinant of the matrix.static org.ejml.data.DMatrixRMajdiag(double... diagEl)Creates a new square matrix whose diagonal elements are specified by diagEl and all the other elements are zero.
aij = 0 if i ≤ j
aij = diag[i] if i = jstatic org.ejml.data.DMatrixRMajdiag(@Nullable org.ejml.data.DMatrixRMaj ret, int width, double... diagEl)static org.ejml.data.DMatrixRMajdiagR(int numRows, int numCols, double... diagEl)Creates a new rectangular matrix whose diagonal elements are specified by diagEl and all the other elements are zero.
aij = 0 if i ≤ j
aij = diag[i] if i = jstatic voiddivide(double alpha, org.ejml.data.DMatrixD1 a)Performs an in-place element by element scalar division with the scalar on top.
aij = α/aijstatic <T extends org.ejml.data.DMatrixD1>
Tdivide(double alpha, T input, T output)Performs an element by element scalar division with the scalar on top.
bij = α/aijstatic voiddivide(org.ejml.data.DMatrixD1 a, double alpha)Performs an in-place element by element scalar division with the scalar on bottom.
aij = aij/αstatic <T extends org.ejml.data.DMatrixD1>
Tdivide(T input, double alpha, T output)Performs an element by element scalar division with the scalar on botton.
bij = aij /αstatic voiddivideCols(org.ejml.data.DMatrixRMaj A, double[] values)Divides every element in column i by value[i].static voiddivideRows(double[] values, org.ejml.data.DMatrixRMaj A)Divides every element in row i by value[i].static voiddivideRowsCols(double[] diagA, int offsetA, org.ejml.data.DMatrixRMaj B, double[] diagC, int offsetC)Equivalent to multiplying a matrix B by the inverse of two diagonal matrices.static doubledot(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Computes the dot product or inner product between two vectors.static voidelementDiv(org.ejml.data.DMatrixD1 A, org.ejml.data.DMatrixD1 B)Performs the an element by element division operation:
aij = aij / bijstatic <T extends org.ejml.data.DMatrixD1>
TelementDiv(T A, T B, T output)Performs the an element by element division operation:
cij = aij / bijstatic <T extends org.ejml.data.DMatrixD1>
TelementExp(T A, T output)Element-wise exp operation
cij = Math.exp(aij)static org.ejml.data.BMatrixRMajelementLessThan(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the > operator to each element in A.static org.ejml.data.BMatrixRMajelementLessThan(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, org.ejml.data.BMatrixRMaj output)Applies the < operator to each element in A.static org.ejml.data.BMatrixRMajelementLessThanOrEqual(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the ≥ operator to each element in A.static org.ejml.data.BMatrixRMajelementLessThanOrEqual(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, org.ejml.data.BMatrixRMaj output)Applies the A ≤ B operator to each element.static <T extends org.ejml.data.DMatrixD1>
TelementLog(T A, T output)Element-wise log operation
cij = Math.log(aij)static doubleelementMax(org.ejml.data.DMatrixD1 a)Returns the value of the element in the matrix that has the largest value.
Max{ aij } for all i and jstatic doubleelementMax(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the value of the element in the matrix that has the largest value.
Max{ aij } for all i and jstatic doubleelementMaxAbs(org.ejml.data.DMatrixD1 a)Returns the absolute value of the element in the matrix that has the largest absolute value.
Max{ |aij| } for all i and jstatic doubleelementMaxAbs(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the absolute value of the element in the matrix that has the largest absolute value.
Max{ |aij| } for all i and jstatic doubleelementMin(org.ejml.data.DMatrixD1 a)Returns the value of the element in the matrix that has the minimum value.
Min{ aij } for all i and jstatic doubleelementMin(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the value of the element in the matrix that has the minimum value.
Min{ aij } for all i and jstatic doubleelementMinAbs(org.ejml.data.DMatrixD1 a)Returns the absolute value of the element in the matrix that has the smallest absolute value.
Min{ |aij| } for all i and jstatic doubleelementMinAbs(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the absolute value of the element in the matrix that has the smallest absolute value.
Min{ |aij| } for all i and jstatic org.ejml.data.BMatrixRMajelementMoreThan(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the > operator to each element in A.static org.ejml.data.BMatrixRMajelementMoreThanOrEqual(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the ≥ operator to each element in A.static voidelementMult(org.ejml.data.DMatrixD1 A, org.ejml.data.DMatrixD1 B)Performs the an element by element multiplication operation:
aij = aij * bijstatic <T extends org.ejml.data.DMatrixD1>
TelementMult(T A, T B, T output)Performs the an element by element multiplication operation:
cij = aij * bijstatic <T extends org.ejml.data.DMatrixD1>
TelementPower(double a, T B, T output)Element-wise power operation
cij = a ^ bijstatic <T extends org.ejml.data.DMatrixD1>
TelementPower(T A, double b, T output)Element-wise power operation
cij = aij ^ bstatic <T extends org.ejml.data.DMatrixD1>
TelementPower(T A, T B, T output)Element-wise power operation
cij = aij ^ bijstatic org.ejml.data.DMatrixRMajelements(org.ejml.data.DMatrixRMaj A, org.ejml.data.BMatrixRMaj marked, @Nullable org.ejml.data.DMatrixRMaj output)Returns a row matrix which contains all the elements in A which are flagged as true in 'marked'static doubleelementSum(org.ejml.data.DMatrixD1 mat)Computes the sum of all the elements in the matrix:
sum(i=1:m , j=1:n ; aij)static doubleelementSumAbs(org.ejml.data.DMatrixD1 mat)Computes the sum of the absolute value all the elements in the matrix:
sum(i=1:m , j=1:n ; |aij|)static voidextract(org.ejml.data.DMatrix src, int srcY0, int srcY1, int srcX0, int srcX1, org.ejml.data.DMatrix dst)Extract where the destination is reshaped to match the extracted regionstatic voidextract(org.ejml.data.DMatrix src, int srcY0, int srcY1, int srcX0, int srcX1, org.ejml.data.DMatrix dst, int dstY0, int dstX0)Extracts a submatrix from 'src' and inserts it in a submatrix in 'dst'.static voidextract(org.ejml.data.DMatrix src, int srcY0, int srcX0, org.ejml.data.DMatrix dst)Extracts a submatrix from 'src' and inserts it in a submatrix in 'dst'.static org.ejml.data.DMatrixRMajextract(org.ejml.data.DMatrixRMaj src, int[] rows, int rowsSize, int[] cols, int colsSize, @Nullable org.ejml.data.DMatrixRMaj dst)Extracts out a matrix from source given a sub matrix with arbitrary rows and columns specified in two array listsstatic org.ejml.data.DMatrixRMajextract(org.ejml.data.DMatrixRMaj src, int[] indexes, int length, @Nullable org.ejml.data.DMatrixRMaj dst)Extracts the elements from the source matrix by their 1D index.static org.ejml.data.DMatrixRMajextract(org.ejml.data.DMatrixRMaj src, int srcY0, int srcY1, int srcX0, int srcX1)Creates a new matrix which is the specified submatrix of 'src'static org.ejml.data.DMatrixRMajextractColumn(org.ejml.data.DMatrixRMaj a, int column, @Nullable org.ejml.data.DMatrixRMaj out)Extracts the column from a matrix.static org.ejml.data.DMatrixRMajextractDiag(org.ejml.data.DMatrixRMaj src, @Nullable org.ejml.data.DMatrixRMaj dst)Extracts the diagonal elements 'src' write it to the 'dst' vector.static org.ejml.data.DMatrixRMajextractRow(org.ejml.data.DMatrixRMaj a, int row, @Nullable org.ejml.data.DMatrixRMaj out)Extracts the row from a matrix.static voidfill(org.ejml.data.DMatrixD1 a, double value)Sets every element in the matrix to the specified value.
aij = valuestatic org.ejml.data.DMatrixRMajidentity(int width)Creates an identity matrix of the specified size.
aij = 0 if i ≠ j
aij = 1 if i = jstatic org.ejml.data.DMatrixRMajidentity(int numRows, int numCols)Creates a rectangular matrix which is zero except along the diagonals.static voidinsert(org.ejml.data.DMatrixRMaj src, org.ejml.data.DMatrixRMaj dst, int[] rows, int rowsSize, int[] cols, int colsSize)Inserts into the specified elements of dst the source matrix.static voidinsert(org.ejml.data.DMatrix src, org.ejml.data.DMatrix dest, int destY0, int destX0)Inserts matrix 'src' into matrix 'dest' with the (0,0) of src at (row,col) in dest.static booleaninvert(org.ejml.data.DMatrixRMaj mat)Performs a matrix inversion operation on the specified matrix and stores the results in the same matrix.
a = a-1static booleaninvert(org.ejml.data.DMatrixRMaj mat, org.ejml.data.DMatrixRMaj result)Performs a matrix inversion operation that does not modify the original and stores the results in another matrix.static booleaninvertSPD(org.ejml.data.DMatrixRMaj mat, org.ejml.data.DMatrixRMaj result)Matrix inverse for symmetric positive definite matrices.static org.ejml.data.DMatrixRMajkron(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, @Nullable org.ejml.data.DMatrixRMaj C)The Kronecker product of two matrices is defined as:
Cij = aijB
where Cij is a sub matrix inside of C ∈ ℜ m*k × n*l, A ∈ ℜ m × n, and B ∈ ℜ k × l.static org.ejml.data.DMatrixRMajmaxCols(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along column in the input matrix and returns the results in a vector:
bj = min(i=1:m ; aij)static org.ejml.data.DMatrixRMajmaxRows(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the maximum value along each row in the input matrix and returns the results in a vector:
bj = max(i=1:n ; aji)static org.ejml.data.DMatrixRMajminCols(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along column in the input matrix and returns the results in a vector:
bj = min(i=1:m ; aij)static org.ejml.data.DMatrixRMajminRows(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along each row in the input matrix and returns the results in a vector:
bj = min(i=1:n ; aji)static <T extends org.ejml.data.DMatrix1Row>
Tmult(double alpha, T a, T b, T output)Performs the following operation:
c = α * a * b
cij = α ∑k=1:n { * aik * bkj}static <T extends org.ejml.data.DMatrix1Row>
Tmult(T a, T b, T output)Performs the following operation:
c = a * b
cij = ∑k=1:n { aik * bkj}static voidmultAdd(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * a * b
cij = cij + α * ∑k=1:n { aik * bkj}static voidmultAdd(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + a * b
cij = cij + ∑k=1:n { aik * bkj}static voidmultAddTransA(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * aT * b
cij =cij + α * ∑k=1:n { aki * bkj}static voidmultAddTransA(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + aT * b
cij = cij + ∑k=1:n { aki * bkj}static voidmultAddTransAB(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * aT * bT
cij = cij + α * ∑k=1:n { aki * bjk}static voidmultAddTransAB(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + aT * bT
cij = cij + ∑k=1:n { aki * bjk}static voidmultAddTransB(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * a * bT
cij = cij + α * ∑k=1:n { aik * bjk}static voidmultAddTransB(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + a * bT
cij = cij + ∑k=1:n { aik * bjk}static voidmultCols(org.ejml.data.DMatrixRMaj A, double[] values)Multiplies every element in column i by value[i].static <T extends org.ejml.data.DMatrix1Row>
TmultInner(T a, T output)Computes the matrix multiplication inner product:
c = aT * a
cij = ∑k=1:n { aki * akj}static <T extends org.ejml.data.DMatrix1Row>
TmultOuter(T a, T output)Computes the matrix multiplication outer product:
c = a * aT
cij = ∑k=1:m { aik * ajk}static voidmultRows(double[] values, org.ejml.data.DMatrixRMaj A)Multiplies every element in row i by value[i].static <T extends org.ejml.data.DMatrix1Row>
TmultTransA(double alpha, T a, T b, T output)Performs the following operation:
c = α * aT * b
cij = α ∑k=1:n { aki * bkj}static <T extends org.ejml.data.DMatrix1Row>
TmultTransA(T a, T b, T output)Performs the following operation:
c = aT * b
cij = ∑k=1:n { aki * bkj}static <T extends org.ejml.data.DMatrix1Row>
TmultTransAB(double alpha, T a, T b, T output)Performs the following operation:
c = α * aT * bT
cij = α ∑k=1:n { aki * bjk}static <T extends org.ejml.data.DMatrix1Row>
TmultTransAB(T a, T b, T output)Performs the following operation:
c = aT * bT
cij = ∑k=1:n { aki * bjk}static <T extends org.ejml.data.DMatrix1Row>
TmultTransB(double alpha, T a, T b, T output)Performs the following operation:
c = α * a * bT
cij = α ∑k=1:n { aik * bjk}static <T extends org.ejml.data.DMatrix1Row>
TmultTransB(T a, T b, T output)Performs the following operation:
c = a * bT
cij = ∑k=1:n { aik * bjk}static org.ejml.data.DMatrixRMajpermuteRowInv(int[] pinv, org.ejml.data.DMatrixRMaj input, org.ejml.data.DMatrixRMaj output)Applies the row permutation specified by the vector to the input matrix and save the results in the output matrix.static voidpinv(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj invA)Computes the Moore-Penrose pseudo-inverse:
pinv(A) = (ATA)-1 AT
or
pinv(A) = AT(AAT)-1static voidremoveColumns(org.ejml.data.DMatrixRMaj A, int col0, int col1)Removes columns from the matrix.static org.ejml.data.DMatrixRMaj[]rowsToVector(org.ejml.data.DMatrixRMaj A, @Nullable org.ejml.data.DMatrixRMaj[] v)Converts the rows in a matrix into a set of vectors.static org.ejml.data.DMatrixRMajrref(org.ejml.data.DMatrixRMaj A, int numUnknowns, @Nullable org.ejml.data.DMatrixRMaj reduced)Puts the augmented system matrix into reduced row echelon form (RREF) using Gauss-Jordan elimination with row (partial) pivots.static voidscale(double alpha, org.ejml.data.DMatrixD1 a)Performs an in-place element by element scalar multiplication.
aij = α*aijstatic voidscale(double alpha, org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs an element by element scalar multiplication.
bij = α*aijstatic voidscaleCol(double alpha, org.ejml.data.DMatrixRMaj A, int col)In-place scaling of a column in Astatic voidscaleRow(double alpha, org.ejml.data.DMatrixRMaj A, int row)In-place scaling of a row in Astatic voidsetIdentity(org.ejml.data.DMatrix1Row mat)Sets all the diagonal elements equal to one and everything else equal to zero.static booleansolve(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj x)Solves for x in the following equation:
A*x = bstatic booleansolveSPD(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj x)Linear solver for systems which are symmetric positive definite.
A*x = bstatic <T extends org.ejml.data.DMatrixD1>
Tsubtract(double val, T a, T output)Performs matrix scalar subtraction:
c = val - a
cij = val - aijstatic <T extends org.ejml.data.DMatrixD1>
Tsubtract(T a, double val, T output)Performs matrix scalar subtraction:
c = a - val
cij = aij - valstatic <T extends org.ejml.data.DMatrixD1>
Tsubtract(T a, T b, T output)Performs the following subtraction operation:
c = a - b
cij = aij - bijstatic voidsubtractEquals(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs the following subtraction operation:
a = a - b
aij = aij - bijstatic org.ejml.data.DMatrixRMajsumCols(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Computes the sum of each column in the input matrix and returns the results in a vector:
bj = sum(i=1:m ; aij)static org.ejml.data.DMatrixRMajsumRows(org.ejml.data.DMatrixRMaj input, @Nullable org.ejml.data.DMatrixRMaj output)Computes the sum of each row in the input matrix and returns the results in a vector:
bj = sum(i=1:n ; aji)static voidsymmLowerToFull(org.ejml.data.DMatrixRMaj A)Given a symmetric matrix which is represented by a lower triangular matrix convert it back into a full symmetric matrix.static voidsymmUpperToFull(org.ejml.data.DMatrixRMaj A)Given a symmetric matrix which is represented by a lower triangular matrix convert it back into a full symmetric matrix.static doubletrace(org.ejml.data.DMatrix1Row a)This computes the trace of the matrix:
trace = ∑i=1:n { aii }
where n = min(numRows,numCols)static voidtranspose(org.ejml.data.DMatrixRMaj mat)Performs an "in-place" transpose.static org.ejml.data.DMatrixRMajtranspose(org.ejml.data.DMatrixRMaj A, @Nullable org.ejml.data.DMatrixRMaj A_tran)Transposes matrix 'a' and stores the results in 'b':
bij = aji
where 'b' is the transpose of 'a'.
-
Constructor Details
-
CommonOps_DDRM
public CommonOps_DDRM()
-
-
Method Details
-
mult
public static <T extends org.ejml.data.DMatrix1Row> T mult(T a, T b, @Nullable T output)Performs the following operation:
c = a * b
cij = ∑k=1:n { aik * bkj}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
mult
public static <T extends org.ejml.data.DMatrix1Row> T mult(double alpha, T a, T b, @Nullable T output)Performs the following operation:
c = α * a * b
cij = α ∑k=1:n { * aik * bkj}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransA
public static <T extends org.ejml.data.DMatrix1Row> T multTransA(T a, T b, @Nullable T output)Performs the following operation:
c = aT * b
cij = ∑k=1:n { aki * bkj}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransA
public static <T extends org.ejml.data.DMatrix1Row> T multTransA(double alpha, T a, T b, @Nullable T output)Performs the following operation:
c = α * aT * b
cij = α ∑k=1:n { aki * bkj}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransB
public static <T extends org.ejml.data.DMatrix1Row> T multTransB(T a, T b, @Nullable T output)Performs the following operation:
c = a * bT
cij = ∑k=1:n { aik * bjk}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransB
public static <T extends org.ejml.data.DMatrix1Row> T multTransB(double alpha, T a, T b, @Nullable T output)Performs the following operation:
c = α * a * bT
cij = α ∑k=1:n { aik * bjk}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransAB
public static <T extends org.ejml.data.DMatrix1Row> T multTransAB(T a, T b, @Nullable T output)Performs the following operation:
c = aT * bT
cij = ∑k=1:n { aki * bjk}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
multTransAB
public static <T extends org.ejml.data.DMatrix1Row> T multTransAB(double alpha, T a, T b, @Nullable T output)Performs the following operation:
c = α * aT * bT
cij = α ∑k=1:n { aki * bjk}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
dot
public static double dot(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Computes the dot product or inner product between two vectors. If the two vectors are columns vectors then it is defined as:
dot(a,b) = a<sup>T</sup> * b
If the vectors are column or row or both is ignored by this function.- Parameters:
a- Vectorb- Vector- Returns:
- Dot product of the two vectors
-
multInner
public static <T extends org.ejml.data.DMatrix1Row> T multInner(T a, @Nullable T output)Computes the matrix multiplication inner product:
c = aT * a
cij = ∑k=1:n { aki * akj}Is faster than using a generic matrix multiplication by taking advantage of symmetry. For vectors there is an even faster option, see
VectorVectorMult_DDRM.innerProd(DMatrixD1, DMatrixD1)- Parameters:
a- The matrix being multiplied. Not modified.output- Where the results of the operation are stored. Modified.
-
multOuter
public static <T extends org.ejml.data.DMatrix1Row> T multOuter(T a, @Nullable T output)Computes the matrix multiplication outer product:
c = a * aT
cij = ∑k=1:m { aik * ajk}Is faster than using a generic matrix multiplication by taking advantage of symmetry.
- Parameters:
a- The matrix being multiplied. Not modified.output- Where the results of the operation are stored. Modified.
-
multAdd
public static void multAdd(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + a * b
cij = cij + ∑k=1:n { aik * bkj}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAdd
public static void multAdd(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * a * b
cij = cij + α * ∑k=1:n { aik * bkj}- Parameters:
alpha- scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAddTransA
public static void multAddTransA(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + aT * b
cij = cij + ∑k=1:n { aki * bkj}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAddTransA
public static void multAddTransA(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * aT * b
cij =cij + α * ∑k=1:n { aki * bkj}- Parameters:
alpha- scaling factora- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAddTransB
public static void multAddTransB(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + a * bT
cij = cij + ∑k=1:n { aik * bjk}- Parameters:
a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAddTransB
public static void multAddTransB(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * a * bT
cij = cij + α * ∑k=1:n { aik * bjk}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not modified.b- The right matrix in the multiplication operation. Not modified.c- Where the results of the operation are stored. Modified.
-
multAddTransAB
public static void multAddTransAB(org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + aT * bT
cij = cij + ∑k=1:n { aki * bjk}- Parameters:
a- The left matrix in the multiplication operation. Not Modified.b- The right matrix in the multiplication operation. Not Modified.c- Where the results of the operation are stored. Modified.
-
multAddTransAB
public static void multAddTransAB(double alpha, org.ejml.data.DMatrix1Row a, org.ejml.data.DMatrix1Row b, org.ejml.data.DMatrix1Row c)Performs the following operation:
c = c + α * aT * bT
cij = cij + α * ∑k=1:n { aki * bjk}- Parameters:
alpha- Scaling factor.a- The left matrix in the multiplication operation. Not Modified.b- The right matrix in the multiplication operation. Not Modified.c- Where the results of the operation are stored. Modified.
-
solve
public static boolean solve(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj x)Solves for x in the following equation:
A*x = bIf the system could not be solved then false is returned. If it returns true that just means the algorithm finished operating, but the results could still be bad because 'A' is singular or nearly singular.
If repeat calls to solve are being made then one should consider using
LinearSolverFactory_DDRMinstead.It is ok for 'b' and 'x' to be the same matrix.
- Parameters:
a- A matrix that is m by n. Not modified.b- A matrix that is n by k. Not modified.x- A matrix that is m by k. Modified.- Returns:
- true if it could invert the matrix false if it could not.
-
solveSPD
public static boolean solveSPD(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj x)Linear solver for systems which are symmetric positive definite.
A*x = b- Parameters:
A- A matrix that is n by n and SPD. Not modified.b- A matrix that is n by k. Not modified.x- A matrix that is n by k. Modified.- Returns:
- true if it could invert the matrix false if it could not.
- See Also:
UnrolledCholesky_DDRM,LinearSolverFactory_DDRM
-
transpose
public static void transpose(org.ejml.data.DMatrixRMaj mat)Performs an "in-place" transpose.
For square matrices the transpose is truly in-place and does not require additional memory. For non-square matrices, internally a temporary matrix is declared and
transpose(DMatrixRMaj, DMatrixRMaj)is invoked.- Parameters:
mat- The matrix that is to be transposed. Modified.
-
transpose
public static org.ejml.data.DMatrixRMaj transpose(org.ejml.data.DMatrixRMaj A, @Nullable @Nullable org.ejml.data.DMatrixRMaj A_tran)Transposes matrix 'a' and stores the results in 'b':
bij = aji
where 'b' is the transpose of 'a'.- Parameters:
A- The original matrix. Not modified.A_tran- Where the transpose is stored. If null a new matrix is created. Modified.- Returns:
- The transposed matrix.
-
trace
public static double trace(org.ejml.data.DMatrix1Row a)This computes the trace of the matrix:
trace = ∑i=1:n { aii }
where n = min(numRows,numCols)- Parameters:
a- A square matrix. Not modified.
-
det
public static double det(org.ejml.data.DMatrixRMaj mat)Returns the determinant of the matrix. If the inverse of the matrix is also needed, then usingLUDecomposition_F64directly (or any similar algorithm) can be more efficient.- Parameters:
mat- The matrix whose determinant is to be computed. Not modified.- Returns:
- The determinant.
-
invert
public static boolean invert(org.ejml.data.DMatrixRMaj mat)Performs a matrix inversion operation on the specified matrix and stores the results in the same matrix.
a = a-1If the algorithm could not invert the matrix then false is returned. If it returns true that just means the algorithm finished. The results could still be bad because the matrix is singular or nearly singular.
- Parameters:
mat- The matrix that is to be inverted. Results are stored here. Modified.- Returns:
- true if it could invert the matrix false if it could not.
-
invert
public static boolean invert(org.ejml.data.DMatrixRMaj mat, org.ejml.data.DMatrixRMaj result)Performs a matrix inversion operation that does not modify the original and stores the results in another matrix. The two matrices must have the same dimension.
b = a-1If the algorithm could not invert the matrix then false is returned. If it returns true that just means the algorithm finished. The results could still be bad because the matrix is singular or nearly singular.
For medium to large matrices there might be a slight performance boost to using
LinearSolverFactory_DDRMinstead.- Parameters:
mat- The matrix that is to be inverted. Not modified.result- Where the inverse matrix is stored. Modified.- Returns:
- true if it could invert the matrix false if it could not.
-
invertSPD
public static boolean invertSPD(org.ejml.data.DMatrixRMaj mat, org.ejml.data.DMatrixRMaj result)Matrix inverse for symmetric positive definite matrices. For small matrices an unrolled cholesky is used. Otherwise a standard decomposition.- Parameters:
mat- (Input) SPD matrixresult- (Output) Inverted matrix.- Returns:
- true if it could invert the matrix false if it could not.
- See Also:
UnrolledCholesky_DDRM,LinearSolverFactory_DDRM.chol(int)
-
pinv
public static void pinv(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj invA)Computes the Moore-Penrose pseudo-inverse:
pinv(A) = (ATA)-1 AT
or
pinv(A) = AT(AAT)-1
Internally it uses
SolvePseudoInverseSvd_DDRMto compute the inverse. For performance reasons, this should only be used when a matrix is singular or nearly singular.- Parameters:
A- A m by n Matrix. Not modified.invA- Where the computed pseudo inverse is stored. n by m. Modified.
-
columnsToVector
public static org.ejml.data.DMatrixRMaj[] columnsToVector(org.ejml.data.DMatrixRMaj A, @Nullable @Nullable org.ejml.data.DMatrixRMaj[] v)Converts the columns in a matrix into a set of vectors.- Parameters:
A- Matrix. Not modified.- Returns:
- An array of vectors.
-
rowsToVector
public static org.ejml.data.DMatrixRMaj[] rowsToVector(org.ejml.data.DMatrixRMaj A, @Nullable @Nullable org.ejml.data.DMatrixRMaj[] v)Converts the rows in a matrix into a set of vectors.- Parameters:
A- Matrix. Not modified.- Returns:
- An array of vectors.
-
setIdentity
public static void setIdentity(org.ejml.data.DMatrix1Row mat)Sets all the diagonal elements equal to one and everything else equal to zero. If this is a square matrix then it will be an identity matrix.- Parameters:
mat- A square matrix.- See Also:
identity(int)
-
identity
public static org.ejml.data.DMatrixRMaj identity(int width)Creates an identity matrix of the specified size.
aij = 0 if i ≠ j
aij = 1 if i = j
- Parameters:
width- The width and height of the identity matrix.- Returns:
- A new instance of an identity matrix.
-
identity
public static org.ejml.data.DMatrixRMaj identity(int numRows, int numCols)Creates a rectangular matrix which is zero except along the diagonals.- Parameters:
numRows- Number of rows in the matrix.numCols- NUmber of columns in the matrix.- Returns:
- A matrix with diagonal elements equal to one.
-
diag
public static org.ejml.data.DMatrixRMaj diag(double... diagEl)Creates a new square matrix whose diagonal elements are specified by diagEl and all the other elements are zero.
aij = 0 if i ≤ j
aij = diag[i] if i = j
- Parameters:
diagEl- Contains the values of the diagonal elements of the resulting matrix.- Returns:
- A new matrix.
- See Also:
diagR(int, int, double...)
-
diag
public static org.ejml.data.DMatrixRMaj diag(@Nullable @Nullable org.ejml.data.DMatrixRMaj ret, int width, double... diagEl)- See Also:
diag(double...)
-
diagR
public static org.ejml.data.DMatrixRMaj diagR(int numRows, int numCols, double... diagEl)Creates a new rectangular matrix whose diagonal elements are specified by diagEl and all the other elements are zero.
aij = 0 if i ≤ j
aij = diag[i] if i = j
- Parameters:
numRows- Number of rows in the matrix.numCols- Number of columns in the matrix.diagEl- Contains the values of the diagonal elements of the resulting matrix.- Returns:
- A new matrix.
- See Also:
diag(double...)
-
kron
public static org.ejml.data.DMatrixRMaj kron(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, @Nullable @Nullable org.ejml.data.DMatrixRMaj C)The Kronecker product of two matrices is defined as:
Cij = aijB
where Cij is a sub matrix inside of C ∈ ℜ m*k × n*l, A ∈ ℜ m × n, and B ∈ ℜ k × l.- Parameters:
A- The left matrix in the operation. Not modified.B- The right matrix in the operation. Not modified.C- Where the results of the operation are stored. Nullable. Modified.
-
extract
public static void extract(org.ejml.data.DMatrix src, int srcY0, int srcY1, int srcX0, int srcX1, org.ejml.data.DMatrix dst, int dstY0, int dstX0)Extracts a submatrix from 'src' and inserts it in a submatrix in 'dst'.
si-y0 , j-x0 = oij for all y0 ≤ i < y1 and x0 ≤ j < x1
where 'sij' is an element in the submatrix and 'oij' is an element in the original matrix.- Parameters:
src- The original matrix which is to be copied. Not modified.srcX0- Start column.srcX1- Stop column+1.srcY0- Start row.srcY1- Stop row+1.dst- Where the submatrix are stored. Modified.dstY0- Start row in dst.dstX0- start column in dst.
-
extract
public static void extract(org.ejml.data.DMatrix src, int srcY0, int srcY1, int srcX0, int srcX1, org.ejml.data.DMatrix dst)Extract where the destination is reshaped to match the extracted region- Parameters:
src- The original matrix which is to be copied. Not modified.srcX0- Start column.srcX1- Stop column+1.srcY0- Start row.srcY1- Stop row+1.dst- Where the submatrix are stored. Modified.
-
extract
public static void extract(org.ejml.data.DMatrix src, int srcY0, int srcX0, org.ejml.data.DMatrix dst)Extracts a submatrix from 'src' and inserts it in a submatrix in 'dst'. Uses the shape of dst to determine the size of the matrix extracted.
- Parameters:
src- The original matrix which is to be copied. Not modified.srcY0- Start row in src.srcX0- Start column in src.dst- Where the matrix is extracted into.
-
extract
public static org.ejml.data.DMatrixRMaj extract(org.ejml.data.DMatrixRMaj src, int srcY0, int srcY1, int srcX0, int srcX1)Creates a new matrix which is the specified submatrix of 'src'
si-y0 , j-x0 = oij for all y0 ≤ i < y1 and x0 ≤ j < x1
where 'sij' is an element in the submatrix and 'oij' is an element in the original matrix.- Parameters:
src- The original matrix which is to be copied. Not modified.srcX0- Start column.srcX1- Stop column+1.srcY0- Start row.srcY1- Stop row+1.- Returns:
- Extracted submatrix.
-
extract
public static org.ejml.data.DMatrixRMaj extract(org.ejml.data.DMatrixRMaj src, int[] rows, int rowsSize, int[] cols, int colsSize, @Nullable @Nullable org.ejml.data.DMatrixRMaj dst)Extracts out a matrix from source given a sub matrix with arbitrary rows and columns specified in two array lists- Parameters:
src- Source matrix. Not modified.rows- array of row indexesrowsSize- maximum element in row arraycols- array of column indexescolsSize- maximum element in column arraydst- output matrix. Must be correct shape.
-
extract
public static org.ejml.data.DMatrixRMaj extract(org.ejml.data.DMatrixRMaj src, int[] indexes, int length, @Nullable @Nullable org.ejml.data.DMatrixRMaj dst)Extracts the elements from the source matrix by their 1D index.- Parameters:
src- Source matrix. Not modified.indexes- array of row indexeslength- maximum element in row arraydst- output matrix. Must be a vector of the correct length.
-
insert
public static void insert(org.ejml.data.DMatrixRMaj src, org.ejml.data.DMatrixRMaj dst, int[] rows, int rowsSize, int[] cols, int colsSize)Inserts into the specified elements of dst the source matrix.for i in len(rows): for j in len(cols): dst(rows[i],cols[j]) = src(i,j)- Parameters:
src- Source matrix. Not modified.dst- output matrix. Must be correct shape.rows- array of row indexes.rowsSize- maximum element in row arraycols- array of column indexescolsSize- maximum element in column array
-
extractDiag
public static org.ejml.data.DMatrixRMaj extractDiag(org.ejml.data.DMatrixRMaj src, @Nullable @Nullable org.ejml.data.DMatrixRMaj dst)Extracts the diagonal elements 'src' write it to the 'dst' vector. 'dst' can either be a row or column vector.
- Parameters:
src- Matrix whose diagonal elements are being extracted. Not modified.dst- A vector the results will be written into. Modified.
-
extractRow
public static org.ejml.data.DMatrixRMaj extractRow(org.ejml.data.DMatrixRMaj a, int row, @Nullable @Nullable org.ejml.data.DMatrixRMaj out)Extracts the row from a matrix.- Parameters:
a- Input matrixrow- Which row is to be extractedout- output. Storage for the extracted row. If null then a new vector will be returned.- Returns:
- The extracted row.
-
extractColumn
public static org.ejml.data.DMatrixRMaj extractColumn(org.ejml.data.DMatrixRMaj a, int column, @Nullable @Nullable org.ejml.data.DMatrixRMaj out)Extracts the column from a matrix.- Parameters:
a- Input matrixcolumn- Which column is to be extractedout- output. Storage for the extracted column. If null then a new vector will be returned.- Returns:
- The extracted column.
-
removeColumns
public static void removeColumns(org.ejml.data.DMatrixRMaj A, int col0, int col1)Removes columns from the matrix.- Parameters:
A- Matrix. Modifiedcol0- First columncol1- Last column, inclusive.
-
insert
public static void insert(org.ejml.data.DMatrix src, org.ejml.data.DMatrix dest, int destY0, int destX0)Inserts matrix 'src' into matrix 'dest' with the (0,0) of src at (row,col) in dest. This is equivalent to calling extract(src,0,src.numRows,0,src.numCols,dest,destY0,destX0).- Parameters:
src- matrix that is being copied into dest. Not modified.dest- Where src is being copied into. Modified.destY0- Start row for the copy into dest.destX0- Start column for the copy into dest.
-
elementMax
public static double elementMax(org.ejml.data.DMatrixD1 a)Returns the value of the element in the matrix that has the largest value.
Max{ aij } for all i and j
- Parameters:
a- A matrix. Not modified.- Returns:
- The max element value of the matrix.
-
elementMax
public static double elementMax(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the value of the element in the matrix that has the largest value.
Max{ aij } for all i and j
- Parameters:
a- A matrix. Not modified.loc- (Output) Location of selected element.- Returns:
- The max element value of the matrix.
-
elementMaxAbs
public static double elementMaxAbs(org.ejml.data.DMatrixD1 a)Returns the absolute value of the element in the matrix that has the largest absolute value.
Max{ |aij| } for all i and j
- Parameters:
a- A matrix. Not modified.- Returns:
- The max abs element value of the matrix.
-
elementMaxAbs
public static double elementMaxAbs(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the absolute value of the element in the matrix that has the largest absolute value.
Max{ |aij| } for all i and j
- Parameters:
a- A matrix. Not modified.loc- (Output) Location of element element.- Returns:
- The max abs element value of the matrix.
-
elementMin
public static double elementMin(org.ejml.data.DMatrixD1 a)Returns the value of the element in the matrix that has the minimum value.
Min{ aij } for all i and j
- Parameters:
a- A matrix. Not modified.- Returns:
- The value of element in the matrix with the minimum value.
-
elementMin
public static double elementMin(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the value of the element in the matrix that has the minimum value.
Min{ aij } for all i and j
- Parameters:
a- A matrix. Not modified.loc- (Output) Location of selected element.- Returns:
- The value of element in the matrix with the minimum value.
-
elementMinAbs
public static double elementMinAbs(org.ejml.data.DMatrixD1 a)Returns the absolute value of the element in the matrix that has the smallest absolute value.
Min{ |aij| } for all i and j
- Parameters:
a- A matrix. Not modified.- Returns:
- The max element value of the matrix.
-
elementMinAbs
public static double elementMinAbs(org.ejml.data.DMatrixD1 a, org.ejml.data.ElementLocation loc)Returns the absolute value of the element in the matrix that has the smallest absolute value.
Min{ |aij| } for all i and j
- Parameters:
a- (Input) A matrix. Not modified.loc- (Output) Location of selected element.- Returns:
- The max element value of the matrix.
-
elementMult
public static void elementMult(org.ejml.data.DMatrixD1 A, org.ejml.data.DMatrixD1 B)Performs the an element by element multiplication operation:
aij = aij * bij
- Parameters:
A- The left matrix in the multiplication operation. Modified.B- The right matrix in the multiplication operation. Not modified.
-
elementMult
public static <T extends org.ejml.data.DMatrixD1> T elementMult(T A, T B, @Nullable T output)Performs the an element by element multiplication operation:
cij = aij * bij
- Parameters:
A- The left matrix in the multiplication operation. Not modified.B- The right matrix in the multiplication operation. Not modified.output- Where the results of the operation are stored. Modified.
-
elementDiv
public static void elementDiv(org.ejml.data.DMatrixD1 A, org.ejml.data.DMatrixD1 B)Performs the an element by element division operation:
aij = aij / bij
- Parameters:
A- The left matrix in the division operation. Modified.B- The right matrix in the division operation. Not modified.
-
elementDiv
public static <T extends org.ejml.data.DMatrixD1> T elementDiv(T A, T B, @Nullable T output)Performs the an element by element division operation:
cij = aij / bij
- Parameters:
A- The left matrix in the division operation. Not modified.B- The right matrix in the division operation. Not modified.output- Where the results of the operation are stored. Modified.
-
elementSum
public static double elementSum(org.ejml.data.DMatrixD1 mat)Computes the sum of all the elements in the matrix:
sum(i=1:m , j=1:n ; aij)- Parameters:
mat- An m by n matrix. Not modified.- Returns:
- The sum of the elements.
-
elementSumAbs
public static double elementSumAbs(org.ejml.data.DMatrixD1 mat)Computes the sum of the absolute value all the elements in the matrix:
sum(i=1:m , j=1:n ; |aij|)- Parameters:
mat- An m by n matrix. Not modified.- Returns:
- The sum of the absolute value of each element.
-
elementPower
public static <T extends org.ejml.data.DMatrixD1> T elementPower(T A, T B, @Nullable T output)Element-wise power operation
cij = aij ^ bij- Parameters:
A- left sideB- right sideoutput- output (modified)
-
elementPower
public static <T extends org.ejml.data.DMatrixD1> T elementPower(double a, T B, @Nullable T output)Element-wise power operation
cij = a ^ bij- Parameters:
a- left scalarB- right sideoutput- output (modified)
-
elementPower
public static <T extends org.ejml.data.DMatrixD1> T elementPower(T A, double b, @Nullable T output)Element-wise power operation
cij = aij ^ b- Parameters:
A- left sideb- right scalaroutput- output (modified)
-
elementLog
public static <T extends org.ejml.data.DMatrixD1> T elementLog(T A, @Nullable T output)Element-wise log operation
cij = Math.log(aij)- Parameters:
A- (input) A matrixoutput- (input/output) Storage for results. can be null. (modified)- Returns:
- The results
-
elementExp
public static <T extends org.ejml.data.DMatrixD1> T elementExp(T A, @Nullable T output)Element-wise exp operation
cij = Math.exp(aij)- Parameters:
A- (input) A matrixoutput- (input/output) Storage for results. can be null. (modified)- Returns:
- The results
-
multRows
public static void multRows(double[] values, org.ejml.data.DMatrixRMaj A)Multiplies every element in row i by value[i].- Parameters:
values- array. Not modified.A- Matrix. Modified.
-
divideRows
public static void divideRows(double[] values, org.ejml.data.DMatrixRMaj A)Divides every element in row i by value[i].- Parameters:
values- array. Not modified.A- Matrix. Modified.
-
multCols
public static void multCols(org.ejml.data.DMatrixRMaj A, double[] values)Multiplies every element in column i by value[i].- Parameters:
A- Matrix. Modified.values- array. Not modified.
-
divideCols
public static void divideCols(org.ejml.data.DMatrixRMaj A, double[] values)Divides every element in column i by value[i].- Parameters:
A- Matrix. Modified.values- array. Not modified.
-
divideRowsCols
public static void divideRowsCols(double[] diagA, int offsetA, org.ejml.data.DMatrixRMaj B, double[] diagC, int offsetC)Equivalent to multiplying a matrix B by the inverse of two diagonal matrices. B = inv(A)*B*inv(C), where A=diag(a) and C=diag(c).- Parameters:
diagA- Array of length offsteA + B.numRowsoffsetA- First index in AB- Rectangular matrixdiagC- Array of length indexC + B.numColsoffsetC- First index in C
-
sumRows
public static org.ejml.data.DMatrixRMaj sumRows(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Computes the sum of each row in the input matrix and returns the results in a vector:
bj = sum(i=1:n ; aji)- Parameters:
input- INput matrix whose rows are summed.output- Optional storage for output. Reshaped into a column. Modified.- Returns:
- Vector containing the sum of each row in the input.
-
minRows
public static org.ejml.data.DMatrixRMaj minRows(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along each row in the input matrix and returns the results in a vector:
bj = min(i=1:n ; aji)- Parameters:
input- Input matrixoutput- Optional storage for output. Reshaped into a column. Modified.- Returns:
- Vector containing the sum of each row in the input.
-
maxRows
public static org.ejml.data.DMatrixRMaj maxRows(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the maximum value along each row in the input matrix and returns the results in a vector:
bj = max(i=1:n ; aji)- Parameters:
input- Input matrixoutput- Optional storage for output. Reshaped into a column. Modified.- Returns:
- Vector containing the sum of each row in the input.
-
sumCols
public static org.ejml.data.DMatrixRMaj sumCols(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Computes the sum of each column in the input matrix and returns the results in a vector:
bj = sum(i=1:m ; aij)- Parameters:
input- Input matrixoutput- Optional storage for output. Reshaped into a row vector. Modified.- Returns:
- Vector containing the sum of each column
-
minCols
public static org.ejml.data.DMatrixRMaj minCols(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along column in the input matrix and returns the results in a vector:
bj = min(i=1:m ; aij)- Parameters:
input- Input matrixoutput- Optional storage for output. Reshaped into a row vector. Modified.- Returns:
- Vector containing the minimum of each column
-
maxCols
public static org.ejml.data.DMatrixRMaj maxCols(org.ejml.data.DMatrixRMaj input, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Finds the element with the minimum value along column in the input matrix and returns the results in a vector:
bj = min(i=1:m ; aij)- Parameters:
input- Input matrixoutput- Optional storage for output. Reshaped into a row vector. Modified.- Returns:
- Vector containing the maximum of each column
-
addEquals
public static void addEquals(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs the following operation:
a = a + b
aij = aij + bij
- Parameters:
a- (input/output) A Matrix. Modified.b- (input) A Matrix. Not modified.
-
addEquals
public static void addEquals(org.ejml.data.DMatrixD1 a, double beta, org.ejml.data.DMatrixD1 b)Performs the following operation:
a = a + β * b
aij = aij + β * bij- Parameters:
beta- The number that matrix 'b' is multiplied by.a- (input/output) A Matrix. Modified.b- (input) A Matrix. Not modified.
-
add
public static <T extends org.ejml.data.DMatrixD1> T add(T a, T b, @Nullable T output)Performs the following operation:
c = a + b
cij = aij + bij
Matrix C can be the same instance as Matrix A and/or B.
- Parameters:
a- A Matrix. Not modified.b- A Matrix. Not modified.output- (output) A Matrix where the results are stored. Can be null. Modified.- Returns:
- The results.
-
add
public static <T extends org.ejml.data.DMatrixD1> T add(T a, double beta, T b, @Nullable T output)Performs the following operation:
c = a + β * b
cij = aij + β * bij
Matrix C can be the same instance as Matrix A and/or B.
- Parameters:
a- A Matrix. Not modified.beta- Scaling factor for matrix b.b- A Matrix. Not modified.output- (output) A Matrix where the results are stored. Can be null. Modified.- Returns:
- The results.
-
add
public static <T extends org.ejml.data.DMatrixD1> T add(double alpha, T a, double beta, T b, @Nullable T output)Performs the following operation:
c = α * a + β * b
cij = α * aij + β * bij
Matrix C can be the same instance as Matrix A and/or B.
- Parameters:
alpha- A scaling factor for matrix a.a- A Matrix. Not modified.beta- A scaling factor for matrix b.b- A Matrix. Not modified.output- (output) A Matrix where the results are stored. Can be null. Modified.- Returns:
- The results.
-
add
public static <T extends org.ejml.data.DMatrixD1> T add(double alpha, T a, T b, T output)Performs the following operation:
c = α * a + b
cij = α * aij + bij
Matrix C can be the same instance as Matrix A and/or B.
- Parameters:
alpha- A scaling factor for matrix a.a- A Matrix. Not modified.b- A Matrix. Not modified.output- (output) A Matrix where the results are stored. Can be null. Modified.- Returns:
- The results.
-
add
public static void add(org.ejml.data.DMatrixD1 a, double val)Performs an in-place scalar addition:
a = a + val
aij = aij + val
- Parameters:
a- A matrix. Modified.val- The value that's added to each element.
-
add
public static <T extends org.ejml.data.DMatrixD1> T add(T a, double val, T output)Performs scalar addition:
c = a + val
cij = aij + val
- Parameters:
a- A matrix. Not modified.val- The value that's added to each element.output- (output) Storage for results. Can be null. Modified.- Returns:
- The resulting matrix
-
subtract
public static <T extends org.ejml.data.DMatrixD1> T subtract(T a, double val, @Nullable T output)Performs matrix scalar subtraction:
c = a - val
cij = aij - val
- Parameters:
a- (input) A matrix. Not modified.val- (input) The value that's subtracted to each element.output- (output) Storage for results. Can be null. Modified.- Returns:
- The resulting matrix
-
subtract
public static <T extends org.ejml.data.DMatrixD1> T subtract(double val, T a, @Nullable T output)Performs matrix scalar subtraction:
c = val - a
cij = val - aij
- Parameters:
val- (input) The value that's subtracted to each element.a- (input) A matrix. Not modified.output- (output) Storage for results. Can be null. Modified.- Returns:
- The resulting matrix
-
subtractEquals
public static void subtractEquals(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs the following subtraction operation:
a = a - b
aij = aij - bij- Parameters:
a- (input) A Matrix. Modified.b- (input) A Matrix. Not modified.
-
subtract
public static <T extends org.ejml.data.DMatrixD1> T subtract(T a, T b, @Nullable T output)Performs the following subtraction operation:
c = a - b
cij = aij - bijMatrix C can be the same instance as Matrix A and/or B.
- Parameters:
a- (input) A Matrix. Not modified.b- (input) A Matrix. Not modified.output- (output) A Matrix. Can be null. Modified.- Returns:
- The resulting matrix
-
scale
public static void scale(double alpha, org.ejml.data.DMatrixD1 a)Performs an in-place element by element scalar multiplication.
aij = α*aij- Parameters:
a- The matrix that is to be scaled. Modified.alpha- the amount each element is multiplied by.
-
scale
public static void scale(double alpha, org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 b)Performs an element by element scalar multiplication.
bij = α*aij- Parameters:
alpha- the amount each element is multiplied by.a- The matrix that is to be scaled. Not modified.b- Where the scaled matrix is stored. Modified.
-
scaleRow
public static void scaleRow(double alpha, org.ejml.data.DMatrixRMaj A, int row)In-place scaling of a row in A- Parameters:
alpha- scale factorA- matrixrow- which row in A
-
scaleCol
public static void scaleCol(double alpha, org.ejml.data.DMatrixRMaj A, int col)In-place scaling of a column in A- Parameters:
alpha- scale factorA- matrixcol- which row in A
-
divide
public static void divide(double alpha, org.ejml.data.DMatrixD1 a)Performs an in-place element by element scalar division with the scalar on top.
aij = α/aij- Parameters:
a- (input/output) The matrix whose elements are divide the scalar. Modified.alpha- top value in division
-
divide
public static void divide(org.ejml.data.DMatrixD1 a, double alpha)Performs an in-place element by element scalar division with the scalar on bottom.
aij = aij/α- Parameters:
a- (input/output) The matrix whose elements are to be divided. Modified.alpha- the amount each element is divided by.
-
divide
public static <T extends org.ejml.data.DMatrixD1> T divide(double alpha, T input, T output)Performs an element by element scalar division with the scalar on top.
bij = α/aij- Parameters:
alpha- The numerator.input- The matrix whose elements are the divisor. Not modified.output- Where the results are stored. Modified. Can be null.- Returns:
- The resulting matrix
-
divide
public static <T extends org.ejml.data.DMatrixD1> T divide(T input, double alpha, @Nullable T output)Performs an element by element scalar division with the scalar on botton.
bij = aij /α- Parameters:
input- The matrix whose elements are to be divided. Not modified.alpha- the amount each element is divided by.output- Where the results are stored. Modified. Can be null.- Returns:
- The resulting matrix
-
changeSign
public static void changeSign(org.ejml.data.DMatrixD1 a)Changes the sign of every element in the matrix.
aij = -aij- Parameters:
a- A matrix. Modified.
-
changeSign
public static <T extends org.ejml.data.DMatrixD1> T changeSign(T input, @Nullable T output)Changes the sign of every element in the matrix.
outputij = -inputij- Parameters:
input- A matrix. Modified.
-
fill
public static void fill(org.ejml.data.DMatrixD1 a, double value)Sets every element in the matrix to the specified value.
aij = value- Parameters:
a- A matrix whose elements are about to be set. Modified.value- The value each element will have.
-
rref
public static org.ejml.data.DMatrixRMaj rref(org.ejml.data.DMatrixRMaj A, int numUnknowns, @Nullable @Nullable org.ejml.data.DMatrixRMaj reduced)Puts the augmented system matrix into reduced row echelon form (RREF) using Gauss-Jordan elimination with row (partial) pivots. A matrix is said to be in RREF is the following conditions are true:
- If a row has non-zero entries, then the first non-zero entry is 1. This is known as the leading one.
- If a column contains a leading one then all other entries in that column are zero.
- If a row contains a leading 1, then each row above contains a leading 1 further to the left.
[1] Page 19 in, Otter Bretscherm "Linear Algebra with Applications" Prentice-Hall Inc, 1997
- Parameters:
A- Input matrix. Unmodified.numUnknowns- Number of unknowns/columns that are reduced. Set to -1 to default to Math.min(A.numRows,A.numCols), which works for most systems.reduced- Storage for reduced echelon matrix. If null then a new matrix is returned. Modified.- Returns:
- Reduced echelon form of A
- See Also:
RrefGaussJordanRowPivot_DDRM
-
elementLessThan
public static org.ejml.data.BMatrixRMaj elementLessThan(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the > operator to each element in A. Results are stored in a boolean matrix.- Parameters:
A- Input matrxvalue- value each element is compared againstoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elementLessThanOrEqual
public static org.ejml.data.BMatrixRMaj elementLessThanOrEqual(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the ≥ operator to each element in A. Results are stored in a boolean matrix.- Parameters:
A- Input matrixvalue- value each element is compared againstoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elementMoreThan
public static org.ejml.data.BMatrixRMaj elementMoreThan(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the > operator to each element in A. Results are stored in a boolean matrix.- Parameters:
A- Input matrixvalue- value each element is compared againstoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elementMoreThanOrEqual
public static org.ejml.data.BMatrixRMaj elementMoreThanOrEqual(org.ejml.data.DMatrixRMaj A, double value, org.ejml.data.BMatrixRMaj output)Applies the ≥ operator to each element in A. Results are stored in a boolean matrix.- Parameters:
A- Input matrixvalue- value each element is compared againstoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elementLessThan
public static org.ejml.data.BMatrixRMaj elementLessThan(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, org.ejml.data.BMatrixRMaj output)Applies the < operator to each element in A. Results are stored in a boolean matrix.- Parameters:
A- Input matrixB- Input matrixoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elementLessThanOrEqual
public static org.ejml.data.BMatrixRMaj elementLessThanOrEqual(org.ejml.data.DMatrixRMaj A, org.ejml.data.DMatrixRMaj B, org.ejml.data.BMatrixRMaj output)Applies the A ≤ B operator to each element. Results are stored in a boolean matrix.- Parameters:
A- Input matrixB- Input matrixoutput- (Optional) Storage for results. Can be null. Is reshaped.- Returns:
- Boolean matrix with results
-
elements
public static org.ejml.data.DMatrixRMaj elements(org.ejml.data.DMatrixRMaj A, org.ejml.data.BMatrixRMaj marked, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)Returns a row matrix which contains all the elements in A which are flagged as true in 'marked'- Parameters:
A- Input matrixmarked- Input matrix marking elements in Aoutput- Storage for output row vector. Can be null. Will be reshaped.- Returns:
- Row vector with marked elements
-
countTrue
public static int countTrue(org.ejml.data.BMatrixRMaj A)Counts the number of elements in A which are true- Parameters:
A- input matrix- Returns:
- number of true elements
-
concatColumns
public static org.ejml.data.DMatrixRMaj concatColumns(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)output = [a , b] -
concatColumnsMulti
public static org.ejml.data.DMatrixRMaj concatColumnsMulti(org.ejml.data.DMatrixRMaj... m)Concatinates all the matrices together along their columns. If the rows do not match the upper elements are set to zero.
A = [ m[0] , ... , m[n-1] ]- Parameters:
m- Set of matrices- Returns:
- Resulting matrix
-
concatRows
public static void concatRows(org.ejml.data.DMatrixRMaj a, org.ejml.data.DMatrixRMaj b, org.ejml.data.DMatrixRMaj output)output = [a ; b] -
concatRowsMulti
public static org.ejml.data.DMatrixRMaj concatRowsMulti(org.ejml.data.DMatrixRMaj... m)Concatinates all the matrices together along their columns. If the rows do not match the upper elements are set to zero.
A = [ m[0] ; ... ; m[n-1] ]- Parameters:
m- Set of matrices- Returns:
- Resulting matrix
-
permuteRowInv
public static org.ejml.data.DMatrixRMaj permuteRowInv(int[] pinv, org.ejml.data.DMatrixRMaj input, org.ejml.data.DMatrixRMaj output)Applies the row permutation specified by the vector to the input matrix and save the results in the output matrix. output[perm[j],:] = input[j,:]- Parameters:
pinv- (Input) Inverse permutation vector. Specifies new order of the rows.input- (Input) Matrix which is to be permutedoutput- (Output) Matrix which has the permutation stored in it. Is reshaped.
-
abs
public static void abs(org.ejml.data.DMatrixD1 a, org.ejml.data.DMatrixD1 c)Performs absolute value of a matrix:
c = abs(a)
cij = abs(aij)- Parameters:
a- A matrix. Not modified.c- A matrix. Modified.
-
abs
public static void abs(org.ejml.data.DMatrixD1 a)Performs absolute value of a matrix:
a = abs(a)
aij = abs(aij)- Parameters:
a- A matrix. Modified.
-
symmLowerToFull
public static void symmLowerToFull(org.ejml.data.DMatrixRMaj A)Given a symmetric matrix which is represented by a lower triangular matrix convert it back into a full symmetric matrix.- Parameters:
A- (Input) Lower triangular matrix (Output) symmetric matrix
-
symmUpperToFull
public static void symmUpperToFull(org.ejml.data.DMatrixRMaj A)Given a symmetric matrix which is represented by a lower triangular matrix convert it back into a full symmetric matrix.- Parameters:
A- (Input) Lower triangular matrix (Output) symmetric matrix
-
apply
public static org.ejml.data.DMatrixRMaj apply(org.ejml.data.DMatrixRMaj input, org.ejml.ops.DOperatorUnary func, @Nullable @Nullable org.ejml.data.DMatrixRMaj output)This applies a given unary function on every value stored in the matrixoutput[i,j] = func(input[i,j])
A and B can be the same instance.- Parameters:
input- (Input) input matrix. Not modifiedfunc- Unary function accepting a doubleoutput- (Output) Matrix. Can be same instance as A. Modified.- Returns:
- The output matrix
-
apply
public static org.ejml.data.DMatrixRMaj apply(org.ejml.data.DMatrixRMaj input, org.ejml.ops.DOperatorUnary func)
-