Package functions.binary

Class Pow

Object

GeneralFunction

BinaryFunction

Pow

All Implemented Interfaces:

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

public class Pow
extends BinaryFunction

Field Summary

Fields inherited from class BinaryFunction

function1, function2

Fields inherited from class GeneralFunction

derivatives, sortOrder

Constructor Summary

Constructors

Constructor	Description
Pow(GeneralFunction exponent, GeneralFunction base)	Constructs a new Pow

Method Summary

Modifier and Type	Method	Description
Pow	clone()	Returns a clone of this GeneralFunction
Product	distributeExponents()	Returns a Product where the exponent is distributed to each term.
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
Pow	multiplyExponents()	Simplifies instances of a power raised to a power.
GeneralFunction	simplify()	Returns this GeneralFunction, simplified
GeneralFunction	simplifyFOC()	Returns a new Constant of the BinaryFunction evaluated if both operands are a Constant
GeneralFunction	simplifyLogsOfSameBase()	If the exponent is a logarithm with the same base as the Pow, it returns the argument of the logarithm
GeneralFunction	simplifyObviousExponentsAndFOC()	Returns a GeneralFunction where obvious exponents (ex: (x+1)^1 or (x-1)^0) have been simplified and functions of constants (ex: 2^7) are simplified
OutputFunction	toOutputFunction()	Converts this function into an OutputFunction for use in string conversion
GeneralFunction	toSpecialCase()
String	toString()	Returns a String representation of this GeneralFunction
Product	unwrapIntegerPower()	Given a Pow with positive integer exponent, unwraps it into a Product
GeneralFunction	unwrapIntegerPowerSafe()	Given a Pow, checks if the exponent is a positive integer, and if so, applies unwrapIntegerPower()

Methods inherited from class BinaryFunction

compareSelf, equalsFunction, getFunction1, getFunction2, hashCode, iterator, 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

Pow

public Pow(GeneralFunction exponent, GeneralFunction base)

Constructs a new Pow

Parameters:

exponent - The exponent

base - The base

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 Pow 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

simplifyObviousExponentsAndFOC

public GeneralFunction simplifyObviousExponentsAndFOC()

Returns a GeneralFunction where obvious exponents (ex: (x+1)^1 or (x-1)^0) have been simplified and functions of constants (ex: 2^7) are simplified

Returns:

a GeneralFunction where obvious exponents and functions of constants are simplified

simplifyFOC

public GeneralFunction simplifyFOC()

Description copied from class: BinaryFunction

Returns a new Constant of the BinaryFunction evaluated if both operands are a Constant

Overrides:

simplifyFOC in class BinaryFunction

Returns:

a new Constant of the BinaryFunction evaluated if both operands are a Constant

multiplyExponents

public Pow multiplyExponents()

Simplifies instances of a power raised to a power. Example: (x^2)^3 = x^6

Returns:

a Pow where the exponents are multiplied

distributeExponents

public Product distributeExponents()

Returns a Product where the exponent is distributed to each term. Example: (xy)^2 = (x^2)(y^2)

Returns:

a Product with the exponent distributed

unwrapIntegerPowerSafe

public GeneralFunction unwrapIntegerPowerSafe()

Given a Pow, checks if the exponent is a positive integer, and if so, applies unwrapIntegerPower()

Returns:

this or a new unwrapped Product

unwrapIntegerPower

public Product unwrapIntegerPower() throws RuntimeException

Given a Pow with positive integer exponent, unwraps it into a Product

Returns:

a new unwrapped Product

Throws:

RuntimeException - if the exponent is not a positive integer

simplifyLogsOfSameBase

public GeneralFunction simplifyLogsOfSameBase()

If the exponent is a logarithm with the same base as the Pow, it returns the argument of the logarithm

Returns:

the argument of the logarithm in the exponent, if the exponent is a logarithm with the same base as the Pow

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