com.singularsys.jep.misc.functions
Class RoundSF

java.lang.Object
  extended by com.singularsys.jep.functions.PostfixMathCommand
      extended by com.singularsys.jep.functions.NaryFunction
          extended by com.singularsys.jep.misc.functions.RoundSF
All Implemented Interfaces:
PostfixMathCommandI, java.io.Serializable

public class RoundSF
extends NaryFunction

Rounds to a specific number of significant figures. The single argument constructor rounds to 16 sf the IEEE 754 decimal64 precision. Conversion is achieved by converting to a BigDecimal with the specific precision.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.singularsys.jep.functions.PostfixMathCommand
curNumberOfParameters, name, NaN, numberOfParameters
 
Constructor Summary
RoundSF()
           
 
Method Summary
 java.math.BigDecimal bigDecValue(java.lang.String val, int sf)
           
 boolean checkNumberOfParameters(int n)
          Checks the number of parameters of the function.
 java.lang.Object eval(java.lang.Object[] args)
          Evaluate the function
 
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, checkStack, getName, getNumberOfParameters, setCurNumberOfParameters, setName, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RoundSF

public RoundSF()
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

bigDecValue

public java.math.BigDecimal bigDecValue(java.lang.String val,
                                        int sf)


Copyright © 2010 Singular Systems http://www.singularsys.com/jep