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

Class CompareAndSet

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseTransformOp

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

All Implemented Interfaces:

Op, TransformOp

public class CompareAndSet
extends BaseTransformOp

Element-wise Compare-and-set implementation as Op Please check javadoc to specific constructors, for detail information.

Author:

[email protected]

Nested Class Summary

Nested classes/interfaces inherited from interface org.nd4j.linalg.api.ops.Op

Op.Type

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CompareAndSet()
CompareAndSet(INDArray x, double set, Condition condition) With this constructor, op will check each X element against given Condition, and if condition met, element will be replaced with Set value Pseudocode: z[i] = condition(x[i]) ? set : x[i]; PLEASE NOTE: X will be modified inplace.
CompareAndSet(INDArray x, double compare, double set, double eps)
CompareAndSet(INDArray x, double compare, double set, double eps, Condition condition)
CompareAndSet(INDArray x, INDArray y, Condition condition) With this constructor, op will check each Y element against given Condition, and if condition met, element Z will be set to Y value, and X otherwise PLEASE NOTE: X will be modified inplace.
CompareAndSet(INDArray x, INDArray z, double set, Condition condition) With this constructor, op will check each X element against given Condition, and if condition met, element will be replaced with Set value Pseudocode: z[i] = condition(x[i]) ? set : x[i];
CompareAndSet(INDArray x, INDArray z, double compare, double set, double eps) This constructor is shortcut to epsEquals.
CompareAndSet(INDArray x, INDArray z, double compare, double set, double eps, long n) This constructor is shortcut to epsEquals.
CompareAndSet(INDArray x, INDArray y, INDArray z, Condition condition) With this constructor, op will check each Y element against given Condition, and if condition met, element Z will be set to Y value, and X otherwise Pseudocode: z[i] = condition(y[i]) ? y[i] : x[i];

Method Summary

Modifier and Type	Method and Description
void	init(INDArray x, INDArray y, INDArray z, long n) Initialize the operation based on the parameters
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
int	opNum() An op number

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

derivative

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

exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, isExecSpecial, isPassThrough, 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, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, isExecSpecial, isPassThrough, n, numProcessed, setExtraArgs, setN, setX, setY, setZ, x, y, z

Constructor Detail

CompareAndSet

public CompareAndSet()

CompareAndSet

public CompareAndSet(INDArray x,
                     double compare,
                     double set,
                     double eps)

CompareAndSet

public CompareAndSet(INDArray x,
                     double compare,
                     double set,
                     double eps,
                     Condition condition)

CompareAndSet

public CompareAndSet(INDArray x,
                     double set,
                     Condition condition)

With this constructor, op will check each X element against given Condition, and if condition met, element will be replaced with Set value Pseudocode: z[i] = condition(x[i]) ? set : x[i]; PLEASE NOTE: X will be modified inplace.

Parameters:

x -

set -

condition -

CompareAndSet

public CompareAndSet(INDArray x,
                     INDArray z,
                     double set,
                     Condition condition)

With this constructor, op will check each X element against given Condition, and if condition met, element will be replaced with Set value Pseudocode: z[i] = condition(x[i]) ? set : x[i];

Parameters:

x -

set -

condition -

CompareAndSet

public CompareAndSet(INDArray x,
                     INDArray y,
                     Condition condition)

With this constructor, op will check each Y element against given Condition, and if condition met, element Z will be set to Y value, and X otherwise PLEASE NOTE: X will be modified inplace. Pseudocode: z[i] = condition(y[i]) ? y[i] : x[i];

Parameters:

x -

y -

condition -

CompareAndSet

public CompareAndSet(INDArray x,
                     INDArray y,
                     INDArray z,
                     Condition condition)

With this constructor, op will check each Y element against given Condition, and if condition met, element Z will be set to Y value, and X otherwise Pseudocode: z[i] = condition(y[i]) ? y[i] : x[i];

Parameters:

x -

y -

z -

condition -

CompareAndSet

public CompareAndSet(INDArray x,
                     INDArray z,
                     double compare,
                     double set,
                     double eps)

This constructor is shortcut to epsEquals.

Parameters:

x -

z -

compare -

set -

eps -

CompareAndSet

public CompareAndSet(INDArray x,
                     INDArray z,
                     double compare,
                     double set,
                     double eps,
                     long n)

This constructor is shortcut to epsEquals.

Parameters:

x -

z -

compare -

set -

eps -

Method Detail

opNum

public int opNum()

Description copied from interface: Op

An op number

Returns:

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

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

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

Overrides:

init in class BaseOp

Parameters:

x - the input

y - the pairwise transform ndarray

z - the resulting ndarray

n - the number of elements