NMath Reference Guide

## Double |

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

Inheritance Hierarchy

SystemObject

CenterSpace.NMath.CoreDoubleMultiVariableFunction

CenterSpace.NMath.CoreDoubleFunctional

CenterSpace.NMath.CoreDoubleFunctionalDelegate

CenterSpace.NMath.CoreDoubleMultiVariableFunction

CenterSpace.NMath.CoreDoubleFunctional

CenterSpace.NMath.CoreDoubleFunctionalDelegate

Syntax

The DoubleFunctionalDelegate type exposes the following members.

Constructors

Name | Description | |
---|---|---|

DoubleFunctionalDelegate | Constructs an empty DoubleFunctionalDelegate instance. Behavior undefined. | |

DoubleFunctionalDelegate(DoubleFunctionalDelegate) | Copy constructor. Constructs a deep copy of the input DoubleFunctionalDelegate. | |

DoubleFunctionalDelegate(Int32, FuncDoubleVector, Double) | Constructs a DoubleFunctionalDelegate object from the given delegate and domain dimension. | |

DoubleFunctionalDelegate(Int32, FuncDoubleVector, Double, ActionDoubleVector, DoubleVector) | Constructs a DoubleFunctionalDelegate object from the given delegate and domain dimension. | |

DoubleFunctionalDelegate(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. |

Properties

Name | Description | |
---|---|---|

CentralDifferenceDelta |
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) | |

Function | Gets and sets the delegate used to evaluate the functional. | |

GradientFunction | Gets and sets the delegate used to evaluate the gradient. | |

XDimension |
Gets and sets the dimension of the function domain.
(Inherited from DoubleMultiVariableFunction) | |

YDimension |
Gets and sets the dimension of the function range.
(Inherited from DoubleMultiVariableFunction) |

Methods

Name | Description | |
---|---|---|

Clone |
Creates a deep copy of self.
(Overrides DoubleMultiVariableFunctionClone) | |

Evaluate(Double) |
Evaluates the functional at the given point.
(Inherited from DoubleFunctional) | |

Evaluate(DoubleVector) |
Evaluates the functional at a given point.
(Overrides DoubleFunctionalEvaluate(DoubleVector)) | |

Evaluate(DoubleMatrix, DoubleMatrix) |
Evaluate the function at the points X and place the results in
Y.
(Inherited from DoubleMultiVariableFunction) | |

Evaluate(DoubleVector, DoubleVector) |
Vector-vector form of the evaluate function. Part of the base class
DoubleMultiVariableFunction interface.
(Inherited from DoubleFunctional) | |

Gradient(DoubleVector) |
Calculates the gradient of this functional.
(Inherited from DoubleFunctional) | |

Gradient(DoubleVector, DoubleVector) |
Calculates the gradient of this functional.
(Overrides DoubleFunctionalGradient(DoubleVector, DoubleVector)) | |

Jacobian(Double) |
Evaluates the Jacobian of the function at the given point.
(Inherited from DoubleMultiVariableFunction) | |

Jacobian(DoubleVector, DoubleMatrix) |
Computes the jacobian of this functional at the specified point.
(Inherited from DoubleFunctional) |

Fields

Name | Description | |
---|---|---|

centralDifferenceDelta_ |
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) | |

xDimension_ |
Dimension of the function domain.
(Inherited from DoubleMultiVariableFunction) | |

yDimension_ |
Dimension of the function range.
(Inherited from DoubleMultiVariableFunction) |

See Also