Package ai.djl.ndarray.types

Class DataDesc

java.lang.Object

ai.djl.ndarray.types.DataDesc

public class DataDesc
extends java.lang.Object

A data descriptor class that encapsulates information of a NDArray.

The information includes:

• Optional name of the NDArray
• Device
• Shape
• DataType
• SparseFormat

Constructor Summary

Constructors

Constructor	Description
DataDesc(Shape shape)	Constructs and initializes a DataDesc with specified Shape.
DataDesc(Shape shape, DataType dataType)	Constructs and initializes a DataDesc with specified Shape and DataType.
DataDesc(Shape shape, DataType dataType, java.lang.String name)	Constructs and initializes a DataDesc with specified Shape, DataType, name, Device and SparseFormat.
DataDesc(Shape shape, java.lang.String name)	Constructs and initializes a DataDesc with specified Shape and name.

Method Summary

Modifier and Type	Method	Description
DataType	getDataType()	Returns the DataType of the NDArray.
java.lang.String	getName()	Returns the name of the NDArray.
Shape	getShape()	Returns the Shape of the NDArray.
void	setDataType(DataType dataType)	Sets the DataType of the NDArray.
void	setName(java.lang.String name)	Sets the name of the NDArray.
void	setShape(Shape shape)	Sets the Shape of the NDArray.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

DataDesc

public DataDesc(Shape shape)

Constructs and initializes a DataDesc with specified Shape.

Parameters:

shape - the Shape of the NDArray

DataDesc

public DataDesc(Shape shape,
                java.lang.String name)

Constructs and initializes a DataDesc with specified Shape and name.

Parameters:

shape - the Shape of the NDArray

name - the name of the NDArray

DataDesc

public DataDesc(Shape shape,
                DataType dataType)

Constructs and initializes a DataDesc with specified Shape and DataType.

Parameters:

shape - the Shape of the NDArray

dataType - the DataType of the NDArray

DataDesc

public DataDesc(Shape shape,
                DataType dataType,
                java.lang.String name)

Constructs and initializes a DataDesc with specified Shape, DataType, name, Device and SparseFormat.

Parameters:

shape - the Shape of the NDArray

dataType - the DataType of the NDArray

name - the name of the NDArray

Method Detail

getName

public java.lang.String getName()

Returns the name of the NDArray.

Returns:

the name of the NDArray

setName

public void setName(java.lang.String name)

Sets the name of the NDArray.

Parameters:

name - the name of the NDArray

getShape

public Shape getShape()

Returns the Shape of the NDArray.

Returns:

the Shape of the NDArray

setShape

public void setShape(Shape shape)

Sets the Shape of the NDArray.

Parameters:

shape - the Shape of the NDArray

getDataType

public DataType getDataType()

Returns the DataType of the NDArray.

Returns:

the DataType of the NDArray

setDataType

public void setDataType(DataType dataType)

Sets the DataType of the NDArray.

Parameters:

dataType - the DataType of the NDArray

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object