Package org.nd4j.autodiff.samediff.config

Class SDValue

java.lang.Object

org.nd4j.autodiff.samediff.config.SDValue

All Implemented Interfaces:

IDependeeGroup<INDArray>

public class SDValue
extends Object
implements IDependeeGroup<INDArray>

An SDValue represents a value that can be passed in and returned from a SameDiff graph for execution.

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field	Description
protected long	id

Method Summary

Modifier and Type	Method	Description
static SDValue	create(Collection<INDArray> inputValue)	Wrap an INDArray in a value with an SDValueType.LIST type
static SDValue	create(List<INDArray> inputValue)	Wrap an INDArray in a value with an SDValueType.LIST type
static SDValue	create(Map<String,INDArray> inputValue)	Wrap an {@link Map} in a value with an SDValueType.DICT type
static SDValue	create(INDArray inputValue)	Wrap an INDArray in a tensor with an SDValueType.TENSOR type
static SDValue	empty(SDValueType valueType, DataType dataType)	Create an empty value for the given DataType
boolean	equals(Object o)
Collection<INDArray>	getCollection()
long	getId()
List<INDArray>	getListValue()	Return an INDArray if the value type is SDValueType.TENSOR else return the list type
INDArray	getTensorValue()	Return an INDArray if the value type is SDValueType.LIST and the number of elements is 1 otherwise return the tensorValue
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

id

protected transient long id

Method Detail

getId

public long getId()

Specified by:

getId in interface IDependeeGroup<INDArray>

getCollection

public Collection<INDArray> getCollection()

Specified by:

getCollection in interface IDependeeGroup<INDArray>

empty

public static SDValue empty(SDValueType valueType,
                            DataType dataType)

Create an empty value for the given DataType

Parameters:

valueType - the value type to create SDValue for

dataType - the data type of the empty value

Returns:

an empty (Nd4j.empty(DataType) for SDValueType.TENSOR or an empty list or map for the other associated types

getTensorValue

public INDArray getTensorValue()

Return an INDArray if the value type is SDValueType.LIST and the number of elements is 1 otherwise return the tensorValue

Returns:

getListValue

public List<INDArray> getListValue()

Return an INDArray if the value type is SDValueType.TENSOR else return the list type

Returns:

create

public static SDValue create(INDArray inputValue)

Wrap an INDArray in a tensor with an SDValueType.TENSOR type

Parameters:

inputValue - the input value for the SDValue

Returns:

the created value

create

public static SDValue create(Collection<INDArray> inputValue)

Wrap an INDArray in a value with an SDValueType.LIST type

Parameters:

inputValue - the input value

Returns:

the created value

create

public static SDValue create(List<INDArray> inputValue)

Wrap an INDArray in a value with an SDValueType.LIST type

Parameters:

inputValue - the input value

Returns:

the created value

create

public static SDValue create(Map<String,INDArray> inputValue)

Wrap an {@link Map} in a value with an SDValueType.DICT type

Parameters:

inputValue - the input value

Returns:

the created value

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object