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

Class CompareAndSet

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

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:

raver119@gmail.com

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, xVertexId, y, yVertexId, z, zVertexId

Fields inherited from class org.nd4j.autodiff.functions.DifferentialFunction

dimensions, inPlace, sameDiff, scalarValue

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];
CompareAndSet(SameDiff sameDiff, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v, boolean inPlace, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v, int[] shape, boolean inPlace, Object[] extraArgs, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v, Object[] extraArgs, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v1, SDVariable i_v2, boolean inPlace, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v1, SDVariable i_v2, double compare, double set, double eps, int mode)
CompareAndSet(SameDiff sameDiff, SDVariable i_v1, SDVariable i_v2, Object[] extraArgs, double compare, double set, double eps, int mode)

Method Summary

Modifier and Type	Method and Description
List<SDVariable>	doDiff(List<SDVariable> f1) The actual implementation for automatic differentiation.
void	init(INDArray x, INDArray y, INDArray z, long n) Initialize the operation based on the parameters
String	onnxName() The opName of this function in onnx
String	opName() The name of the op
int	opNum() The number of the op (mainly for old legacy XYZ ops like Op)
Map<String,Object>	propertiesForFunction() Returns the properties for a given function
String	tensorflowName() The opName of this function tensorflow

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

calculateOutputShape, opType, z

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

equals, exec, exec, extraArgs, extraArgsBuff, extraArgsDataBuff, getOpType, hashCode, initFromOnnx, initFromTensorFlow, isExecSpecial, isPassThrough, n, numProcessed, outputVariables, setN, setX, setY, setZ, toCustomOp, toString, x, y

Methods inherited from class org.nd4j.autodiff.functions.DifferentialFunction

arg, args, asProperties, attributeAdaptersForFunction, configFieldName, diff, dup, f, getValue, hasPlaceHolderInputs, isConfigProperties, larg, mappingsForFunction, onnxNames, outputVariables, rarg, resolvePropertiesFromSameDiffBeforeExecution, setInstanceId, setValueFor, tensorflowNames

Methods inherited from class java.lang.Object

clone, finalize, getClass, 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, toCustomOp, x, y

Constructor Detail

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v1,
                     SDVariable i_v2,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v1,
                     SDVariable i_v2,
                     boolean inPlace,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v1,
                     SDVariable i_v2,
                     Object[] extraArgs,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v,
                     boolean inPlace,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v,
                     int[] shape,
                     boolean inPlace,
                     Object[] extraArgs,
                     double compare,
                     double set,
                     double eps,
                     int mode)

CompareAndSet

public CompareAndSet(SameDiff sameDiff,
                     SDVariable i_v,
                     Object[] extraArgs,
                     double compare,
                     double set,
                     double eps,
                     int mode)

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

propertiesForFunction

public Map<String,Object> propertiesForFunction()

Description copied from class: DifferentialFunction

Returns the properties for a given function

Overrides:

propertiesForFunction in class DifferentialFunction

Returns:

opNum

public int opNum()

Description copied from class: DifferentialFunction

The number of the op (mainly for old legacy XYZ ops like Op)

Specified by:

opNum in interface Op

Overrides:

opNum in class DifferentialFunction

Returns:

opName

public String opName()

Description copied from class: DifferentialFunction

The name of the op

Specified by:

opName in interface Op

Overrides:

opName in class DifferentialFunction

Returns:

the opName of this operation

onnxName

public String onnxName()

Description copied from class: DifferentialFunction

The opName of this function in onnx

Specified by:

onnxName in class DifferentialFunction

Returns:

tensorflowName

public String tensorflowName()

Description copied from class: DifferentialFunction

The opName of this function tensorflow

Specified by:

tensorflowName in class DifferentialFunction

Returns:

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

doDiff

public List<SDVariable> doDiff(List<SDVariable> f1)

Description copied from class: DifferentialFunction

The actual implementation for automatic differentiation.

Specified by:

doDiff in class DifferentialFunction

Returns: