Package functions.unitary.transforms

Class Differential

Object

GeneralFunction

UnitaryFunction

Transformation

Differential

All Implemented Interfaces:

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

public class Differential
extends Transformation

The Differential class is used as an intermediary for operations related to parsing derivatives and integrals. Operations such as execute() and Evaluable.evaluate(Map) are NOT SUPPORTED, as all instances of this class should be converted to other transforms before evaluation. If evaluation or execution of this class is ever attempted by the CAS, please raise an issue on the GitHub repository.

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
Differential(Variable operand)	Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives, using a Variable
Differential(GeneralFunction variable)	Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives, assuming that the operand is a variable Variable
Differential(String respectTo)	Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives

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)	Differentiation is not supported by this class, as it is purely an intermediary
GeneralFunction	execute()	Execution is not supported by this class, as it is purely an intermediary
GeneralFunction	getDerivative(String varID)	Evaluation is not supported by this class, as it is purely an intermediary
UnitaryFunction	getInstance(GeneralFunction function)	Returns a new instance of this UnitaryFunction
UnitaryFunction	simplify()	Returns this GeneralFunction, simplified
UnitaryFunction	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

Differential

public Differential(String respectTo)

Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives

Parameters:

respectTo - the variable that the differential is with respect to

Differential

public Differential(Variable operand)

Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives, using a Variable

Parameters:

operand - the variable that the differential is with respect to

Differential

public Differential(GeneralFunction variable)

Constructs a new Differential, which is sometimes used as an intermediary for integrals and derivatives, assuming that the operand is a variable Variable

Parameters:

variable - the variable that the differential is with respect to

Throws:

ClassCastException - if the operand is not an instance of Variable

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)

Evaluation is not supported by this class, as it is purely an intermediary

Parameters:

varID - The variable that the function's derivative is taken with respect to

Returns:

nothing, because this method will always throw an error

Throws:

DerivativeDoesNotExistException - whenever this method is called

evaluate

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

Differentiation is not supported by this class, as it is purely an intermediary

Parameters:

variableValues - The values of each variable

Returns:

nothing, because this method will always throw an error

Throws:

UnsupportedOperationException - whenever this method is called

simplify

public UnitaryFunction 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

simplifyInternal

public UnitaryFunction 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()

Execution is not supported by this class, as it is purely an intermediary

Specified by:

execute in class Transformation

Returns:

nothing, because this method will always throw an error

Throws:

UnsupportedOperationException - whenever this method is called

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