Package hec.hecmath.computation

Class MathOperation

java.lang.Object

hec.hecmath.computation.MathOperation

All Implemented Interfaces:

Constants, Evaluable, Updatable, UpdatableListener

public class MathOperation
extends Object
implements Constants, Evaluable

Nested Class Summary

Nested classes/interfaces inherited from interface hec.hecmath.computation.Constants

Constants.LogicTestOperator, Constants.MathOperator, Constants.Notation, Constants.Precedence, Constants.QualityOperator, Constants.QualityTestOperator, Constants.TextOperator, Constants.TextTestOperator, Constants.ValueTestOperator

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	allowDenormal
protected static boolean	allowDenormalByDefault
protected Evaluable[]	args
protected boolean	exceptionOnUndefined
protected static boolean	exceptionOnUndefinedByDefault
protected static Map<Constants.MathOperator,String>	nameByOp
protected Constants.MathOperator	op
protected static Map<String,Constants.MathOperator>	opByName
protected boolean	stale
protected boolean	tolerateUndefined
protected static boolean	tolerateUndefinedByDefault
protected Set<UpdatableListener>	updateListeners
protected Object	updateListenersLock
protected Set<Updatable>	updateSources
protected Object	updateSourcesLock
protected double	value

Fields inherited from interface hec.hecmath.computation.Constants

BINARY, CONSTANT, TERNARY, UNARY, VARIADIC

Constructor Summary

Constructors

Constructor	Description
MathOperation(Constants.MathOperator op, boolean persistent, Evaluable... args)
MathOperation(Constants.MathOperator op, boolean persistent, List<? extends Evaluable> args)
MathOperation(Constants.MathOperator op, Evaluable... args)
MathOperation(Constants.MathOperator op, List<? extends Evaluable> args)
MathOperation(String name, boolean persistent, Evaluable... args)
MathOperation(String name, boolean persistent, List<? extends Evaluable> args)
MathOperation(String name, Evaluable... args)
MathOperation(String name, List<? extends Evaluable> args)

Method Summary

Modifier and Type	Method	Description
static int	arity(String name)
static String	arityName(String name)
protected void	compute()
void	dataUpdated(Updatable u)
double	evaluate()
String	evaluateToString()
boolean	getAllowDenormal()
static boolean	getAllowDenormalByDefault()
boolean	getExceptionOnUndefined()
static boolean	getExceptionOnUndefinedByDefault()
String	getName()
static Set<String>	getNames()
int	getPrecedence()
boolean	getTolerateUndefined()
static boolean	getTolerateUndefinedByDefault()
static boolean	isMathOperation(String name)
boolean	isStale()
protected static double	mode(Evaluable[] l, boolean exceptionOnUndefined, boolean tolerateUndefined)
void	notifyListeners()
static int	precedence(String name)
protected static double	quantile(Evaluable[] l, int subsets, int position, boolean exceptionOnUndefined, boolean tolerateUndefined)
void	registerAsListener(Updatable u)
void	registerListener(UpdatableListener listener)
void	setAllowDenormal(boolean setting)
static void	setAllowDenormalByDefault(boolean setting)
void	setExceptionOnUndefined(boolean setting)
static void	setExceptionOnUndefinedByDefault(boolean setting)
void	setTolerateUndefined(boolean setting)
static void	setTolerateUndefinedByDefault(boolean setting)
String	toNotation(Constants.Notation notation)
String	toString()
void	unregisterAsListener()
void	unregisterAsListener(Updatable u)
void	unregisterListener(UpdatableListener listener)

Methods inherited from class java.lang.Object

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

Field Details

tolerateUndefinedByDefault

protected static boolean tolerateUndefinedByDefault

exceptionOnUndefinedByDefault

protected static boolean exceptionOnUndefinedByDefault

allowDenormalByDefault

protected static boolean allowDenormalByDefault

nameByOp

protected static Map<Constants.MathOperator,String> nameByOp

opByName

protected static Map<String,Constants.MathOperator> opByName

value

protected double value

op

protected Constants.MathOperator op

stale

protected boolean stale

args

protected Evaluable[] args

tolerateUndefined

protected boolean tolerateUndefined

exceptionOnUndefined

protected boolean exceptionOnUndefined

allowDenormal

protected boolean allowDenormal

updateListeners

protected Set<UpdatableListener> updateListeners

updateListenersLock

protected Object updateListenersLock

updateSources

protected Set<Updatable> updateSources

updateSourcesLock

protected Object updateSourcesLock

Constructor Details

MathOperation

public MathOperation(String name,
 List<? extends Evaluable> args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(String name,
 Evaluable... args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(Constants.MathOperator op,
 List<? extends Evaluable> args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(Constants.MathOperator op,
 Evaluable... args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(String name,
 boolean persistent,
 List<? extends Evaluable> args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(String name,
 boolean persistent,
 Evaluable... args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(Constants.MathOperator op,
 boolean persistent,
 List<? extends Evaluable> args)
              throws ComputationException

Throws:

ComputationException

MathOperation

public MathOperation(Constants.MathOperator op,
 boolean persistent,
 Evaluable... args)
              throws ComputationException

Throws:

ComputationException

Method Details

getNames

public static Set<String> getNames()

isMathOperation

public static boolean isMathOperation(String name)

arity

public static int arity(String name)

precedence

public static int precedence(String name)

arityName

public static String arityName(String name)

getTolerateUndefinedByDefault

public static boolean getTolerateUndefinedByDefault()

setTolerateUndefinedByDefault

public static void setTolerateUndefinedByDefault(boolean setting)

getExceptionOnUndefinedByDefault

public static boolean getExceptionOnUndefinedByDefault()

setExceptionOnUndefinedByDefault

public static void setExceptionOnUndefinedByDefault(boolean setting)

getAllowDenormalByDefault

public static boolean getAllowDenormalByDefault()

setAllowDenormalByDefault

public static void setAllowDenormalByDefault(boolean setting)

quantile

protected static double quantile(Evaluable[] l,
 int subsets,
 int position,
 boolean exceptionOnUndefined,
 boolean tolerateUndefined)
                          throws ComputationException

Throws:

ComputationException

mode

protected static double mode(Evaluable[] l,
 boolean exceptionOnUndefined,
 boolean tolerateUndefined)
                      throws ComputationException

Throws:

ComputationException

registerListener

public void registerListener(UpdatableListener listener)

Specified by:

registerListener in interface Updatable

unregisterListener

public void unregisterListener(UpdatableListener listener)

Specified by:

unregisterListener in interface Updatable

notifyListeners

public void notifyListeners()

Specified by:

notifyListeners in interface Updatable

registerAsListener

public void registerAsListener(Updatable u)

Specified by:

registerAsListener in interface UpdatableListener

unregisterAsListener

public void unregisterAsListener(Updatable u)

Specified by:

unregisterAsListener in interface UpdatableListener

unregisterAsListener

public void unregisterAsListener()

Specified by:

unregisterAsListener in interface UpdatableListener

dataUpdated

public void dataUpdated(Updatable u)

Specified by:

dataUpdated in interface UpdatableListener

getName

public String getName()

getPrecedence

public int getPrecedence()

isStale

public boolean isStale()

evaluate

public double evaluate()
                throws ComputationException

Specified by:

evaluate in interface Evaluable

Throws:

ComputationException

evaluateToString

public String evaluateToString()
                        throws ComputationException

Specified by:

evaluateToString in interface Evaluable

Throws:

ComputationException

getTolerateUndefined

public boolean getTolerateUndefined()

Specified by:

getTolerateUndefined in interface Evaluable

getExceptionOnUndefined

public boolean getExceptionOnUndefined()

Specified by:

getExceptionOnUndefined in interface Evaluable

getAllowDenormal

public boolean getAllowDenormal()

Specified by:

getAllowDenormal in interface Evaluable

setTolerateUndefined

public void setTolerateUndefined(boolean setting)

Specified by:

setTolerateUndefined in interface Evaluable

setExceptionOnUndefined

public void setExceptionOnUndefined(boolean setting)

Specified by:

setExceptionOnUndefined in interface Evaluable

setAllowDenormal

public void setAllowDenormal(boolean setting)

Specified by:

setAllowDenormal in interface Evaluable

toString

public String toString()

Specified by:

toString in interface Evaluable

Overrides:

toString in class Object

toNotation

public String toNotation(Constants.Notation notation)
                  throws ComputationException

Specified by:

toNotation in interface Evaluable

Throws:

ComputationException

compute

protected void compute()
                throws ComputationException

Throws:

ComputationException