Package functions.unitary.specialcases

Class Ln

Object

GeneralFunction

UnitaryFunction

SpecialCaseBinaryFunction

Ln

All Implemented Interfaces:

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

public class Ln
extends SpecialCaseBinaryFunction

Field Summary

Fields inherited from class UnitaryFunction

operand

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Ln(GeneralFunction operand)	Constructs a new Ln

Method Summary

Modifier and Type	Method	Description
double	evaluate(Map<String,Double> variableValues)	Evaluates a GeneralFunction at a point denoted by a Map
BinaryFunction	getClassForm()	Returns the BinaryFunction that this function is a special case of.
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
Class<?>	getInverse()	Returns the Class corresponding to the inverse of this function
GeneralFunction	simplifyInverse()	If UnitaryFunction.operand is an instance of the inverse of this function, returns operand.operand

Methods inherited from class UnitaryFunction

clone, compareSelf, equalsFunction, hashCode, iterator, newInstanceOf, simplify, simplifyFOC, simplifyInternal, 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

Ln

public Ln(GeneralFunction operand)

Constructs a new Ln

Parameters:

operand - The function which natural log 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

getClassForm

public BinaryFunction getClassForm()

Description copied from class: SpecialCaseBinaryFunction

Returns the BinaryFunction that this function is a special case of. Ex: ln becomes logb_e

Specified by:

getClassForm in class SpecialCaseBinaryFunction

Returns:

a new BinaryFunction

getInverse

public Class<?> getInverse()

Description copied from interface: Invertible

Returns the Class corresponding to the inverse of this function

Returns:

the inverse Class

simplifyInverse

public GeneralFunction simplifyInverse()

Description copied from class: UnitaryFunction

If UnitaryFunction.operand is an instance of the inverse of this function, returns operand.operand

Overrides:

simplifyInverse in class UnitaryFunction

Returns:

operand.operand if UnitaryFunction.operand is an instance of the inverse, and this otherwise