Click or drag to resize

DoubleMultiVariableFunction Class

Abstract class for representing a multi-variable function.
Inheritance Hierarchy

Namespace:  CenterSpace.NMath.Core
Assembly:  NMath (in NMath.dll) Version: 7.3
Syntax
[SerializableAttribute]
public abstract class DoubleMultiVariableFunction : ICloneable

The DoubleMultiVariableFunction type exposes the following members.

Constructors
  NameDescription
Protected methodDoubleMultiVariableFunction
No argument constructor. Behavior undefined.
Public methodDoubleMultiVariableFunction(DoubleMultiVariableFunction)
Copy constructor. Constructs a deep copy of the input DoubleMultiVariableFunction.
Public methodDoubleMultiVariableFunction(Int32, Int32)
Constructs a DoubleMultiVariableFunction instance representing a function that maps an xDimension space a yDimensional space.
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.
Public propertyXDimension
Gets and sets the dimension of the function domain.
Public propertyYDimension
Gets and sets the dimension of the function range.
Top
Methods
  NameDescription
Public methodClone
ICloneable method. Not implemented here. Deriving classes must implement if desired.
Public methodEvaluate(Double)
Evaluate the function at the point x.
Public methodEvaluate(DoubleMatrix, DoubleMatrix)
Evaluate the function at the points X and place the results in Y.
Public methodEvaluate(DoubleVector, DoubleVector)
Evaluate the function at the point x and place the result in y.
Public methodJacobian(Double)
Evaluates the Jacobian of the function at the given point.
Public methodJacobian(DoubleVector, DoubleMatrix)
Virtual method for evaluating the Jacobian of the function at the given point.
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.
Protected fieldxDimension_
Dimension of the function domain.
Protected fieldyDimension_
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.
See Also