Package functions.unitary.piecewise

Class DomainRestrictor

Object

GeneralFunction

UnitaryFunction

PiecewiseFunction

DomainRestrictor

All Implemented Interfaces:

Differentiable, Evaluable, Outputable, Simplifiable, Comparable<GeneralFunction>, Iterable<GeneralFunction>

public class DomainRestrictor
extends PiecewiseFunction

The DomainRestrictor class allows for the restriction of domains of ranges of functions. When domainTester returns true, this class functions as the identity, but when domainTester returns false, evaluate returns Double.NaN.

Field Summary

Fields

Modifier and Type	Field	Description
BiPredicate<Double,Map<String,Double>>	domainTester	This BiPredicate describes the domain of this function given an argument and list of variable values

Fields inherited from class UnitaryFunction

operand

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
DomainRestrictor(GeneralFunction operand, BiPredicate<Double,Map<String,Double>> domainTester)	Constructs a new DomainRestrictor
DomainRestrictor(GeneralFunction operand, DoublePredicate domainTester)	Constructs a new DomainRestrictor

Method Summary

Modifier and Type	Method	Description
double	evaluate(Map<String,Double> variableValues)	Evaluates a GeneralFunction at a point denoted by a Map
GeneralFunction	getDerivative(String varID)	Returns the derivative of a GeneralFunction with respect to a variable.
UnitaryFunction	getInstance(GeneralFunction operand)	Returns a new instance of this UnitaryFunction
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class UnitaryFunction

clone, compareSelf, equalsFunction, hashCode, iterator, newInstanceOf, simplify, simplifyFOC, simplifyInternal, simplifyInverse, substituteAll, toOutputFunction

Methods inherited from class GeneralFunction

compareTo, derivativeAt, equals, equalsSimplified, getNthDerivative, getSimplifiedDerivative, substituteVariables

Methods inherited from class Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterable

forEach, spliterator

Field Details

domainTester

public final BiPredicate<Double,Map<String,Double>> domainTester

This BiPredicate describes the domain of this function given an argument and list of variable values

Constructor Details

DomainRestrictor

public DomainRestrictor(GeneralFunction operand, BiPredicate<Double,Map<String,Double>> domainTester)

Constructs a new DomainRestrictor

Parameters:

operand - The function whose output will be restricted

domainTester - the BiPredicate<Double, Map<String, Double>> describing the domain of the function

DomainRestrictor

public DomainRestrictor(GeneralFunction operand, DoublePredicate domainTester)

Constructs a new DomainRestrictor

Parameters:

operand - The function whose output will be restricted

domainTester - the DoublePredicate describing the domain of the function

Method Details

getInstance

public UnitaryFunction getInstance(GeneralFunction operand)

Description copied from class: UnitaryFunction

Returns a new instance of this UnitaryFunction

Specified by:

getInstance in class UnitaryFunction

Parameters:

operand - the GeneralFunction to be operated on

Returns:

a new instance of this UnitaryFunction

getDerivative

public GeneralFunction getDerivative(String varID)

Description copied from interface: Differentiable

Returns the derivative of a GeneralFunction with respect to a variable. Should not be used in general; GeneralFunction.getSimplifiedDerivative(java.lang.String) is strongly preferred.

Parameters:

varID - the ID of the variable that is differentiated against

Returns:

the derivative of the function with respect to varID

evaluate

public double evaluate(Map<String,Double> variableValues)

Description copied from interface: Evaluable

Evaluates a GeneralFunction at a point denoted by a Map

Parameters:

variableValues - the values of the variables in the GeneralFunction at the point

Returns:

the value of the GeneralFunction at the point

toString

public String toString()

Description copied from class: GeneralFunction

Returns a String representation of this GeneralFunction

Overrides:

toString in class UnitaryFunction

Returns:

String representation of this function