mikera.vectorz.ops

Class Constant

java.lang.Object

mikera.vectorz.Op

mikera.vectorz.ops.APolynomialOp

mikera.vectorz.ops.ALinearOp

mikera.vectorz.ops.Constant

All Implemented Interfaces:

IOperator

public final class Constant
extends ALinearOp

Field Summary

Fields

Modifier and Type	Field and Description
static Constant	HALF
static Constant	ONE
static Constant	TWO
double	value
static Constant	ZERO

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 x) 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.
void	applyTo(INDArray v) Applies this operator to every element of a target array.
double	averageValue()
Op	compose(Op op)
static Constant	create(double constant)
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()
double	maxValue()
double	minValue()
Op	product(Op op)

Methods inherited from class mikera.vectorz.ops.ALinearOp

hasDerivative, hasInverse, sum, sum

Methods inherited from class mikera.vectorz.Op

applyTo, applyTo, applyTo, applyTo, applyTo, compose, constrainValues, divide, getInverse, getTransform, hasDerivativeForOutput, isBounded, isDomainBounded, isStochastic, maxDomain, minDomain, toString, validateOutput

Methods inherited from class java.lang.Object

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

Field Detail

value

public final double value

ZERO

public static final Constant ZERO

HALF

public static final Constant HALF

ONE

public static final Constant ONE

TWO

public static final Constant TWO

Method Detail

create

public static final Constant create(double constant)

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 x)

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(INDArray v)

Description copied from class: Op

Applies this operator to every element of a target array. Mutates the array in place.

Overrides:

applyTo in class ALinearOp

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

getFactor

public double getFactor()

Specified by:

getFactor in class ALinearOp

getConstant

public double getConstant()

Specified by:

getConstant in class ALinearOp

minValue

public double minValue()

Overrides:

minValue in class Op

maxValue

public double maxValue()

Overrides:

maxValue in class Op

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:

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:

compose

public Op compose(Op op)

Overrides:

compose in class ALinearOp

product

public Op product(Op op)

Overrides:

product in class Op