DoubleFunctional Class

Class DoubleFunctional represents a double precision functional.

Inheritance Hierarchy

SystemObject
  CenterSpace.NMath.CoreDoubleMultiVariableFunction
    CenterSpace.NMath.CoreDoubleFunctional
      CenterSpace.NMath.CoreDoubleFunctionalDelegate

Namespace: CenterSpace.NMath.Core
Assembly: NMath (in NMath.dll) Version: 7.4

Syntax

C++

Copy

public abstract class DoubleFunctional : DoubleMultiVariableFunction

Public MustInherit Class DoubleFunctional
	Inherits DoubleMultiVariableFunction

public ref class DoubleFunctional abstract : public DoubleMultiVariableFunction

[<AbstractClassAttribute>]
type DoubleFunctional = 
    class
        inherit DoubleMultiVariableFunction
    end

The DoubleFunctional type exposes the following members.

Constructors

	Name	Description
	DoubleFunctional(DoubleFunctional)	Copy constructor. Constructs a deep copy of the input DoubleFunctional.
	DoubleFunctional(Int32)	Constructs a DoubleFunctional object whose domain has the specified dimension.

Top

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

Top

Methods

	Name	Description
	Clone	ICloneable method. Not implemented here. Deriving classes must implement if desired. (Inherited from DoubleMultiVariableFunction)
	Evaluate(Double)	Evaluates the functional at the given point.
	Evaluate(DoubleVector)	Evaluates the functional at the given point.
	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. (Overrides DoubleMultiVariableFunctionEvaluate(DoubleVector, DoubleVector))
	Gradient(DoubleVector)	Calculates the gradient of this functional.
	Gradient(DoubleVector, DoubleVector)	Calculates the gradient of this functional using a central difference methods. Deriving classes may override this method.
	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. (Overrides DoubleMultiVariableFunctionJacobian(DoubleVector, DoubleMatrix))

Top

Operators

	Name	Description
	Addition(Double, DoubleFunctional)	Functional scalar addition operator. Returns a functional representing the sum of a functional and a scalar.
	Addition(DoubleFunctional, DoubleFunctional)	Functional addition operator. Returns a functional which is the sum of two functionals.
	Addition(DoubleFunctional, Double)	Functional scalar addition operator. Returns a functional representing the sum of a functional and a scalar.
	Division(DoubleFunctional, Double)	Functional scalar division operator. Returns a functional representing the quotient of a functional by a scalar.
	Multiply(Double, DoubleFunctional)	Functional scalar multiplication operator. Returns a functional representing the product of a functional and a scalar.
	Multiply(DoubleFunctional, Double)	Functional scalar multiplication operator. Returns a functional representing the product of a functional and a scalar.
	Subtraction(Double, DoubleFunctional)	Functional scalar subtraction operator. Returns a functional representing the difference of a functional and a scalar.
	Subtraction(DoubleFunctional, DoubleFunctional)	Functional subtraction operator. Returns a functional which is the difference of two functionals.
	Subtraction(DoubleFunctional, Double)	Functional scalar subtraction operator. Returns a functional representing the difference of a functional and a scalar.
	UnaryNegation(DoubleFunctional)	Negation operator.

Top

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)

Top

Remarks

A functional is a map from Rn to R. That is, it's a real valued function of a vector valued variable. Implementing classes must override the Evaluate method and may optionally override the Gradient method. If the Gradient method is not overridden by deriving subclasses, the default implementation uses a central difference algorithm to approximate the gradient.

Reference

CenterSpace.NMath.Core Namespace