Click or drag to resize

DoubleFunctionalDelegate Class

Class DoubleFunctionalDelegate wraps a functional delegate specified by a delegate in a DoubleFunctional object.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
public class DoubleFunctionalDelegate : DoubleFunctional

The DoubleFunctionalDelegate type exposes the following members.

Constructors
  NameDescription
Public methodDoubleFunctionalDelegate
Constructs an empty DoubleFunctionalDelegate instance. Behavior undefined.
Public methodDoubleFunctionalDelegate(DoubleFunctionalDelegate)
Copy constructor. Constructs a deep copy of the input DoubleFunctionalDelegate.
Public methodDoubleFunctionalDelegate(Int32, FuncDoubleVector, Double)
Constructs a DoubleFunctionalDelegate object from the given delegate and domain dimension.
Public methodDoubleFunctionalDelegate(Int32, FuncDoubleVector, Double, ActionDoubleVector, DoubleVector)
Constructs a DoubleFunctionalDelegate object from the given delegate and domain dimension.
Public methodDoubleFunctionalDelegate(Int32, FuncDoubleVector, Double, Double)
Constructs a DoubleFunctionalDelegate object from the given delegate and uses the given central difference delta value for estimating the gradient using a central difference algorithm.
Top
Properties
  NameDescription
Public propertyCentralDifferenceDelta
Sets the delta for using the central difference method for approximating the Jacobian. The Jacobian will be approximated only if the deriving class does not override the Jacobian method.
(Inherited from DoubleMultiVariableFunction.)
Public propertyFunction
Gets and sets the delegate used to evaluate the functional.
Public propertyGradientFunction
Gets and sets the delegate used to evaluate the gradient.
Public propertyXDimension
Gets and sets the dimension of the function domain.
(Inherited from DoubleMultiVariableFunction.)
Public propertyYDimension
Gets and sets the dimension of the function range.
(Inherited from DoubleMultiVariableFunction.)
Top
Methods
  NameDescription
Public methodClone
Creates a deep copy of self.
(Overrides DoubleMultiVariableFunctionClone.)
Public methodEvaluate(Double)
Evaluates the functional at the given point.
(Inherited from DoubleFunctional.)
Public methodEvaluate(DoubleVector)
Evaluates the functional at a given point.
(Overrides DoubleFunctionalEvaluate(DoubleVector).)
Public methodEvaluate(DoubleMatrix, DoubleMatrix)
Evaluate the function at the points X and place the results in Y.
(Inherited from DoubleMultiVariableFunction.)
Public methodEvaluate(DoubleVector, DoubleVector)
Vector-vector form of the evaluate function. Part of the base class DoubleMultiVariableFunction interface.
(Inherited from DoubleFunctional.)
Public methodGradient(DoubleVector)
Calculates the gradient of this functional.
(Inherited from DoubleFunctional.)
Public methodGradient(DoubleVector, DoubleVector)
Calculates the gradient of this functional.
(Overrides DoubleFunctionalGradient(DoubleVector, DoubleVector).)
Public methodJacobian(Double)
Evaluates the Jacobian of the function at the given point.
(Inherited from DoubleMultiVariableFunction.)
Public methodJacobian(DoubleVector, DoubleMatrix)
Computes the jacobian of this functional at the specified point.
(Inherited from DoubleFunctional.)
Top
Fields
  NameDescription
Protected fieldcentralDifferenceDelta_
Sets the delta for using the central difference method for approximating the Jacobian. The Jacobian will be approximated only if the deriving class does not override the Jacobian method.
(Inherited from DoubleMultiVariableFunction.)
Protected fieldxDimension_
Dimension of the function domain.
(Inherited from DoubleMultiVariableFunction.)
Protected fieldyDimension_
Dimension of the function range.
(Inherited from DoubleMultiVariableFunction.)
Top
See Also