jtr.lang.functions.impl
Class BaseFunction

java.lang.Object
  jtr.lang.functions.impl.BaseFunction

Direct Known Subclasses:

Exponential, Gaussian, Poissonian, UniformDouble, UniformInt, UniformLong

public abstract class BaseFunction
extends java.lang.Object

This base abstract class contains useful methods for specialized functions.

Since:

5.0

Version:

5.0

Author:

frusso

Constructor Summary

BaseFunction()

Method Summary

protected void	checkPreconditions(java.lang.String[] actualParameters) Checks whether the provided actual parameters satisfy the requiremenets in terms of nullability and number.
protected abstract java.lang.String	getErrorMsg() An error message that must be provided to the user.
protected abstract int	getMaxNumberOfArguments() Returns the maximum number of expected parameters.
protected abstract int	getMinNumberOfArguments() Returns the minimum number of expected parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseFunction

public BaseFunction()

Method Detail

checkPreconditions

protected void checkPreconditions(java.lang.String[] actualParameters)

Checks whether the provided actual parameters satisfy the requiremenets in terms of nullability and number.

Parameters:

actualParameters -

getMinNumberOfArguments

protected abstract int getMinNumberOfArguments()

Returns the minimum number of expected parameters.

Returns:

getMaxNumberOfArguments

protected abstract int getMaxNumberOfArguments()

Returns the maximum number of expected parameters.

Returns:

getErrorMsg

protected abstract java.lang.String getErrorMsg()

An error message that must be provided to the user.

Returns: