org.jscience.mathematics.analysis.expressions
Class Auxiliary

java.lang.Object
  org.jscience.mathematics.analysis.expressions.Auxiliary

All Implemented Interfaces:

java.io.Serializable, Expression, JavaExpressible, Named, XMLExpressible

public class Auxiliary
extends java.lang.Object
implements Expression, Named

Class representing an Auxiliary object. An Auxiliary wraps an Expression and gives it a symbolic name. The optimize method returns a new Auxiliary with the same name but with an optimized version of the underlying Expression.

See Also:

Expression, Serialized Form

Field Summary

static boolean

deepDefinition The boolean deepDefinition defines how the String returning methods of Auxiliary works.

Constructor Summary

Auxiliary(java.lang.String name, Expression expr)
Creates an Auxiliary object.

Method Summary

java.lang.Object	clone() DOCUMENT ME!
boolean	contains(Expression e) DOCUMENT ME!
Expression	diff(NamedDataExpression x) DOCUMENT ME!
boolean	equals(java.lang.Object e) DOCUMENT ME!
double	eval() DOCUMENT ME!
Expression	factor(Expression e) DOCUMENT ME!
java.util.List	getElements() DOCUMENT ME!
Expression	getExpression() Returns the Expression wrapped by the Auxiliary.
java.lang.String	getName() Returns the name of the Auxiliary.
boolean	isDifferentiable() DOCUMENT ME!
boolean	isExpandable() DOCUMENT ME!
Expression	isolate(Expression e) DOCUMENT ME!
Expression	isolate(Expression f, Expression e) DOCUMENT ME!
Expression	optimize() DOCUMENT ME!
Expression	replace(Expression a, Expression b) DOCUMENT ME!
java.lang.String	toJava() DOCUMENT ME!
java.lang.String	toString() DOCUMENT ME!
java.lang.String	toTaylorMap() DOCUMENT ME!
java.lang.String	toXML() DOCUMENT ME!

Methods inherited from class java.lang.Object

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

Field Detail

deepDefinition

public static boolean deepDefinition

The boolean deepDefinition defines how the String returning methods of Auxiliary works. If false only the name is returned.

Constructor Detail

Auxiliary

public Auxiliary(java.lang.String name,
                 Expression expr)

Creates an Auxiliary object.

Parameters:

name - The name the Auxiliary object should be characterized by.

expr - The Expression the Auxiliary represents.

Method Detail

getExpression

public Expression getExpression()

Returns the Expression wrapped by the Auxiliary.

Returns:

DOCUMENT ME!

getName

public java.lang.String getName()

Returns the name of the Auxiliary.

Specified by:

getName in interface Named

Returns:

DOCUMENT ME!

eval

public double eval()

DOCUMENT ME!

Specified by:

eval in interface Expression

Returns:

DOCUMENT ME!

diff

public Expression diff(NamedDataExpression x)

DOCUMENT ME!

Specified by:

diff in interface Expression

Parameters:

x - DOCUMENT ME!

Returns:

DOCUMENT ME!

replace

public Expression replace(Expression a,
                          Expression b)

DOCUMENT ME!

Specified by:

replace in interface Expression

Parameters:

a - DOCUMENT ME!

b - DOCUMENT ME!

Returns:

DOCUMENT ME!

equals

public boolean equals(java.lang.Object e)

DOCUMENT ME!

Overrides:

equals in class java.lang.Object

Parameters:

e - DOCUMENT ME!

Returns:

DOCUMENT ME!

isDifferentiable

public boolean isDifferentiable()

DOCUMENT ME!

Specified by:

isDifferentiable in interface Expression

Returns:

DOCUMENT ME!

See Also:

Expression.diff(NamedDataExpression)

isExpandable

public boolean isExpandable()

DOCUMENT ME!

Specified by:

isExpandable in interface Expression

Returns:

DOCUMENT ME!

optimize

public Expression optimize()

DOCUMENT ME!

Specified by:

optimize in interface Expression

Returns:

DOCUMENT ME!

clone

public java.lang.Object clone()

DOCUMENT ME!

Overrides:

clone in class java.lang.Object

Returns:

DOCUMENT ME!

toJava

public java.lang.String toJava()

DOCUMENT ME!

Specified by:

toJava in interface Expression

Specified by:

toJava in interface JavaExpressible

Returns:

DOCUMENT ME!

toTaylorMap

public java.lang.String toTaylorMap()

DOCUMENT ME!

Specified by:

toTaylorMap in interface Expression

Returns:

DOCUMENT ME!

toString

public java.lang.String toString()

DOCUMENT ME!

Overrides:

toString in class java.lang.Object

Returns:

DOCUMENT ME!

getElements

public java.util.List getElements()

DOCUMENT ME!

Specified by:

getElements in interface Expression

Returns:

DOCUMENT ME!

contains

public boolean contains(Expression e)

DOCUMENT ME!

Specified by:

contains in interface Expression

Parameters:

e - DOCUMENT ME!

Returns:

DOCUMENT ME!

isolate

public Expression isolate(Expression e)

DOCUMENT ME!

Specified by:

isolate in interface Expression

Parameters:

e - DOCUMENT ME!

Returns:

DOCUMENT ME!

isolate

public Expression isolate(Expression f,
                          Expression e)

DOCUMENT ME!

Specified by:

isolate in interface Expression

Parameters:

f - DOCUMENT ME!

e - DOCUMENT ME!

Returns:

DOCUMENT ME!

factor

public Expression factor(Expression e)

DOCUMENT ME!

Specified by:

factor in interface Expression

Parameters:

e - DOCUMENT ME!

Returns:

DOCUMENT ME!

toXML

public java.lang.String toXML()

DOCUMENT ME!

Specified by:

toXML in interface Expression

Specified by:

toXML in interface XMLExpressible

Returns:

DOCUMENT ME!