mikera.vectorz.ops

Class IdentityOp

java.lang.Object

mikera.vectorz.Op

mikera.vectorz.ops.ALinearOp

mikera.vectorz.ops.IdentityOp

All Implemented Interfaces:

ITransform, IOp

public final class IdentityOp
extends ALinearOp

Singleton identity operator

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
static IdentityOp	INSTANCE

Fields inherited from class mikera.vectorz.Op

LINEAR, LOGISTIC, RECTIFIER, SOFTPLUS, STOCHASTIC_BINARY, STOCHASTIC_LOGISTIC, TANH

Method Summary

Methods

Modifier and Type	Method and Description
double	apply(double x) Applies the operator to a single value, returning the result
double	applyInverse(double y) Applies the inverse of this Op.
void	applyTo(AVector v)
void	applyTo(double[] data)
void	applyTo(double[] data, int start, int length)
double	averageValue()
Op	compose(Op op)
double	derivative(double x) Returns the derivative of this Op for a given input value x i.e.
double	derivativeForOutput(double y) Returns the derivative of this Op for a given output value y i.e.
double	getConstant()
double	getFactor()
IdentityOp	getInverse()
ATransform	getTransform(int dimensions) Converts an operator into a corresponding transform that applies the operator to all elements of its input
boolean	hasDerivative()

Methods inherited from class mikera.vectorz.ops.ALinearOp

hasInverse

Methods inherited from class mikera.vectorz.Op

applyTo, applyTo, compose, constrainValues, inputDimensions, isBounded, isStochastic, maxValue, minValue, outputDimensions, transform, validateOutput

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

public static final IdentityOp INSTANCE

Method Detail

getFactor

public double getFactor()

Specified by:

getFactor in class ALinearOp

getConstant

public double getConstant()

Specified by:

getConstant in class ALinearOp

apply

public double apply(double x)

Description copied from interface: IOp

Applies the operator to a single value, returning the result

Specified by:

apply in interface IOp

Specified by:

apply in class Op

Returns:

applyInverse

public double applyInverse(double y)

Description copied from class: Op

Applies the inverse of this Op. Throws an error if the inverse function does not exist. Returns Double.NaN if no inverse exists for the specific value of y.

Overrides:

applyInverse in class Op

Returns:

applyTo

public void applyTo(AVector v)

Specified by:

applyTo in interface IOp

Overrides:

applyTo in class Op

applyTo

public void applyTo(double[] data)

Overrides:

applyTo in class Op

applyTo

public void applyTo(double[] data,
           int start,
           int length)

Specified by:

applyTo in interface IOp

Overrides:

applyTo in class Op

hasDerivative

public boolean hasDerivative()

Overrides:

hasDerivative in class ALinearOp

averageValue

public double averageValue()

Specified by:

averageValue in class Op

derivative

public double derivative(double x)

Description copied from class: Op

Returns the derivative of this Op for a given input value x i.e. f'(x) where f is the operator

Overrides:

derivative in class ALinearOp

Returns:

derivativeForOutput

public double derivativeForOutput(double y)

Description copied from class: Op

Returns the derivative of this Op for a given output value y i.e. f'(g(y)) where f is the operator, g is the inverse of f

Overrides:

derivativeForOutput in class ALinearOp

Returns:

getTransform

public ATransform getTransform(int dimensions)

Description copied from interface: IOp

Converts an operator into a corresponding transform that applies the operator to all elements of its input

Specified by:

getTransform in interface IOp

Overrides:

getTransform in class Op

Returns:

getInverse

public IdentityOp getInverse()

Specified by:

getInverse in interface IOp

Overrides:

getInverse in class Op

compose

public Op compose(Op op)

Overrides:

compose in class Op