ExponentialFunction Class Documentation

class ExponentialFunction : Function

Namespace:com::datalogics::PDFL

Inherits from:
Function

Detailed Description

An interpolation between two output values as input values vary across a domain. For an Exponential Function, the curve between the two values is determined by the exponent N.

Uses types

Function

Constructor & Destructor Documentation

ExponentialFunction

ExponentialFunction(java.util.List< Double > domain, int nOutputs, java.util.List< Double > C0, java.util.List< Double > C1, double N)

Parameters

domain: java.util.List< Double >

the domain of the function. 2 elements.

nOutputs: int

the number of outputs of the function

C0: java.util.List< Double >

the output value when the input value is 0

C1: java.util.List< Double >

the output value when the input value is 1

N: double

the exponential factor, which alters the curve of output values as the input values vary across the domain.

Create an Exponential Function, which is the exponential interpolation between two output values as the input values vary across the domain.

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

getC0

java.util.List< Double > getC0()

Returns:

java.util.List< Double >

The values for the function when the input is 0.0. There must be the same number of values as the number of outputs in the function.

getC1

java.util.List< Double > getC1()

Returns:

java.util.List< Double >

The values for the function when the input is 1.0. There must be the same number of values as the number of outputs in the function.

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.

getN

double getN()

Returns:

double

The exponential factor N.

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.

setC0

void setC0(java.util.List< Double > C0)

Parameters

C0: java.util.List< Double >

Returns:

void

The values for the function when the input is 0.0. There must be the same number of values as the number of outputs in the function.

setC1

void setC1(java.util.List< Double > C1)

Parameters

C1: java.util.List< Double >

Returns:

void

The values for the function when the input is 1.0. There must be the same number of values as the number of outputs in the function.

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.

setN

void setN(double arg0)

Parameters

arg0: double

Returns:

void

The exponential factor N.

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 ExponentialFunction, including the number of inputs and outputs, domain, range, N, C0, and C1 values.

A string value describing the function.