org.nd4j.linalg.api.ops.impl.reduce3

Class CosineDistance

java.lang.Object

org.nd4j.autodiff.functions.DifferentialFunction

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseReduceOp

org.nd4j.linalg.api.ops.BaseReduceFloatOp

org.nd4j.linalg.api.ops.impl.reduce3.BaseReduce3Op

org.nd4j.linalg.api.ops.impl.reduce3.CosineDistance

All Implemented Interfaces:

Op, ReduceFloatOp, ReduceOp

public class CosineDistance
extends BaseReduce3Op

Cosine distance Note that you need to initialize a scaling constant equal to the norm2 of the vector

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.BaseReduceOp

isComplex, isEmptyReduce, keepDims

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

dimensionz, extraArgz, x, xVertexId, y, yVertexId, z, zVertexId

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

dimensions, extraArgs, inPlace, sameDiff, scalarValue

Constructor Summary

Constructors

Constructor and Description
CosineDistance()
CosineDistance(INDArray x, INDArray y, boolean allDistances, int... dimension)
CosineDistance(INDArray x, INDArray y, INDArray z)
CosineDistance(INDArray x, INDArray y, INDArray z, boolean keepDims, boolean allDistances, int... dimensions)
CosineDistance(INDArray x, INDArray y, INDArray z, boolean allDistances, int... dimension)
CosineDistance(INDArray x, INDArray y, INDArray z, int... dimension)
CosineDistance(INDArray x, INDArray y, int... dimension)
CosineDistance(SameDiff sameDiff, SDVariable i_v, SDVariable i_v2, int... dimensions)

Method Summary

Modifier and Type	Method and Description
List<SDVariable>	doDiff(List<SDVariable> i_v1) The actual implementation for automatic differentiation.
String	opName() The name of the op
int	opNum() The number of the op (mainly for old legacy XYZ ops like Op)
String	tensorflowName() The opName of this function tensorflow

Methods inherited from class org.nd4j.linalg.api.ops.impl.reduce3.BaseReduce3Op

calculateOutputDataTypes, getOpType, onnxName, opType, resultType

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

calculateOutputShape, validateDataTypes

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

hasReductionIndices, initFromOnnx, initFromTensorFlow, isComplexAccumulation, isKeepDims, noOp, setDimensions

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

defineDimensions, dimensions, equals, extraArgs, extraArgsBuff, extraArgsDataBuff, getFinalResult, getNumOutputs, getOpType, hashCode, outputVariables, setX, setY, setZ, toCustomOp, toString, x, y, z

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

arg, arg, argNames, args, attributeAdaptersForFunction, configFieldName, diff, dup, f, getValue, isConfigProperties, larg, mappingsForFunction, onnxNames, outputVariable, outputVariables, outputVariablesNames, propertiesForFunction, rarg, replaceArg, resolvePropertiesFromSameDiffBeforeExecution, setInstanceId, setPropertiesForFunction, 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.ReduceOp

dimensions, getFinalResult, isComplexAccumulation, isKeepDims, noOp, setDimensions

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

extraArgs, extraArgsBuff, extraArgsDataBuff, setExtraArgs, setX, setY, setZ, toCustomOp, x, y, z

Constructor Detail

CosineDistance

public CosineDistance(SameDiff sameDiff,
                      SDVariable i_v,
                      SDVariable i_v2,
                      int... dimensions)

CosineDistance

public CosineDistance()

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      INDArray z)

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      INDArray z,
                      int... dimension)

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      int... dimension)

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      INDArray z,
                      boolean allDistances,
                      int... dimension)

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      boolean allDistances,
                      int... dimension)

CosineDistance

public CosineDistance(INDArray x,
                      INDArray y,
                      INDArray z,
                      boolean keepDims,
                      boolean allDistances,
                      int... dimensions)

Method Detail

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

doDiff

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

Description copied from class: DifferentialFunction

The actual implementation for automatic differentiation.

Specified by:

doDiff in class DifferentialFunction

Returns:

tensorflowName

public String tensorflowName()

Description copied from class: DifferentialFunction

The opName of this function tensorflow

Overrides:

tensorflowName in class BaseReduce3Op

Returns: