NonlinearModel.FunctionEvaluator Property

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Gets or sets the value callback function that the solver invokes periodically in order to obtain function values for different variable values.

Namespace:  Microsoft.SolverFoundation.Services
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)

Syntax

'Declaration
Public Property FunctionEvaluator As Func
public Func FunctionEvaluator { get; set; }
public:
virtual property Func^ FunctionEvaluator {
    Func^ get () sealed;
    void set (Func^ value) sealed;
}
abstract FunctionEvaluator : Func with get, set
override FunctionEvaluator : Func with get, set
final function get FunctionEvaluator () : Func
final function set FunctionEvaluator (value : Func)

Property Value

Type: System.Func<T1, T2, T3, T4, TResult>
The value callback function.

Implements

INonlinearModel.FunctionEvaluator

Remarks

You must set the value callback function before trying to solve the model.

The value callback function has the following arguments:

The first argument is the INonlinearModel that is being solved.

The second argument is an Int32 that represents the row index to be evaluated, which is a goal or a constraint.

The third argument is a ValuesByIndex that contains the current variable values that are accessible by index.

The fourth argument is a Boolean that indicates whether the current call is the first evaluator call that has the current variable values.

The return value is a Double that is the value of the row for the current variable values.

.NET Framework Security

See Also

Reference

NonlinearModel Class

Microsoft.SolverFoundation.Services Namespace