org.nd4j.linalg.api.ops.impl.accum.distances

Class CosineSimilarity

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

org.nd4j.linalg.api.ops.impl.accum.distances.CosineSimilarity

All Implemented Interfaces:

Accumulation, Op

public class CosineSimilarity
extends BaseAccumulation

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

Author:

Adam Gibson

Field Summary

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

applyFinalTransform, finalResult, finalResultComplex

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

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

Constructor Summary

Constructors

Constructor and Description
CosineSimilarity()
CosineSimilarity(INDArray x)
CosineSimilarity(INDArray x, INDArray y)
CosineSimilarity(INDArray x, INDArray y, INDArray z, int n)
CosineSimilarity(INDArray x, INDArray y, int n)

Method Summary

Modifier and Type	Method and Description
double	calculateFinalResult(double accum, int n) Calculate the final result.
float	calculateFinalResult(float accum, int n)
void	exec() Execute the op if its pass through (not needed most of the time)
void	exec(int... dimension) Exec along each dimension
double	getAndSetFinalResult(double accum) Get and set the final result. The final result is also stored in the Accumulation op itself (and can be retrieved by getFinalResult()) In some Accumulation operations, a final operation must be done on the accumulated result.
float	getAndSetFinalResult(float accum)
IComplexNumber	getAndSetFinalResult(IComplexNumber accum) Complex version of getAndSetFinalResult().
String	name() The name of this operation
double	op(double origin, double other) Pairwise op (applicable with an individual element in y)
float	op(float origin, float other) Pairwise op (applicable with an individual element in y)
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
double	update(double accum, double x) Do one accumulation update for a single-argument accumulation, given the current accumulation value and another value to be processed/accumulated
double	update(double accum, double x, double y) Do an accumulation update for a pair-wise (op(x,y)) accumulation, given the current accumulation value and a pair of values to be processed/accumulated
float	update(float accum, float x)
float	update(float accum, float x, float y)
IComplexNumber	update(IComplexNumber accum, double x) Complex update.
IComplexNumber	update(IComplexNumber accum, double x, double y) Complex update.
IComplexNumber	update(IComplexNumber accum, IComplexNumber x) Complex update.
IComplexNumber	update(IComplexNumber accum, IComplexNumber x, double y) Complex update.
IComplexNumber	update(IComplexNumber accum, IComplexNumber x, IComplexNumber y) Complex update.

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

applyFinalTransform, combineSubResults, combineSubResults, combineSubResults, currentResult, getFinalResult, getFinalResultComplex, init, numProcessed, op, op, op, setApplyFinalTransform, setFinalResult, setFinalResultComplex, zeroComplex, zeroDouble, zeroFloat

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

ensureProperVectors, extraArgs, isPassThrough, n, 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

extraArgs, isPassThrough, n, setN, setX, setY, setZ, x, y, z

Constructor Detail

CosineSimilarity

public CosineSimilarity()

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        INDArray z,
                        int n)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y,
                        int n)

CosineSimilarity

public CosineSimilarity(INDArray x)

CosineSimilarity

public CosineSimilarity(INDArray x,
                        INDArray y)

Method Detail

update

public double update(double accum,
                     double x)

Description copied from interface: Accumulation

Do one accumulation update for a single-argument accumulation, given the current accumulation value and another value to be processed/accumulated

Parameters:

accum - The current accumulation value

x - The next/new value to be processed/accumulated

Returns:

The updated accumulation value

update

public double update(double accum,
                     double x,
                     double y)

Description copied from interface: Accumulation

Do an accumulation update for a pair-wise (op(x,y)) accumulation, given the current accumulation value and a pair of values to be processed/accumulated

Parameters:

accum - The current accumulation value

x - The next/new x value to be processed/accumulated

y - The next/new y value to be processed/accumulated

Returns:

the updated accumulation value

update

public float update(float accum,
                    float x)

See Also:

Accumulation.update(double, double)

update

public float update(float accum,
                    float x,
                    float y)

See Also:

Accumulation.update(double, double, double)

update

public IComplexNumber update(IComplexNumber accum,
                             double x)

Description copied from interface: Accumulation

Complex update.

See Also:

Accumulation.update(double, double)

update

public IComplexNumber update(IComplexNumber accum,
                             double x,
                             double y)

Description copied from interface: Accumulation

Complex update.

See Also:

Accumulation.update(double, double, double)

update

public IComplexNumber update(IComplexNumber accum,
                             IComplexNumber x)

Description copied from interface: Accumulation

Complex update.

See Also:

Accumulation.update(double, double)

update

public IComplexNumber update(IComplexNumber accum,
                             IComplexNumber x,
                             IComplexNumber y)

Description copied from interface: Accumulation

Complex update.

See Also:

Accumulation.update(double, double, double)

update

public IComplexNumber update(IComplexNumber accum,
                             IComplexNumber x,
                             double y)

Description copied from interface: Accumulation

Complex update.

See Also:

Accumulation.update(double, double, double)

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)

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

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)

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

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)

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

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)

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

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)

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

Parameters:

origin - the origin number

other - the other number

Returns:

the transformed output

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

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

exec

public void exec(int... dimension)

Description copied from interface: Op

Exec along each dimension

Specified by:

exec in interface Op

Overrides:

exec in class BaseOp

Parameters:

dimension - the dimensions to execute on

getAndSetFinalResult

public double getAndSetFinalResult(double accum)

Description copied from interface: Accumulation

Get and set the final result.
The final result is also stored in the Accumulation op itself (and can be retrieved by getFinalResult()) In some Accumulation operations, a final operation must be done on the accumulated result. For example, division by n in a mean operation: the accumulated result is the sum, whereas the final result is the sum/n.

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

Parameters:

accum - The accumulated result

Returns:

The final result

getAndSetFinalResult

public float getAndSetFinalResult(float accum)

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

See Also:

Accumulation.getAndSetFinalResult(double)

getAndSetFinalResult

public IComplexNumber getAndSetFinalResult(IComplexNumber accum)

Description copied from interface: Accumulation

Complex version of getAndSetFinalResult().

Specified by:

getAndSetFinalResult in interface Accumulation

Overrides:

getAndSetFinalResult in class BaseAccumulation

See Also:

Accumulation.getAndSetFinalResult(double)

calculateFinalResult

public double calculateFinalResult(double accum,
                                   int n)

Description copied from interface: Accumulation

Calculate the final result. unlike Accumulation.getAndSetFinalResult(double), the result is merely calculated and returned, not stored in the Accumulation op itself.

Specified by:

calculateFinalResult in interface Accumulation

Overrides:

calculateFinalResult in class BaseAccumulation

Parameters:

accum - The accumulated result

n - the number of elements accumulated

Returns:

calculated final result

calculateFinalResult

public float calculateFinalResult(float accum,
                                  int n)

Specified by:

calculateFinalResult in interface Accumulation

Overrides:

calculateFinalResult in class BaseAccumulation

See Also:

Accumulation.calculateFinalResult(double, int)