mikera.vectorz.ops

Class Clamp

java.lang.Object

mikera.vectorz.Op

mikera.vectorz.ops.ABoundedOp

mikera.vectorz.ops.Clamp

All Implemented Interfaces:

ITransform, IOp

public final class Clamp
extends ABoundedOp

Operator for clamping values within a given range

Author:

Mike

Field Summary

Fields

Modifier and Type	Field and Description
static Clamp	ZERO_TO_ONE

Constructor Summary

Constructors

Constructor and Description
Clamp(double min, double max)

Method Summary

Methods

Modifier and Type	Method and Description
double	apply(double x) Applies the operator to a single value, returning the result
void	applyTo(double[] data, int start, int length)
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.
boolean	hasDerivative()
double	maxValue()
double	minValue()

Methods inherited from class mikera.vectorz.ops.ABoundedOp

averageValue, isBounded

Methods inherited from class mikera.vectorz.Op

applyInverse, applyTo, applyTo, applyTo, applyTo, applyTo, compose, compose, constrainValues, getDerivativeOp, getInverse, getTransform, hasDerivativeForOutput, hasInverse, inputDimensions, isDomainBounded, isStochastic, maxDomain, minDomain, outputDimensions, product, sum, toString, transform, validateOutput

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_TO_ONE

public static final Clamp ZERO_TO_ONE

Constructor Detail

Clamp

public Clamp(double min,
     double max)

Method Detail

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:

applyTo

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

Specified by:

applyTo in interface IOp

Overrides:

applyTo in class Op

minValue

public double minValue()

Specified by:

minValue in class ABoundedOp

maxValue

public double maxValue()

Specified by:

maxValue in class ABoundedOp

hasDerivative

public boolean hasDerivative()

Overrides:

hasDerivative 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 Op

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 Op

Returns: