org.nd4j.linalg.api.ops

Interface Op

All Known Subinterfaces:

Accumulation, BroadcastOp, IndexAccumulation, LossFunction, ScalarOp, TransformOp

All Known Implementing Classes:

Abs, ACos, AddOp, ASin, ATan, BaseAccumulation, BaseBroadcastOp, BaseIndexAccumulation, BaseLossFunction, BaseOp, BaseScalarOp, BaseTransformOp, Bias, BroadcastAddOp, BroadcastCopyOp, BroadcastDivOp, BroadcastMulOp, BroadcastRDivOp, BroadcastRSubOp, BroadcastSubOp, Ceil, CopyOp, Cos, CosineSimilarity, DivOp, Dot, ELU, ELUDerivative, Eps, EqualTo, EuclideanDistance, Exp, Floor, GreaterThan, GreaterThanOrEqual, HardTanh, HardTanhDerivative, IAMax, Identity, IMax, IMin, LeakyReLU, LeakyReLUDerivative, LessThan, LessThanOrEqual, LinearIndex, Log, LogSoftMax, ManhattanDistance, Max, Max, MaxOut, Mean, Min, Min, MulOp, Negative, Norm1, Norm2, NormMax, NotEqualTo, OneMinus, Ones, Pow, Prod, RDivOp, RectifedLinear, Round, RSubOp, ScalarAdd, ScalarDivision, ScalarEquals, ScalarGreaterThan, ScalarGreaterThanOrEqual, ScalarLessThan, ScalarLessThanOrEqual, ScalarMax, ScalarMultiplication, ScalarNotEquals, ScalarReverseDivision, ScalarReverseSubtraction, ScalarSet, ScalarSetValue, ScalarSubtraction, SetRange, Sigmoid, SigmoidDerivative, Sign, Sin, SoftMax, SoftMaxDerivative, SoftPlus, SoftSign, SoftSignDerivative, Sqrt, Stabilize, StandardDeviation, Step, SubOp, Sum, Tanh, TanhDerivative, TimesOneMinus, Variance, VectorFFT, VectorIFFT

public interface Op

An op is defined as follows: name: name of the operation x: the origin ndarray y: the ndarray to parse in parallel z: the resulting buffer n: the number of elements to iterate over where x is the origin ndarray, y, is a pairwise op over n elements in the ndarray stored in result z

This is followed from the standard template for a BLAS operation such that given a linear buffer, a function defines 3 buffers (x,y,z) and the associated strides and offsets (handled by the ndarrays in this case)

Author:

Adam Gibson

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
void	init(INDArray x, INDArray y, INDArray z, int n) Initialize the operation based on the parameters
boolean	isPassThrough() Returns whether the op should be executed or not (through the executioner)
int	n() The number of elements to do a op over
String	name() The name of this operation
int	numProcessed() Number processed
double	op(double origin) Transform an individual element
double	op(double origin, double other) Pairwise op (applicable with an individual element in y)
float	op(float origin) Transform an individual element
float	op(float origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin) Transform an individual element
IComplexNumber	op(IComplexNumber origin, double other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, float other) Pairwise op (applicable with an individual element in y)
IComplexNumber	op(IComplexNumber origin, IComplexNumber other) Pairwise op (applicable with an individual element in y)
Op	opForDimension(int index, int... dimension) A copy of this operation for a particular dimension of the input
Op	opForDimension(int index, int dimension) A copy of this operation for a particular dimension of the input
void	setN(int 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)
INDArray	x() The origin ndarray
INDArray	y() The pairwise op ndarray
INDArray	z() The resulting ndarray

Method Detail

name

String name()

The name of this operation

Returns:

the name of this operation

x

INDArray x()

The origin ndarray

Returns:

the origin ndarray

y

INDArray y()

The pairwise op ndarray

Returns:

the pairwise op ndarray

z

INDArray z()

The resulting ndarray

Returns:

the resulting ndarray

n

int n()

The number of elements to do a op over

Returns:

the op

op

IComplexNumber op(IComplexNumber origin,
                  double other)

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

IComplexNumber op(IComplexNumber origin,
                  float other)

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

IComplexNumber op(IComplexNumber origin,
                  IComplexNumber other)

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

float op(float origin,
         float other)

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

double op(double origin,
          double other)

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

double op(double origin)

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

float op(float origin)

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

IComplexNumber op(IComplexNumber origin)

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

opForDimension

Op opForDimension(int index,
                  int dimension)

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

opForDimension

Op opForDimension(int index,
                  int... dimension)

A copy of this operation for a particular dimension of the input

Parameters:

index - the index of the op to iterate over

dimension - the dimension to ge the input for

Returns:

the operation for that dimension

init

void init(INDArray x,
          INDArray y,
          INDArray z,
          int n)

Initialize the operation based on the parameters

Parameters:

x - the input

y - the pairwise transform ndarray

z - the resulting ndarray

n - the number of elements

numProcessed

int numProcessed()

Number processed

Returns:

the number of elements accumulated

extraArgs

Object[] extraArgs()

Extra arguments

Returns:

the extra arguments

setX

void setX(INDArray x)

set x (the input ndarray)

Parameters:

x -

setZ

void setZ(INDArray z)

set z (the solution ndarray)

Parameters:

z -

setY

void setY(INDArray y)

set y(the pairwise ndarray)

Parameters:

y -

isPassThrough

boolean isPassThrough()

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

Returns:

true if the op is pass through false otherwise

exec

void exec()

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

exec

void exec(int... dimensions)

Exec along each dimension

Parameters:

dimensions - the dimensions to execute on

setN

void setN(int n)

Change n

Parameters:

n -