Package functions.unitary.transforms

Class Integral

Object

GeneralFunction

UnitaryFunction

Transformation

Integral

All Implemented Interfaces:

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

public class Integral
extends Transformation

A wrapper class used to store functions in the integration pipeline, allowing users to utilize the methods in tools.integration.

Field Summary

Fields inherited from class Transformation

respectTo

Fields inherited from class UnitaryFunction

operand

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Integral(GeneralFunction integrand)	Constructs a new Integral whose respectTo is null.
Integral(GeneralFunction integrand, String respectTo)	Constructs a new Integral

Method Summary

Modifier and Type	Method	Description
UnitaryFunction	clone()	Returns a clone of this GeneralFunction
int	compareSelf(GeneralFunction that)	Used internally for comparing two functions of the same exact type
boolean	equalsFunction(GeneralFunction that)	Returns true when the two fully-simplified functions are equal
double	evaluate(Map<String,Double> variableValues)	Integrates the operand numerically from 0 to the value specified in the Map corresponding to respectTo
GeneralFunction	execute()	Returns the integral of the integrand
GeneralFunction	getDerivative(String varID)	Returns the derivative of a GeneralFunction with respect to a variable.
UnitaryFunction	getInstance(GeneralFunction function)	Returns a new instance of this UnitaryFunction
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
Integral	simplifyInternal()	Simplifies the UnitaryFunction.operand using Simplifiable.simplify()
GeneralFunction	substituteVariables(Map<String,? extends GeneralFunction> toSubstitute)	Substitutes variables with functions as specified in a map
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion
String	toString()	Returns a String representation of this GeneralFunction

Methods inherited from class Transformation

getRespectTo

Methods inherited from class UnitaryFunction

hashCode, iterator, newInstanceOf, simplifyFOC, simplifyInverse, substituteAll

Methods inherited from class GeneralFunction

compareTo, derivativeAt, equals, equalsSimplified, getNthDerivative, getSimplifiedDerivative

Methods inherited from class Object

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

Methods inherited from interface Iterable

forEach, spliterator

Constructor Details

Integral

public Integral(GeneralFunction integrand, String respectTo)

Constructs a new Integral

Parameters:

integrand - The integrand of the Integral

respectTo - The variable that the Integral is with respect to

Integral

public Integral(GeneralFunction integrand)

Constructs a new Integral whose respectTo is null. This WILL THROW AN EXCEPTION if any method is attempted that uses respectTo.

Parameters:

integrand - the integrand of the Integral

Method Details

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

clone

public UnitaryFunction clone()

Description copied from class: GeneralFunction

Returns a clone of this GeneralFunction

Overrides:

clone in class UnitaryFunction

Returns:

a clone of this function

substituteVariables

public GeneralFunction substituteVariables(Map<String,? extends GeneralFunction> toSubstitute)

Description copied from class: GeneralFunction

Substitutes variables with functions as specified in a map

Overrides:

substituteVariables in class GeneralFunction

Parameters:

toSubstitute - the map between Variable strings and GeneralFunctions

Returns:

the new GeneralFunction after all substitutions are preformed

equalsFunction

public boolean equalsFunction(GeneralFunction that)

Description copied from class: GeneralFunction

Returns true when the two fully-simplified functions are equal

Overrides:

equalsFunction in class UnitaryFunction

Parameters:

that - The GeneralFunction that the current function is being checked against

Returns:

true if the two functions are equal

compareSelf

public int compareSelf(GeneralFunction that)

Description copied from class: GeneralFunction

Used internally for comparing two functions of the same exact type

Overrides:

compareSelf in class UnitaryFunction

Parameters:

that - the GeneralFunction that this is compared against

Returns:

the comparison

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)

Integrates the operand numerically from 0 to the value specified in the Map corresponding to respectTo

Parameters:

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

Returns:

the operand integrated numerically

simplifyInternal

public Integral simplifyInternal()

Description copied from class: UnitaryFunction

Simplifies the UnitaryFunction.operand using Simplifiable.simplify()

Overrides:

simplifyInternal in class UnitaryFunction

Returns:

an instance of this UnitaryFunction with the UnitaryFunction.operand simplified

getInstance

public UnitaryFunction getInstance(GeneralFunction function)

Description copied from class: UnitaryFunction

Returns a new instance of this UnitaryFunction

Specified by:

getInstance in class UnitaryFunction

Parameters:

function - the GeneralFunction to be operated on

Returns:

a new instance of this UnitaryFunction

execute

public GeneralFunction execute() throws IntegrationFailedException

Returns the integral of the integrand

Specified by:

execute in class Transformation

Returns:

the integral of the integrand

Throws:

IntegrationFailedException - if the integral could not be found

simplify

public GeneralFunction simplify()

Description copied from interface: Simplifiable

Returns this GeneralFunction, simplified

Specified by:

simplify in interface Simplifiable

Overrides:

simplify in class Transformation

Returns:

the simplified function

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 UnitaryFunction

Returns:

this function as an OutputFunction