ExponentialFunction Class Documentation
class ExponentialFunction : FunctionNamespace: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
Constructor & Destructor Documentation
ExponentialFunction
ExponentialFunction(System.Collections.Generic.IList< System.Double > domain, int nOutputs, System.Collections.Generic.IList< System.Double > C0, System.Collections.Generic.IList< System.Double > C1, double N)Parameters
domain: System.Collections.Generic.IList< System.Double >the domain of the function. 2 elements.
nOutputs: intthe number of outputs of the function
C0: System.Collections.Generic.IList< System.Double >the output value when the input value is 0
C1: System.Collections.Generic.IList< System.Double >the output value when the input value is 1
N: doublethe 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.
Property Documentation
C0
System.Collections.Generic.IList< System.Double > C0[get, set]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.
C1
System.Collections.Generic.IList< System.Double > C1[get, set]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.
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.
N
double N[get, set]The exponential factor N.
NInputs
int NInputs[get]The number of inputs to the function.
NOutputs
int NOutputs[get]The number of outputs from 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
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:
System.Collections.Generic.IList< System.Double >a list of the result values from the function
Apply the function to supplied input values
Dispose
void Dispose()Returns:
voidToString
override string ToString()Returns:
override stringA 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.
operator!=
Parameters
Returns:
booltrue if the two Functions are not equal; otherwise, false.
Tests two Function objects for inequality.
operator==
Parameters
Returns:
booltrue if the two Functions are equal; otherwise, false.
Tests two Function objects for equality.