com.singularsys.extensions.statistical

Class Ranks

java.lang.Object

com.singularsys.jep.functions.PostfixMathCommand

com.singularsys.jep.functions.NaryFunction

com.singularsys.extensions.statistical.Ranks

All Implemented Interfaces:

JepComponent, PostfixMathCommandI, java.io.Serializable

public class Ranks
extends NaryFunction
implements JepComponent

PostfixMathCommand to return the rank of all the elements in a list. Result of an array of doubles, one per element of the input. Various conventions for calculating ranks can be used

Author:

rich

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ranks.Type Type of Rank to calculate.

Field Summary

Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand

curNumberOfParameters, name, NaN, numberOfParameters

Constructor Summary

Constructors

Constructor and Description
Ranks(Ranks.Type type, boolean descending, FieldI f) Construct the rank function.

Method Summary

Modifier and Type	Method and Description
boolean	checkNumberOfParameters(int n) Checks the number of parameters of the function.
java.lang.Object	eval(java.lang.Object[] args) Evaluate the function
JepComponent	getLightWeightInstance() Gets a light-weight instance suitable for using in multiple threads.
void	init(Jep jep) Initialize the component.

Methods inherited from class com.singularsys.jep.functions.NaryFunction

run

Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand

asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Ranks

public Ranks(Ranks.Type type,
             boolean descending,
             FieldI f)

Construct the rank function.

Parameters:

type - Method used to calculate ranks, Type.COMPETITION is standard

descending - whether ranks are calculated in descending (standard) or ascending order. In descending order the highest term has a rank of 1.

f - field

Method Detail

checkNumberOfParameters

public boolean checkNumberOfParameters(int n)

Description copied from class: PostfixMathCommand

Checks the number of parameters of the function. Functions which set numberOfParameter=-1 should overload this method

Specified by:

checkNumberOfParameters in interface PostfixMathCommandI

Overrides:

checkNumberOfParameters in class PostfixMathCommand

Parameters:

n - number of parameters function will be called with.

Returns:

false if an illegal number of parameters is supplied, true otherwise.

eval

public java.lang.Object eval(java.lang.Object[] args)
                      throws EvaluationException

Description copied from class: NaryFunction

Evaluate the function

Specified by:

eval in class NaryFunction

Parameters:

args - arguments to the function

Returns:

value returned by the function

Throws:

EvaluationException - if the calculation cannot be performed

init

public void init(Jep jep)

Description copied from interface: JepComponent

Initialize the component. This methods is called whenever a component is added to Jep. Hence it allows components to keep track of the other components they may rely on.

Specified by:

init in interface JepComponent

Parameters:

jep - the current Jep instance

getLightWeightInstance

public JepComponent getLightWeightInstance()

Description copied from interface: JepComponent

Gets a light-weight instance suitable for using in multiple threads.

Specified by:

getLightWeightInstance in interface JepComponent

Returns:

either an new instance, or 'this'.