mikera.vectorz.ops

Class Identity

java.lang.Object

mikera.vectorz.Op

mikera.vectorz.ops.APolynomialOp

mikera.vectorz.ops.ALinearOp

mikera.vectorz.ops.Identity

All Implemented Interfaces:

IOperator

public final class Identity
extends ALinearOp

Singleton identity operator

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
static Identity	INSTANCE

Method Summary

Modifier and Type	Method and Description
double	apply(double x) Applies this operator to a single value, returning the result
double	applyInverse(double y) Applies the inverse of this Op.
void	applyTo(AVector v) Applies this operator to a mutable vector.
void	applyTo(double[] data) Applies this operator to every element in a double[] array, mutating the array in place
void	applyTo(double[] data, int start, int length) Applies this operator to the specified range within a double[] array.
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()
Op	getDerivativeOp() Gets an operator which represents the derivative of this operator.
double	getFactor()
Identity	getInverse() Gets the inverse of this operator.
ATransform	getTransform(int dimensions) Converts an operator into a corresponding transform that applies the operator to all elements of its input
boolean	hasDerivative() Returns true if this operator supports computing the derivative for a given input
Op	product(Op op)

Methods inherited from class mikera.vectorz.ops.ALinearOp

applyTo, hasInverse, sum, sum

Methods inherited from class mikera.vectorz.Op

applyTo, applyTo, applyTo, applyTo, applyTo, compose, constrainValues, divide, hasDerivativeForOutput, isBounded, isDomainBounded, isStochastic, maxDomain, maxValue, minDomain, minValue, toString, validateOutput

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static final Identity 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: IOperator

Applies this operator to a single value, returning the result

Specified by:

apply in interface IOperator

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)

Description copied from interface: IOperator

Applies this operator to a mutable vector.

Specified by:

applyTo in interface IOperator

Overrides:

applyTo in class ALinearOp

applyTo

public void applyTo(double[] data)

Description copied from class: Op

Applies this operator to every element in a double[] array, mutating the array in place

Overrides:

applyTo in class Op

applyTo

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

Description copied from interface: IOperator

Applies this operator to the specified range within a double[] array.

Specified by:

applyTo in interface IOperator

Overrides:

applyTo in class Op

hasDerivative

public boolean hasDerivative()

Description copied from class: Op

Returns true if this operator supports computing the derivative for a given input

Overrides:

hasDerivative in class ALinearOp

Returns:

getDerivativeOp

public Op getDerivativeOp()

Description copied from class: Op

Gets an operator which represents the derivative of this operator. Returns nil if this cannot be computed or does not exist.

Overrides:

getDerivativeOp in class ALinearOp

Returns:

averageValue

public double averageValue()

Overrides:

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: IOperator

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

Specified by:

getTransform in interface IOperator

Overrides:

getTransform in class Op

Returns:

getInverse

public Identity getInverse()

Description copied from interface: IOperator

Gets the inverse of this operator. Returns null if no inverse exists.

Specified by:

getInverse in interface IOperator

Overrides:

getInverse in class Op

Returns:

compose

public Op compose(Op op)

Overrides:

compose in class ALinearOp

product

public Op product(Op op)

Overrides:

product in class Op