Package etomica.math.function

Class FunctionChain

java.lang.Object

etomica.math.function.FunctionChain

All Implemented Interfaces:

Function, IFunction, java.io.Serializable

public final class FunctionChain
extends java.lang.Object
implements Function, java.io.Serializable

Defines a function as chain of other functions. For example, defines F(x) = f3(f2(f1(x))). Defaults to identity function if no subfunctions are specified.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	FunctionChain.Link	Class for making linked list of Functions

Nested classes/interfaces inherited from interface etomica.math.function.Function

Function.Abs, Function.Chop, Function.Constant, Function.Exp, Function.Identity, Function.Linear, Function.Log, Function.Reciprocal, Function.Sqrt

Constructor Summary

Constructors

Constructor	Description
FunctionChain()

Method Summary

Modifier and Type	Method	Description
void	add(IFunction newF)	Adds the given function to the chain of functions.
double	df(int n, double x)	Evaluates derivative via the chain rule.
double	f(double x)	Calculates function by applying subfunctions, in the ordered they were added.
double	inverse(double f)	Inverts function by calling inverse methods of subfunctions, in reverse order of their addition.
void	remove(IFunction f)	Removes the given function from the chain.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FunctionChain

public FunctionChain()

Method Detail

f

public double f(double x)

Calculates function by applying subfunctions, in the ordered they were added.

Specified by:

f in interface IFunction

inverse

public double inverse(double f)

Inverts function by calling inverse methods of subfunctions, in reverse order of their addition.

df

public double df(int n,
                 double x)

Evaluates derivative via the chain rule.

add

public void add(IFunction newF)

Adds the given function to the chain of functions. Functions are applied sequentially in the order they are added. First function added is the first applied, and so on.

remove

public void remove(IFunction f)

Removes the given function from the chain. If the function is not in the chain, returns with no error or warning message. If function is present multiple times in chain, remove the first one added.