Package ai.djl.ndarray.types

Enum Class SparseFormat

java.lang.Object

java.lang.Enum<SparseFormat>

ai.djl.ndarray.types.SparseFormat

All Implemented Interfaces:

Serializable, Comparable<SparseFormat>, Constable

public enum SparseFormat
extends Enum<SparseFormat>

An enum representing Sparse matrix storage formats.

• DENSE: Stride format
• ROW_SPARSE: Row Sparse
• CSR: Compressed Sparse Row

See Also:

• Sparse Matrix Storage Formats

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
COO
CSR
DENSE
ROW_SPARSE

Method Summary

Modifier and Type	Method	Description
static SparseFormat	fromValue(int value)	Gets the SparseFormat from it's integer value.
String	getType()	Returns the SparseFormat name.
int	getValue()	Returns the integer value of this SparseFormat.
static SparseFormat	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SparseFormat[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

DENSE

public static final SparseFormat DENSE

ROW_SPARSE

public static final SparseFormat ROW_SPARSE

CSR

public static final SparseFormat CSR

COO

public static final SparseFormat COO

Method Details

values

public static SparseFormat[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SparseFormat valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

fromValue

public static SparseFormat fromValue(int value)

Gets the SparseFormat from it's integer value.

Parameters:

value - the integer value of the SparseFormat

Returns:

a SparseFormat

getType

public String getType()

Returns the SparseFormat name.

Returns:

the SparseFormat name

getValue

public int getValue()

Returns the integer value of this SparseFormat.

Returns:

the integer value of this SparseFormat