org.pentaho.reporting.libraries.formula.function.math

Class ModFunction

java.lang.Object

org.pentaho.reporting.libraries.formula.function.math.ModFunction

All Implemented Interfaces:

Serializable, Function

public class ModFunction
extends Object
implements Function

This function returns the remainder when one number is divided by another number.

Author:

Cedric Pronzato

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ModFunction()

Method Summary

Modifier and Type	Method and Description
TypeValuePair	evaluate(FormulaContext context, ParameterCallback parameters)
String	getCanonicalName()

Methods inherited from class java.lang.Object

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

Constructor Detail

ModFunction

public ModFunction()

Method Detail

evaluate

public TypeValuePair evaluate(FormulaContext context,
                              ParameterCallback parameters)
                       throws EvaluationException

Specified by:

evaluate in interface Function

Throws:

EvaluationException

getCanonicalName

public String getCanonicalName()

Specified by:

getCanonicalName in interface Function