DoubleMultiVariableFunction Class

Abstract class for representing a multi-variable function.

Inheritance Hierarchy

SystemObject
CenterSpace.NMath.CoreDoubleMultiVariableFunction
More

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

Syntax

C++

Copy

[SerializableAttribute]
public abstract class DoubleMultiVariableFunction : ICloneable

<SerializableAttribute>
Public MustInherit Class DoubleMultiVariableFunction
	Implements ICloneable

[SerializableAttribute]
public ref class DoubleMultiVariableFunction abstract : ICloneable

[<AbstractClassAttribute>]
[<SerializableAttribute>]
type DoubleMultiVariableFunction = 
    class
        interface ICloneable
    end

The DoubleMultiVariableFunction type exposes the following members.

Constructors

	Name	Description
	DoubleMultiVariableFunction	No argument constructor. Behavior undefined.
	DoubleMultiVariableFunction(DoubleMultiVariableFunction)	Copy constructor. Constructs a deep copy of the input DoubleMultiVariableFunction.
	DoubleMultiVariableFunction(Int32, Int32)	Constructs a DoubleMultiVariableFunction instance representing a function that maps an xDimension space a yDimensional space.

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.
	XDimension	Gets and sets the dimension of the function domain.
	YDimension	Gets and sets the dimension of the function range.

Top

Methods

	Name	Description
	Clone	ICloneable method. Not implemented here. Deriving classes must implement if desired.
	Evaluate(Double)	Evaluate the function at the point x.
	Evaluate(DoubleMatrix, DoubleMatrix)	Evaluate the function at the points X and place the results in Y.
	Evaluate(DoubleVector, DoubleVector)	Evaluate the function at the point x and place the result in y.
	Jacobian(Double)	Evaluates the Jacobian of the function at the given point.
	Jacobian(DoubleVector, DoubleMatrix)	Virtual method for evaluating the Jacobian of the function at the given point.

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.
	xDimension_	Dimension of the function domain.
	yDimension_	Dimension of the function range.

Top

Remarks

Instances override the Evaluate method and, optionally the Jacobian method. If the Jacobian method is not overridden a central differences approximation will be used to calculate the Jacobian.

Reference

CenterSpace.NMath.Core Namespace

Inheritance Hierarchy

SystemObject
  CenterSpace.NMath.CoreDoubleMultiVariableFunction
    CenterSpace.NMath.CoreDoubleFunctional
    CenterSpace.NMath.CoreLagrangianFunctionLagrangianGradientFunction
    CenterSpace.NMath.CoreMultipleCurveFitResidual
    CenterSpace.NMath.CoreMultiVariableFunctionFitterMResidualFunction
    CenterSpace.NMath.CoreOneVariableFunctionFitterMCurveFitResidualFunction