org.nfunk.jep.function

Class Comparative

java.lang.Object

org.nfunk.jep.function.PostfixMathCommand

org.nfunk.jep.function.Comparative

All Implemented Interfaces:

PostfixMathCommandI

Direct Known Subclasses:

ElementComparative

public class Comparative
extends PostfixMathCommand

Implements the comparative operations Caverts should work where arguments are Double, Complex or String for the last two only != and == work. For other types care might be needed. Complex numbers are compared using a tolerance which can be set using setTolerance().

Since:

2.3.0 beta 1 a bit of a rewrite to make sub classing easier, now allows Complex to be compared to Double i.e. 1+0 i == 1., 2.3.0 beta 2 changed the internal lt,gt,le,ge,ne and eq method to return boolean. If this breaks anything use if(lt(obj1,obj2)) inStack.push(new Double(1)); else inStack.push(new Double(0));

Author:

N Funk and R Morris

Field Summary

Fields

Modifier and Type	Field and Description
static int	EQ
static int	GE
static int	GT
protected int	id
static int	LE
static int	LT
static int	NE

Fields inherited from class org.nfunk.jep.function.PostfixMathCommand

curNumberOfParameters, numberOfParameters

Constructor Summary

Constructors

Constructor and Description
Comparative(int id_in) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	eq(Object param1, Object param2)
boolean	ge(Object param1, Object param2)
double	getTolerance() Returns the tolerance used for comparing complex numbers
boolean	gt(Object param1, Object param2)
boolean	le(Object param1, Object param2)
boolean	lt(Object param1, Object param2)
boolean	ne(Object param1, Object param2)
void	run(Stack inStack) Throws an exception because this method should never be called under normal circumstances.
void	setTolerance(double d) Sets the tolerance used for comparing complex numbers

Methods inherited from class org.nfunk.jep.function.PostfixMathCommand

checkNumberOfParameters, checkStack, getNumberOfParameters, setCurNumberOfParameters

Methods inherited from class java.lang.Object

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

Field Detail

id

protected int id

LT

public static final int LT

See Also:

Constant Field Values

GT

public static final int GT

See Also:

Constant Field Values

LE

public static final int LE

See Also:

Constant Field Values

GE

public static final int GE

See Also:

Constant Field Values

NE

public static final int NE

See Also:

Constant Field Values

EQ

public static final int EQ

See Also:

Constant Field Values

Constructor Detail

Comparative

public Comparative(int id_in)

Constructor. Sets the number of parameters to 2. Initializes the tolerance for comparing Complex values.

Parameters:

id_in - The id of the comparative operator.

Method Detail

run

public void run(Stack inStack)
         throws ParseException

Description copied from class: PostfixMathCommand

Throws an exception because this method should never be called under normal circumstances. Each function should use it's own run() method for evaluating the function. This includes popping off the parameters from the stack, and pushing the result back on the stack.

Specified by:

run in interface PostfixMathCommandI

Overrides:

run in class PostfixMathCommand

Throws:

ParseException

lt

public boolean lt(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

gt

public boolean gt(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

le

public boolean le(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

ge

public boolean ge(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

eq

public boolean eq(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

ne

public boolean ne(Object param1,
                  Object param2)
           throws ParseException

Throws:

ParseException

getTolerance

public double getTolerance()

Returns the tolerance used for comparing complex numbers

setTolerance

public void setTolerance(double d)

Sets the tolerance used for comparing complex numbers

Parameters:

d -