org.nd4j.linalg.api.ops.impl.transforms

Class LinearIndex

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseTransformOp

org.nd4j.linalg.api.ops.impl.transforms.LinearIndex

All Implemented Interfaces:

Op, TransformOp

public class LinearIndex
extends BaseTransformOp

Collects the linear indexes for a given vector. This is primarily used for internal use in linear view.

Author:

Adam Gibson

Field Summary

Fields inherited from class org.nd4j.linalg.api.ops.BaseOp

extraArgs, n, numProcessed, passThrough, x, y, z

Constructor Summary

Constructors

Constructor and Description
LinearIndex()
LinearIndex(INDArray x)
LinearIndex(INDArray x, boolean wholeArray)
LinearIndex(INDArray x, INDArray z, boolean wholeArray)
LinearIndex(INDArray x, INDArray y, INDArray z, int n, boolean wholeArray)
LinearIndex(INDArray x, INDArray z, int n, boolean wholeArray)

Method Summary

Modifier and Type	Method and Description
void	exec() Execute the op if its pass through (not needed most of the time)
int[]	getIndices() The linear indices collected iterating over the array
boolean	isPassThrough() Returns whether the op should be executed or not (through the executioner)
String	name() The name of this operation
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

Methods inherited from class org.nd4j.linalg.api.ops.BaseTransformOp

derivative

Methods inherited from class org.nd4j.linalg.api.ops.BaseOp

ensureProperVectors, exec, extraArgs, init, n, numProcessed, setN, setX, setY, setZ, toString, x, y, z

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

exec, extraArgs, init, n, numProcessed, setN, setX, setY, setZ, x, y, z

Constructor Detail

LinearIndex

public LinearIndex()

LinearIndex

public LinearIndex(INDArray x)

LinearIndex

public LinearIndex(INDArray x,
                   INDArray z,
                   boolean wholeArray)

LinearIndex

public LinearIndex(INDArray x,
                   INDArray z,
                   int n,
                   boolean wholeArray)

LinearIndex

public LinearIndex(INDArray x,
                   INDArray y,
                   INDArray z,
                   int n,
                   boolean wholeArray)

LinearIndex

public LinearIndex(INDArray x,
                   boolean wholeArray)

Method Detail

name

public String name()

Description copied from interface: Op

The name of this operation

Returns:

the name of this operation

op

public IComplexNumber op(IComplexNumber origin,
                         double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public IComplexNumber op(IComplexNumber origin,
                         IComplexNumber other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public float op(float origin,
                float other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin,
                 double other)

Description copied from interface: Op

Pairwise op (applicable with an individual element in y)

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

op

public double op(double origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public float op(float origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

op

public IComplexNumber op(IComplexNumber origin)

Description copied from interface: Op

Transform an individual element

Parameters:

origin - the origin element

Returns:

the new element

getIndices

public int[] getIndices()

The linear indices collected iterating over the array

Returns:

the linear indices collected iterating over the array

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

Overrides:

exec in class BaseOp

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

Overrides:

isPassThrough in class BaseOp

Returns:

true if the op is pass through false otherwise

opForDimension

public Op opForDimension(int index,
                         int dimension)

Description copied from interface: Op

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

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

Description copied from interface: Op

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