NamedFunction Class Documentation

class NamedFunction : Function

Namespace:com::datalogics::PDFL

Inherits from:
Function

Detailed Description

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

Referenced by

NamedFunction

Field Documentation

DEFAULT

static DEFAULT

The Default named function.

IDENTITY

static IDENTITY

The Identity named function, which returns its input values unchanged.

Member Function Documentation

apply

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

Parameters

args: java.util.List< Double >

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

Returns:

java.util.List< Double >

a list of the result values from the function

Apply the function to supplied input values.

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

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

equals

boolean equals(Object rhs)

Parameters

rhs: Object

Returns:

boolean

finalize

void finalize()

Returns:

void

getDomain

java.util.List< Double > getDomain()

Returns:

java.util.List< Double >

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.

getNInputs

int getNInputs()

Returns:

int

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

getNOutputs

int getNOutputs()

Returns:

int

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

getName

String getName()

Returns:

String

The name of the function.

getRange

java.util.List< Double > getRange()

Returns:

java.util.List< Double >

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.

setDomain

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

Parameters

domain: java.util.List< Double >

Returns:

void

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.

setRange

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

Parameters

range: java.util.List< Double >

Returns:

void

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.

toString

String toString()

Returns:

String

The name of this NamedFunction.

Convert the function to a displayable string.