Package functions.unitary.piecewise

Class Sign

Object

GeneralFunction

UnitaryFunction

PiecewiseFunction

Sign

All Implemented Interfaces:

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

public class Sign
extends PiecewiseFunction

Field Summary

Fields inherited from class UnitaryFunction

operand

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Sign(GeneralFunction operand)	Constructs a new Sign

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

Methods inherited from class UnitaryFunction

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

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

Constructor Details

Sign

public Sign(GeneralFunction operand)

Constructs a new Sign

Parameters:

operand - The function which signum is operating on

Method Details

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

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

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