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

Class Dot

java.lang.Object

org.nd4j.linalg.api.ops.BaseOp

org.nd4j.linalg.api.ops.BaseAccumulation

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

All Implemented Interfaces:

Accumulation, Op

public class Dot
extends BaseAccumulation

Dot product

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
Dot()
Dot(INDArray x)
Dot(INDArray x, INDArray y)
Dot(INDArray x, INDArray y, INDArray z, long n)
Dot(INDArray x, INDArray y, long n)

Method Summary

Modifier and Type	Method and Description
double	combineSubResults(double first, double second) Combine sub-results, when the Accumulation operation is split and executed in parallel. Sometimes this is the same as the update operation (i.e., in sum operation), but often it is not (for example, in L2 norm, sqrt(1/n * sum_i x_i^2).
float	combineSubResults(float first, float second)
IComplexNumber	combineSubResults(IComplexNumber first, IComplexNumber second)
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
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, calculateFinalResult, calculateFinalResult, currentResult, getAndSetFinalResult, getAndSetFinalResult, getAndSetFinalResult, getFinalResult, getFinalResultComplex, init, noOp, numProcessed, setApplyFinalTransform, setFinalResult, setFinalResultComplex, setZ, zeroComplex, zeroDouble, zeroFloat

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

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

Constructor Detail

Dot

public Dot()

Dot

public Dot(INDArray x,
           INDArray y,
           INDArray z,
           long n)

Dot

public Dot(INDArray x,
           INDArray y,
           long n)

Dot

public Dot(INDArray x)

Dot

public Dot(INDArray x,
           INDArray y)

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

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

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 Accumulation

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 Accumulation

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 Accumulation

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

op

public double op(double origin)

Description copied from interface: Op

Transform an individual element

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

Parameters:

origin - the origin element

Returns:

the new element

op

public float op(float origin)

Description copied from interface: Op

Transform an individual element

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

Parameters:

origin - the origin element

Returns:

the new element

op

public IComplexNumber op(IComplexNumber origin)

Description copied from interface: Op

Transform an individual element

Specified by:

op in interface Accumulation

Specified by:

op in interface Op

Overrides:

op in class BaseAccumulation

Parameters:

origin - the origin element

Returns:

the new element

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)

combineSubResults

public double combineSubResults(double first,
                                double second)

Description copied from interface: Accumulation

Combine sub-results, when the Accumulation operation is split and executed in parallel.
Sometimes this is the same as the update operation (i.e., in sum operation), but often it is not (for example, in L2 norm, sqrt(1/n * sum_i x_i^2).

Specified by:

combineSubResults in interface Accumulation

Overrides:

combineSubResults in class BaseAccumulation

Parameters:

first - The first sub-value to be combined

second - The second sub-value to be combined

Returns:

The combined result

combineSubResults

public float combineSubResults(float first,
                               float second)

Specified by:

combineSubResults in interface Accumulation

Overrides:

combineSubResults in class BaseAccumulation

See Also:

Accumulation.combineSubResults(double, double)

combineSubResults

public IComplexNumber combineSubResults(IComplexNumber first,
                                        IComplexNumber second)

Specified by:

combineSubResults in interface Accumulation

Overrides:

combineSubResults in class BaseAccumulation

See Also:

Accumulation.combineSubResults(double, double)