com.datalogics.PDFL

Class NamedFunction

java.lang.Object

com.datalogics.PDFL.Function

com.datalogics.PDFL.NamedFunction

public class NamedFunction
extends Function

Defines a function currently in use. A Function is a process; it takes input values and manipulates them to create output values.

Field Summary

Fields inherited from class com.datalogics.PDFL.Function

DEFAULT, IDENTITY

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.Double>	apply(java.util.List<java.lang.Double> args) Apply the function to supplied input values.
void	delete()
boolean	equals(java.lang.Object rhs)
java.util.List<java.lang.Double>	getDomain() The domain of the function.
java.lang.String	getName() The name of the function.
int	getNInputs() The number of inputs to the function. Throws a 'not implemented' exception for named functions.
int	getNOutputs() The number of outputs from the function. Throws a 'not implemented' exception for named functions.
java.util.List<java.lang.Double>	getRange() The range of the function.
void	setDomain(java.util.List<java.lang.Double> domain) The domain of the function.
void	setRange(java.util.List<java.lang.Double> range) The range of the function.
java.lang.String	toString() Convert the function to a displayable string.

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

delete

public void delete()

Overrides:

delete in class Function

equals

public boolean equals(java.lang.Object rhs)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Convert the function to a displayable string.

Overrides:

toString in class Function

getName

public java.lang.String getName()

The name of the function.

getDomain

public java.util.List<java.lang.Double> getDomain()

The domain of the function. 2 * m elements, where m is the number of inputs to the function.

Throws a 'not implemented' exception for named functions.

Overrides:

getDomain in class Function

setDomain

public void setDomain(java.util.List<java.lang.Double> domain)

The domain of the function. 2 * m elements, where m is the number of inputs to the function.

Throws a 'not implemented' exception for named functions.

Overrides:

setDomain in class Function

getRange

public java.util.List<java.lang.Double> getRange()

The range of the function. 2 * n elements, where n is the number of outputs from the function.

Throws a 'not implemented' exception for named functions.

Overrides:

getRange in class Function

setRange

public void setRange(java.util.List<java.lang.Double> range)

The range of the function. 2 * n elements, where n is the number of outputs from the function.

Throws a 'not implemented' exception for named functions.

Overrides:

setRange in class Function

getNInputs

public int getNInputs()

The number of inputs to the function. Throws a 'not implemented' exception for named functions.

Overrides:

getNInputs in class Function

getNOutputs

public int getNOutputs()

The number of outputs from the function. Throws a 'not implemented' exception for named functions.

Overrides:

getNOutputs in class Function

apply

public java.util.List<java.lang.Double> apply(java.util.List<java.lang.Double> args)

Apply the function to supplied input values.

For Identity functions, this returns the same inputs. Not defined for any other kinds of named functions.

Overrides:

apply in class Function

Parameters:

args - input values for the function. The number of input values must agree with the number of inputs the function takes.

Returns:

a list of the result values from the function