Package org.ejml.sparse.csc

Class CommonOpsWithSemiRing_DSCC

java.lang.Object

org.ejml.sparse.csc.CommonOpsWithSemiRing_DSCC

public class CommonOpsWithSemiRing_DSCC
extends Object

Method Summary

Modifier and Type	Method	Description
static DMatrixSparseCSC	add(double alpha, DMatrixSparseCSC A, double beta, DMatrixSparseCSC B, @Nullable DMatrixSparseCSC output, DSemiRing semiRing, @Nullable Mask mask, @Nullable IGrowArray gw, @Nullable DGrowArray gx)	Performs matrix addition: output = αA + βB
static DMatrixSparseCSC	elementMult(DMatrixSparseCSC A, DMatrixSparseCSC B, @Nullable DMatrixSparseCSC output, DSemiRing semiRing, @Nullable Mask mask, @Nullable IGrowArray gw, @Nullable DGrowArray gx)	Performs an element-wise multiplication. output[i,j] = A[i,j]*B[i,j] All matrices must have the same shape.
static DMatrixRMaj	mult(DMatrixSparseCSC A, DMatrixRMaj B, @Nullable DMatrixRMaj output, DSemiRing semiRing)	Performs matrix multiplication.
static DMatrixSparseCSC	mult(DMatrixSparseCSC A, DMatrixSparseCSC B, @Nullable DMatrixSparseCSC output, DSemiRing semiRing)
static DMatrixSparseCSC	mult(DMatrixSparseCSC A, DMatrixSparseCSC B, @Nullable DMatrixSparseCSC output, DSemiRing semiRing, @Nullable Mask mask, @Nullable IGrowArray gw, @Nullable DGrowArray gx)	Performs matrix multiplication.
static void	multAdd(DMatrixSparseCSC A, DMatrixRMaj B, DMatrixRMaj output, DSemiRing semiRing)	output = output + A*B
static void	multAddTransA(DMatrixSparseCSC A, DMatrixRMaj B, DMatrixRMaj output, DSemiRing semiRing)	output = output + AT*B
static void	multAddTransAB(DMatrixSparseCSC A, DMatrixRMaj B, DMatrixRMaj C, DSemiRing semiRing)	C = C + AT*BT
static void	multAddTransB(DMatrixSparseCSC A, DMatrixRMaj B, DMatrixRMaj output, DSemiRing semiRing)	output = output + A*BT
static DMatrixRMaj	multTransA(DMatrixSparseCSC A, DMatrixRMaj B, @Nullable DMatrixRMaj output, DSemiRing semiRing)	Performs matrix multiplication.
static DMatrixRMaj	multTransAB(DMatrixSparseCSC A, DMatrixRMaj B, DMatrixRMaj output, DSemiRing semiRing)	Performs matrix multiplication.
static DMatrixRMaj	multTransB(DMatrixSparseCSC A, DMatrixRMaj B, @Nullable DMatrixRMaj output, DSemiRing semiRing)	Performs matrix multiplication.

Methods inherited from class java.lang.Object

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

Method Details

mult

public static DMatrixSparseCSC mult(DMatrixSparseCSC A,
 DMatrixSparseCSC B,
 @Nullable
 @Nullable DMatrixSparseCSC output,
 DSemiRing semiRing)

mult

public static DMatrixSparseCSC mult(DMatrixSparseCSC A,
 DMatrixSparseCSC B,
 @Nullable
 @Nullable DMatrixSparseCSC output,
 DSemiRing semiRing,
 @Nullable
 @Nullable Mask mask,
 @Nullable
 @Nullable IGrowArray gw,
 @Nullable
 @Nullable DGrowArray gx)

Performs matrix multiplication. output = A*B

Parameters:

A - (Input) Matrix. Not modified.

B - (Input) Matrix. Not modified.

output - (Output) Storage for results. Data length is increased if insufficient.

semiRing - Semi-Ring to define + and *

mask - (Optional) Mask for specifying which entries should be overwritten

gw - (Optional) Storage for internal workspace. Can be null.

gx - (Optional) Storage for internal workspace. Can be null.

mult

public static DMatrixRMaj mult(DMatrixSparseCSC A,
 DMatrixRMaj B,
 @Nullable
 @Nullable DMatrixRMaj output,
 DSemiRing semiRing)

Performs matrix multiplication. output = A*B

Parameters:

A - Matrix

B - Dense Matrix

semiRing - Semi-Ring to define + and *

output - Dense Matrix

multAdd

public static void multAdd(DMatrixSparseCSC A,
 DMatrixRMaj B,
 DMatrixRMaj output,
 DSemiRing semiRing)

output = output + A*B

multTransA

public static DMatrixRMaj multTransA(DMatrixSparseCSC A,
 DMatrixRMaj B,
 @Nullable
 @Nullable DMatrixRMaj output,
 DSemiRing semiRing)

Performs matrix multiplication. output = A^T*B

Parameters:

A - Matrix

B - Dense Matrix

output - Dense Matrix

semiRing - Semi-Ring to define + and *

multAddTransA

public static void multAddTransA(DMatrixSparseCSC A,
 DMatrixRMaj B,
 DMatrixRMaj output,
 DSemiRing semiRing)

output = output + A^T*B

multTransB

public static DMatrixRMaj multTransB(DMatrixSparseCSC A,
 DMatrixRMaj B,
 @Nullable
 @Nullable DMatrixRMaj output,
 DSemiRing semiRing)

Performs matrix multiplication. output = A*B^T

Parameters:

A - Matrix

B - Dense Matrix

output - Dense Matrix

semiRing - Semi-Ring to define + and *

multAddTransB

public static void multAddTransB(DMatrixSparseCSC A,
 DMatrixRMaj B,
 DMatrixRMaj output,
 DSemiRing semiRing)

output = output + A*B^T

multTransAB

public static DMatrixRMaj multTransAB(DMatrixSparseCSC A,
 DMatrixRMaj B,
 DMatrixRMaj output,
 DSemiRing semiRing)

Performs matrix multiplication. output = A^T*B^T

Parameters:

A - Matrix

B - Dense Matrix

output - Dense Matrix

semiRing - Semi-Ring to define + and *

multAddTransAB

public static void multAddTransAB(DMatrixSparseCSC A,
 DMatrixRMaj B,
 DMatrixRMaj C,
 DSemiRing semiRing)

C = C + A^T*B^T

add

public static DMatrixSparseCSC add(double alpha,
 DMatrixSparseCSC A,
 double beta,
 DMatrixSparseCSC B,
 @Nullable
 @Nullable DMatrixSparseCSC output,
 DSemiRing semiRing,
 @Nullable
 @Nullable Mask mask,
 @Nullable
 @Nullable IGrowArray gw,
 @Nullable
 @Nullable DGrowArray gx)

Performs matrix addition:
output = αA + βB

Parameters:

alpha - scalar value multiplied against A

A - Matrix

beta - scalar value multiplied against B

B - Matrix

output - (Optional) Output matrix.

semiRing - Semi-Ring to define + and *

mask - (Optional) Mask for specifying which entries should be overwritten

gw - (Optional) Storage for internal workspace. Can be null.

gx - (Optional) Storage for internal workspace. Can be null.

elementMult

public static DMatrixSparseCSC elementMult(DMatrixSparseCSC A,
 DMatrixSparseCSC B,
 @Nullable
 @Nullable DMatrixSparseCSC output,
 DSemiRing semiRing,
 @Nullable
 @Nullable Mask mask,
 @Nullable
 @Nullable IGrowArray gw,
 @Nullable
 @Nullable DGrowArray gx)

Performs an element-wise multiplication.
output[i,j] = A[i,j]*B[i,j]
All matrices must have the same shape.

Parameters:

A - (Input) Matrix.

B - (Input) Matrix

output - (Output) Matrix. data array is grown to min(A.nz_length,B.nz_length), resulting a in a large speed boost.

semiRing - Semi-Ring to define + and *

mask - (Optional) Mask for specifying which entries should be overwritten

gw - (Optional) Storage for internal workspace. Can be null.

gx - (Optional) Storage for internal workspace. Can be null.