Enum Class Layout

java.lang.Object

java.lang.Enum<Layout>

smile.deep.tensor.Layout

All Implemented Interfaces:

Serializable, Comparable<Layout>, Constable

public enum Layout
extends Enum<Layout>

The memory layout of a Tensor. The codes map to the ST_Layout values exposed by the smile_torch native API. Note that the native API currently distinguishes only strided, sparse COO, and sparse CSR layouts; the compressed-block sparse variants (BSC, BSR, CSC) are mapped to the sparse CSR code.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
SparseBSC	Sparse tensor in BSC format.
SparseBSR	Sparse tensor in BSR format.
SparseCOO	Sparse tensor in COO format.
SparseCSC	Sparse tensor in CSC format.
SparseCSR	Sparse tensor in CSR format.
Strided	Dense tensor.

Method Summary

Modifier and Type	Method	Description
int	code()	Returns the native ST_Layout code.
static Layout	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Layout[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Strided

public static final Layout Strided

Dense tensor.

SparseCOO

public static final Layout SparseCOO

Sparse tensor in COO format.

SparseBSC

public static final Layout SparseBSC

Sparse tensor in BSC format.

SparseBSR

public static final Layout SparseBSR

Sparse tensor in BSR format.

SparseCSC

public static final Layout SparseCSC

Sparse tensor in CSC format.

SparseCSR

public static final Layout SparseCSR

Sparse tensor in CSR format.

Method Details

values

public static Layout[] 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 Layout 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

code

public int code()

Returns the native ST_Layout code.

Returns:

the native ST_Layout code.