Function Class Documentation

class Function

Namespace:com::datalogics::PDFL

Derived classes:
ExponentialFunction, NamedFunction, PostScriptCalculatorFunction

Detailed Description

A function is a process. A function takes input values and manipulates them to create output values.

Uses types

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

delete

synchronized void delete(Boolean disposing)

Parameters

disposing: Boolean

Returns:

synchronized void

delete

synchronized void delete()

Returns:

synchronized void

finalize

void finalize()

Returns:

void

getDomain

java.util.List< Double > getDomain()

Returns:

java.util.List< Double >

The domain of the function. Contains 2 * m elements, where m is the number of inputs to the function. Each successive pair of elements gives the minimum and maximum values for one of the inputs. Input values to the function are clamped to these minimum and maximum values.

getNInputs

int getNInputs()

Returns:

int

The number of inputs to the function.

getNOutputs

int getNOutputs()

Returns:

int

The number of outputs from the function.

getRange

java.util.List< Double > getRange()

Returns:

java.util.List< Double >

The range of the function. Contains 2 * n elements, where n is the number of outputs from the function. Each successive pair of elements gives the minimum and maximum values for one of the outputs. Output values from the function are clamped to these minimum and maximum values.

setDomain

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

Parameters

domain: java.util.List< Double >

Returns:

void

The domain of the function. Contains 2 * m elements, where m is the number of inputs to the function. Each successive pair of elements gives the minimum and maximum values for one of the inputs. Input values to the function are clamped to these minimum and maximum values.

setRange

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

Parameters

range: java.util.List< Double >

Returns:

void

The range of the function. Contains 2 * n elements, where n is the number of outputs from the function. Each successive pair of elements gives the minimum and maximum values for one of the outputs. Output values from the function are clamped to these minimum and maximum values.

toString

String toString()

Returns:

String

A string representation of the function.

Convert the function to a displayable string.