org.nd4j.linalg.api.ops

Class BaseOp

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

All Implemented Interfaces:

Op

Direct Known Subclasses:

BaseAccumulation, BaseBroadcastOp, BaseIndexAccumulation, BaseScalarOp, BaseTransformOp, TadCollapseAccumulation

public abstract class BaseOp
extends Object
implements Op

Base op. An op involves iterating over 2 buffers (x,y) up to n elements and applying a transform or accumulating a result.

Author:

Adam Gibson

Field Summary

Fields

Modifier and Type	Field and Description
protected Object[]	extraArgs
protected long	n
protected long	numProcessed
protected boolean	passThrough
protected INDArray	x
protected INDArray	y
protected INDArray	z

Constructor Summary

Constructors

Constructor and Description
BaseOp()
BaseOp(INDArray x) An op for one ndarray
BaseOp(INDArray x, INDArray z) Specify an alternative result array
BaseOp(INDArray x, INDArray y, INDArray z, long n)
BaseOp(INDArray x, INDArray z, long n) Specify an alternative output array

Method Summary

Modifier and Type	Method and Description
void	exec() Execute the op if its pass through (not needed most of the time)
void	exec(int... dimensions) Exec along each dimension
Object[]	extraArgs() Extra arguments
Buffer	extraArgsBuff() Returns a buffer of either float or double of the extra args for this buffer
DataBuffer	extraArgsDataBuff() Returns the extra args as a data buffer
void	init(INDArray x, INDArray y, INDArray z, long n) Initialize the operation based on the parameters
boolean	isExecSpecial() Whether the executioner needs to do a special call or not
boolean	isPassThrough() Returns whether the op should be executed or not (through the executioner)
long	n() The number of elements to do a op over
long	numProcessed() Number processed
void	setN(long n) Change n
void	setX(INDArray x) set x (the input ndarray)
void	setY(INDArray y) set y(the pairwise ndarray)
void	setZ(INDArray z) set z (the solution ndarray)
String	toString()
INDArray	x() The origin ndarray
INDArray	y() The pairwise op ndarray
INDArray	z() The resulting ndarray

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.nd4j.linalg.api.ops.Op

name, op, op, op, op, op, op, op, op, opForDimension, opForDimension, opNum

Field Detail

x

protected INDArray x

y

protected INDArray y

z

protected INDArray z

n

protected long n

numProcessed

protected long numProcessed

extraArgs

protected Object[] extraArgs

passThrough

protected boolean passThrough

Constructor Detail

BaseOp

public BaseOp()

BaseOp

public BaseOp(INDArray x,
              INDArray z)

Specify an alternative result array

Parameters:

x - the input

z - the output array

BaseOp

public BaseOp(INDArray x,
              INDArray z,
              long n)

Specify an alternative output array

Parameters:

x - the input

z - the output

n - the number of elements to iterate on

BaseOp

public BaseOp(INDArray x,
              INDArray y,
              INDArray z,
              long n)

BaseOp

public BaseOp(INDArray x)

An op for one ndarray

Parameters:

x - the ndarray

Method Detail

isExecSpecial

public boolean isExecSpecial()

Description copied from interface: Op

Whether the executioner needs to do a special call or not

Specified by:

isExecSpecial in interface Op

Returns:

true if the executioner needs to do a special call or not false otherwise

extraArgsDataBuff

public DataBuffer extraArgsDataBuff()

Description copied from interface: Op

Returns the extra args as a data buffer

Specified by:

extraArgsDataBuff in interface Op

Returns:

extraArgsBuff

public Buffer extraArgsBuff()

Description copied from interface: Op

Returns a buffer of either float or double of the extra args for this buffer

Specified by:

extraArgsBuff in interface Op

Returns:

a buffer of either type float or double representing the extra args for this op

isPassThrough

public boolean isPassThrough()

Description copied from interface: Op

Returns whether the op should be executed or not (through the executioner)

Specified by:

isPassThrough in interface Op

Returns:

true if the op is pass through false otherwise

setX

public void setX(INDArray x)

Description copied from interface: Op

set x (the input ndarray)

Specified by:

setX in interface Op

setZ

public void setZ(INDArray z)

Description copied from interface: Op

set z (the solution ndarray)

Specified by:

setZ in interface Op

setY

public void setY(INDArray y)

Description copied from interface: Op

set y(the pairwise ndarray)

Specified by:

setY in interface Op

extraArgs

public Object[] extraArgs()

Description copied from interface: Op

Extra arguments

Specified by:

extraArgs in interface Op

Returns:

the extra arguments

x

public INDArray x()

Description copied from interface: Op

The origin ndarray

Specified by:

x in interface Op

Returns:

the origin ndarray

y

public INDArray y()

Description copied from interface: Op

The pairwise op ndarray

Specified by:

y in interface Op

Returns:

the pairwise op ndarray

z

public INDArray z()

Description copied from interface: Op

The resulting ndarray

Specified by:

z in interface Op

Returns:

the resulting ndarray

n

public long n()

Description copied from interface: Op

The number of elements to do a op over

Specified by:

n in interface Op

Returns:

the op

init

public void init(INDArray x,
                 INDArray y,
                 INDArray z,
                 long n)

Description copied from interface: Op

Initialize the operation based on the parameters

Specified by:

init in interface Op

Parameters:

x - the input

y - the pairwise transform ndarray

z - the resulting ndarray

n - the number of elements

setN

public void setN(long n)

Description copied from interface: Op

Change n

Specified by:

setN in interface Op

numProcessed

public long numProcessed()

Description copied from interface: Op

Number processed

Specified by:

numProcessed in interface Op

Returns:

the number of elements accumulated

toString

public String toString()

Overrides:

toString in class Object

exec

public void exec()

Description copied from interface: Op

Execute the op if its pass through (not needed most of the time)

Specified by:

exec in interface Op

exec

public void exec(int... dimensions)

Description copied from interface: Op

Exec along each dimension

Specified by:

exec in interface Op

Parameters:

dimensions - the dimensions to execute on