NamedFunction Class Documentation

class NamedFunction : Function

Namespace: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.

Uses types

Property Documentation

Default

static Function Default[get]

Gets the Default named function.

A Function representing the Default named function.

Domain

System.Collections.Generic.IList< System.Double > Domain[get, set]

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.

Identity

static Function Identity[get]

Gets the Identity named function.

A Function representing the Identity named function, which returns its input values unchanged.

NInputs

int NInputs[get]

The number of inputs to the function.

NOutputs

int NOutputs[get]

The number of outputs from the function.

Name

string Name[get]

The name of the function.

Range

System.Collections.Generic.IList< System.Double > Range[get, set]

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.

Member Function Documentation

Apply

override System.Collections.Generic.IList< System.Double > Apply(System.Collections.Generic.IList< System.Double > args)

Parameters

args: System.Collections.Generic.IList< System.Double >

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

Returns:

override System.Collections.Generic.IList< System.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.

Dispose

void Dispose()

Returns:

void

Equals

override bool Equals(object obj)

Parameters

obj: object

Returns:

override bool

ToString

override string ToString()

Returns:

override string

The name of this NamedFunction.

Convert the function to a displayable string.

operator!=

static bool operator!=(Function a, Function b)

Parameters

a: Function

The first Function to compare.

b: Function

The second Function to compare.

Returns:

bool

true if the two Functions are not equal; otherwise, false.

Tests two Function objects for inequality.

operator==

static bool operator==(Function a, Function b)

Parameters

a: Function

The first Function to compare.

b: Function

The second Function to compare.

Returns:

bool

true if the two Functions are equal; otherwise, false.

Tests two Function objects for equality.