NamedFunction Class Documentation
classNamedFunction : FunctionNamespace: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
Uses types
Constructor & Destructor Documentation
NamedFunction
NamedFunction(Stringname)Parameters
name: Stringthe name of the function.
Create a named function with the given name, e.g. Default
Member Function Documentation
DLIntern
Parameters
cs: Function
Returns:
FunctionDisposeChildren
voidDisposeChildren()Returns:
void[static initializer]
static void[static initializer]()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:
a list of the result values from the functionApply 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 voiddelete(Booleandisposing)Parameters
disposing: Boolean
Returns:
synchronized voiddelete
synchronized voiddelete()Returns:
synchronized voidequals
booleanequals(Objectrhs)Parameters
rhs: Object
Returns:
booleanfinalize
voidfinalize()Returns:
voidgetDomain
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
intgetNInputs()Returns:
intThe number of inputs to the function.Throws a 'not implemented' exception for named functions.
getNOutputs
intgetNOutputs()Returns:
intThe number of outputs from the function.Throws a 'not implemented' exception for named functions.
getName
StringgetName()Returns:
StringThe 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.
makeDefault
static NamedFunctionmakeDefault()Returns:
NamedFunctionmakeIdentity
static NamedFunctionmakeIdentity()Returns:
NamedFunctionprivate_delete
synchronized voidprivate_delete()Returns:
synchronized voidsameTypeEquals
booleansameTypeEquals(NamedFunctionother)Parameters
other: NamedFunction
Returns:
booleansetDomain
voidsetDomain(java.util.List< Double >domain)Parameters
domain: java.util.List< Double >
Returns:
voidThe 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
voidsetRange(java.util.List< Double >range)Parameters
range: java.util.List< Double >
Returns:
voidThe 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
StringtoString()Returns:
StringConvert the function to a displayable string.