Class Rank
- java.lang.Object
-
- com.singularsys.jep.functions.PostfixMathCommand
-
- com.singularsys.jep.functions.BinaryFunction
-
- com.singularsys.extensions.statistical.Rank
-
- All Implemented Interfaces:
MatrixFunctionI
,JepComponent
,PostfixMathCommandI
,java.io.Serializable
public class Rank extends BinaryFunction implements JepComponent, MatrixFunctionI
PostfixMathCommand to return the rank of a single number in a list. Various conventions for calculating ranks can be used- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Rank.Type
Type of Rank to calculate.
-
Field Summary
-
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, name, NaN, numberOfParameters
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Dimensions
calcDims(Dimensions... inDims)
Attempts to calculate the dimensions of a result of a PostfixMathCommand.boolean
checkNumberOfParameters(int n)
Checks the number of parameters of the function.java.lang.Object
eval(java.lang.Object val, java.lang.Object data)
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.BinaryFunction
instanceOf, instanceOf, run
-
Methods inherited from class com.singularsys.jep.functions.PostfixMathCommand
asArray, asBool, asDouble, asInt, asLong, asStrictInt, asString, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString, toString
-
-
-
-
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 interfacePostfixMathCommandI
- Overrides:
checkNumberOfParameters
in classPostfixMathCommand
- 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 val, java.lang.Object data) throws EvaluationException
- Specified by:
eval
in classBinaryFunction
- Throws:
EvaluationException
-
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 interfaceJepComponent
- 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 interfaceJepComponent
- Returns:
- either an new instance, null or 'this'.
-
calcDims
public Dimensions calcDims(Dimensions... inDims) throws ParseException
Description copied from interface:MatrixFunctionI
Attempts to calculate the dimensions of a result of a PostfixMathCommand.- Specified by:
calcDims
in interfaceMatrixFunctionI
- Parameters:
inDims
- the dimensions of each argument- Returns:
- the dimension of the result or null if can be calculated
- Throws:
ParseException
- if there is a parse error
-
-