Package org.nd4j.linalg.api.ops

Interface OpContext

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

BaseOpContext

public interface OpContext
extends AutoCloseable

Method Summary

Modifier and Type	Method	Description
void	allowHelpers(boolean reallyAllow)	This method allows to enable/disable use of platform helpers within ops.
org.bytedeco.javacpp.Pointer	contextPointer()	This method returns pointer to context, to be used during native op execution
List<Boolean>	getBArguments()
List<DataType>	getDArguments()
ExecutionMode	getExecutionMode()	This method returns current execution mode for Context
List<Long>	getIArguments()
INDArray	getInputArray(int idx)
List<INDArray>	getInputArrays()	This method returns List of input arrays defined within this context
INDArray	getOutputArray(int i)
List<INDArray>	getOutputArrays()	This method returns List of output arrays defined within this context
Pair<Long,Long>	getRngStates()	This method returns RNG states, root first node second
List<Double>	getTArguments()
void	markInplace(boolean reallyInplace)	This method allows to set op as inplace
int	numBArguments()
int	numDArguments()
int	numIArguments()
int	numInputArguments()
int	numOutputArguments()
int	numTArguments()
void	purge()	This method removes all in/out arrays from this OpContext
void	setArgs(INDArray[] inputArrs, long[] iArgs, DataType[] dArgs, double[] tArgs, boolean[] bArgs)	set context arguments
void	setBArguments(boolean... arguments)	This method sets boolean arguments required for operation
void	setDArguments(DataType... arguments)	This method sets data type arguments required for operation
void	setExecutionMode(ExecutionMode mode)	This method allows to set certain execution mode
void	setIArguments(long... arguments)	This method sets integer arguments required for operation
void	setInputArray(int index, INDArray array)	This method adds INDArray as input argument for future op call
void	setInputArrays(List<INDArray> arrays)	This method sets provided arrays as input arrays
void	setInputArrays(INDArray... arrays)	This method sets provided arrays as input arrays
void	setOutputArray(int index, INDArray array)	This method adds INDArray as output for future op call
void	setOutputArrays(List<INDArray> arrays)	This method sets provided arrays as output arrays
void	setOutputArrays(INDArray... arrays)	This method sets provided arrays as output arrays
void	setRngStates(long rootState, long nodeState)	This method sets root-level seed for rng
void	setTArguments(double... arguments)	This method sets floating point arguments required for operation
void	shapeFunctionOverride(boolean reallyOverride)	This methos allows to disape outputs validation via shape function

Methods inherited from interface java.lang.AutoCloseable

close

Method Detail

setIArguments

void setIArguments(long... arguments)

This method sets integer arguments required for operation

Parameters:

arguments -

getIArguments

List<Long> getIArguments()

numIArguments

int numIArguments()

setTArguments

void setTArguments(double... arguments)

This method sets floating point arguments required for operation

Parameters:

arguments -

getTArguments

List<Double> getTArguments()

numTArguments

int numTArguments()

setDArguments

void setDArguments(DataType... arguments)

This method sets data type arguments required for operation

Parameters:

arguments -

getDArguments

List<DataType> getDArguments()

numDArguments

int numDArguments()

setBArguments

void setBArguments(boolean... arguments)

This method sets boolean arguments required for operation

Parameters:

arguments -

getBArguments

List<Boolean> getBArguments()

numBArguments

int numBArguments()

setRngStates

void setRngStates(long rootState,
                  long nodeState)

This method sets root-level seed for rng

Parameters:

seed -

getRngStates

Pair<Long,Long> getRngStates()

This method returns RNG states, root first node second

Returns:

setInputArray

void setInputArray(int index,
                   INDArray array)

This method adds INDArray as input argument for future op call

Parameters:

index -

array -

setInputArrays

void setInputArrays(List<INDArray> arrays)

This method sets provided arrays as input arrays

Parameters:

arrays -

setInputArrays

void setInputArrays(INDArray... arrays)

This method sets provided arrays as input arrays

Parameters:

arrays -

getInputArrays

List<INDArray> getInputArrays()

This method returns List of input arrays defined within this context

Returns:

numInputArguments

int numInputArguments()

getInputArray

INDArray getInputArray(int idx)

setOutputArray

void setOutputArray(int index,
                    INDArray array)

This method adds INDArray as output for future op call

Parameters:

index -

array -

setOutputArrays

void setOutputArrays(List<INDArray> arrays)

This method sets provided arrays as output arrays

Parameters:

arrays -

setOutputArrays

void setOutputArrays(INDArray... arrays)

This method sets provided arrays as output arrays

Parameters:

arrays -

getOutputArrays

List<INDArray> getOutputArrays()

This method returns List of output arrays defined within this context

Returns:

getOutputArray

INDArray getOutputArray(int i)

numOutputArguments

int numOutputArguments()

contextPointer

org.bytedeco.javacpp.Pointer contextPointer()

This method returns pointer to context, to be used during native op execution

Returns:

markInplace

void markInplace(boolean reallyInplace)

This method allows to set op as inplace

Parameters:

reallyInplace -

allowHelpers

void allowHelpers(boolean reallyAllow)

This method allows to enable/disable use of platform helpers within ops. I.e. mkldnn or cuDNN. PLEASE NOTE: default value is True

Parameters:

reallyAllow -

shapeFunctionOverride

void shapeFunctionOverride(boolean reallyOverride)

This methos allows to disape outputs validation via shape function

Parameters:

reallyOverride -

getExecutionMode

ExecutionMode getExecutionMode()

This method returns current execution mode for Context

Returns:

setExecutionMode

void setExecutionMode(ExecutionMode mode)

This method allows to set certain execution mode

Parameters:

mode -

purge

void purge()

This method removes all in/out arrays from this OpContext

setArgs

void setArgs(INDArray[] inputArrs,
             long[] iArgs,
             DataType[] dArgs,
             double[] tArgs,
             boolean[] bArgs)

set context arguments

Parameters:

inputArrs -

iArgs -

dArgs -

tArgs -

bArgs -