Package functions.binary

Class Logb

Object

GeneralFunction

BinaryFunction

Logb

All Implemented Interfaces:

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

public class Logb
extends BinaryFunction

Field Summary

Fields inherited from class BinaryFunction

function1, function2

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Logb(GeneralFunction argument, GeneralFunction base)	Constructs a new Logb

Method Summary

Modifier and Type	Method	Description
GeneralFunction	clone()	Returns a clone of this GeneralFunction
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.
BinaryFunction	getInstance(GeneralFunction function1, GeneralFunction function2)	Returns an instance of this GeneralFunction, using the correct subclass
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
GeneralFunction	simplifyIdentity()	Returns DefaultFunctions.ONE if the base of the logarithm equals the argument
GeneralFunction	simplifyPowers()	Returns a GeneralFunction where, if the argument is a Pow or Exp, the exponent of the argument has been moved in front of the logarithm in a Product
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion
GeneralFunction	toSpecialCase()
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class BinaryFunction

compareSelf, equalsFunction, getFunction1, getFunction2, hashCode, iterator, simplifyFOC, substituteAll

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

Logb

public Logb(GeneralFunction argument, GeneralFunction base)

Constructs a new Logb

Parameters:

argument - The argument of the logarithm

base - The base of the logarithm

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 BinaryFunction getInstance(GeneralFunction function1, GeneralFunction function2)

Description copied from class: BinaryFunction

Returns an instance of this GeneralFunction, using the correct subclass

Specified by:

getInstance in class BinaryFunction

Parameters:

function1 - Constructor parameter 1

function2 - Constructor parameter 2

Returns:

an instance of this GeneralFunction

clone

public GeneralFunction clone()

Description copied from class: GeneralFunction

Returns a clone of this GeneralFunction

Specified by:

clone in class GeneralFunction

Returns:

a clone of this function

toSpecialCase

public GeneralFunction toSpecialCase()

toString

public String toString()

Description copied from class: GeneralFunction

Returns a String representation of this GeneralFunction

Specified by:

toString in class GeneralFunction

Returns:

String representation of this function

simplify

public GeneralFunction simplify()

Description copied from interface: Simplifiable

Returns this GeneralFunction, simplified

Returns:

the simplified function

simplifyIdentity

public GeneralFunction simplifyIdentity()

Returns DefaultFunctions.ONE if the base of the logarithm equals the argument

Returns:

DefaultFunctions.ONE if the base of the logarithm equals the argument

simplifyPowers

public GeneralFunction simplifyPowers()

Returns a GeneralFunction where, if the argument is a Pow or Exp, the exponent of the argument has been moved in front of the logarithm in a Product

Returns:

a GeneralFunction where, if the argument is a Pow or Exp, the exponent of the argument has been moved in front of the logarithm in a Product

toOutputFunction

public OutputFunction toOutputFunction()

Description copied from interface: Outputable

Converts this function into an OutputFunction for use in string conversion

Specified by:

toOutputFunction in interface Outputable

Overrides:

toOutputFunction in class BinaryFunction

Returns:

this function as an OutputFunction