Package functions.commutative

Class Sum

Object

GeneralFunction

CommutativeFunction

Sum

All Implemented Interfaces:

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

public class Sum
extends CommutativeFunction

Field Summary

Fields inherited from class CommutativeFunction

functions

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Sum(GeneralFunction... functions)	Constructs a new Sum

Method Summary

Modifier and Type	Method	Description
Sum	clone()	Returns a clone of this GeneralFunction
Sum	combineLikeTerms()	Returns a Sum where like terms are added together.
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.
double	getIdentityValue()	Returns the identity of this CommutativeFunction, such as 0 for + or gcd and 1 for * or lcm
CommutativeFunction	getInstance(GeneralFunction... functions)	Returns an instance of this GeneralFunction
protected Collector<CharSequence,?,String>	getJoiningCollector()	Returns a collector used to create the toString of the CommutativeFunction
double	operate(double a, double b)	Performs the operation of this CommutativeFunction on the two inputs
Sum	simplifyInternal()	Simplifies this CommutativeFunction using all methods that are guaranteed to return a CommutativeFunction of the same type
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion

Methods inherited from class CommutativeFunction

compareSelf, equalsFunction, getFunctions, hashCode, iterator, simplify, simplifyConstants, simplifyElements, simplifyIdentity, simplifyPull, simplifyTrivialElement, substituteAll, 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

Sum

public Sum(GeneralFunction... functions)

Constructs a new Sum

Parameters:

functions - the terms being added together

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 CommutativeFunction getInstance(GeneralFunction... functions)

Description copied from class: CommutativeFunction

Returns an instance of this GeneralFunction

Specified by:

getInstance in class CommutativeFunction

Parameters:

functions - the GeneralFunctions that will be acted on

Returns:

an instance of this GeneralFunction

clone

public Sum clone()

Description copied from class: GeneralFunction

Returns a clone of this GeneralFunction

Specified by:

clone in class GeneralFunction

Returns:

a clone of this function

getJoiningCollector

protected Collector<CharSequence,?,String> getJoiningCollector()

Description copied from class: CommutativeFunction

Returns a collector used to create the toString of the CommutativeFunction

Overrides:

getJoiningCollector in class CommutativeFunction

Returns:

a joining collector

simplifyInternal

public Sum simplifyInternal()

Description copied from class: CommutativeFunction

Simplifies this CommutativeFunction using all methods that are guaranteed to return a CommutativeFunction of the same type

Overrides:

simplifyInternal in class CommutativeFunction

Returns:

the simplified CommutativeFunction

combineLikeTerms

public Sum combineLikeTerms()

Returns a Sum where like terms are added together. Ex: 2x+x=3x

Returns:

a Sum where like terms are added together

getIdentityValue

public double getIdentityValue()

Description copied from class: CommutativeFunction

Returns the identity of this CommutativeFunction, such as 0 for + or gcd and 1 for * or lcm

Specified by:

getIdentityValue in class CommutativeFunction

Returns:

the identity of this CommutativeFunction

operate

public double operate(double a, double b)

Description copied from class: CommutativeFunction

Performs the operation of this CommutativeFunction on the two inputs

Specified by:

operate in class CommutativeFunction

Parameters:

a - the first input

b - the second input

Returns:

the operation applied to the inputs

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 CommutativeFunction

Returns:

this function as an OutputFunction