Package com.singularsys.extensions.polynomials

Interface PNodeI

All Superinterfaces:

Comparable<PNodeI>, Serializable

All Known Implementing Classes:

AbstractPNode, Monomial, PConstant, PFunction, Polynomial, POperator, PVariable

public interface PNodeI
extends Comparable<PNodeI>, Serializable

An element in a polynomial representation of an expression. Provides the main routines for creating, comparing and manipulating polynomials.

Author:

Rich Morris Created on 17-Dec-2004

Method Summary

Modifier and Type	Method	Description
PNodeI	add(PNodeI node)	Adds a node to this one.
int	compareTo(PNodeI fun)	Compares this expression to argument.
void	convertToPolyArray(String var, Map<Integer,PNodeI> polyArray)	Internal method for extracting coefficients
PNodeI	div(PNodeI node)	Divides this by the argument.
boolean	equals(Object o)
boolean	equalsPNode(PNodeI node)	True is nodes represent the same parse trees
PNodeI	expand()	complete expansion. (1+x)^2 --> 1+2*x+x^2
PNodeI	invert()	inverts node i.e. 1/x
boolean	isOne()	True if node represents one
boolean	isZero()	True if node represents zero
PNodeI	mul(PNodeI node)	Multiplies this by the argument.
PNodeI	negate()	negates node i.e.
PNodeI	pow(PNodeI node)	Raise this to the argument.
PNodeI	sub(PNodeI node)	Subtracts the argument from this.
PNodeI	substitute(PVariable var, PNodeI sub)	Substitute all occurrence of variable with its replacement.
Node	toCompactNode()	Converts to a more efficient Jep representation.
Node	toNode()	Converts the node to standard Jep format.
String	toString()	Produces a string representation of the argument.
String	toString(NumberFormat nf)

Method Details

add

PNodeI add(PNodeI node)
    throws ParseException

Adds a node to this one.

Throws:

ParseException

sub

PNodeI sub(PNodeI node)
    throws ParseException

Subtracts the argument from this.

Throws:

ParseException

negate

PNodeI negate()
       throws ParseException

negates node i.e. -x

Throws:

ParseException

mul

PNodeI mul(PNodeI node)
    throws ParseException

Multiplies this by the argument.

Throws:

ParseException

div

PNodeI div(PNodeI node)
    throws ParseException

Divides this by the argument.

Throws:

ParseException

pow

PNodeI pow(PNodeI node)
    throws ParseException

Raise this to the argument.

Throws:

ParseException

invert

PNodeI invert()
       throws ParseException

inverts node i.e. 1/x

Throws:

ParseException

equalsPNode

boolean equalsPNode(PNodeI node)

True is nodes represent the same parse trees

substitute

PNodeI substitute(PVariable var,
 PNodeI sub)
           throws ParseException

Substitute all occurrence of variable with its replacement.

Parameters:

var - the variable

sub - the replacement

Returns:

Throws:

ParseException

equals

boolean equals(Object o)

Overrides:

equals in class Object

compareTo

int compareTo(PNodeI fun)

Compares this expression to argument. Uses a total ordering of expressions. Returns positive if this node comes after the argument.

Specified by:

compareTo in interface Comparable<PNodeI>

toNode

Node toNode()
     throws ParseException

Converts the node to standard Jep format.

Throws:

ParseException

toCompactNode

Node toCompactNode()
            throws ParseException

Converts to a more efficient Jep representation. Exploits the feature of the Add and Multiply operators which allow the operators to work as n-ary operators. Order of elements is altered to make for more efficient operation.

Returns:

Throws:

ParseException

toString

String toString()

Produces a string representation of the argument.

Overrides:

toString in class Object

toString

String toString(NumberFormat nf)

isZero

boolean isZero()

True if node represents zero

isOne

boolean isOne()

True if node represents one

expand

PNodeI expand()
       throws ParseException

complete expansion. (1+x)^2 --> 1+2*x+x^2

Throws:

ParseException

convertToPolyArray

void convertToPolyArray(String var,
 Map<Integer,PNodeI> polyArray)
                 throws ParseException

Internal method for extracting coefficients

Parameters:

var - variable name

polyArray - results added to this map

Throws:

ParseException