INonlinearSolver Interface

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

Defines a solver for nonlinear programming models that correspond to INonlinearModel.

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

Syntax

'Declaration
Public Interface INonlinearSolver _
    Inherits IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel,  _
    IGoalModel
public interface INonlinearSolver : IRowVariableSolver, 
    ISolver, INonlinearModel, IRowVariableModel, IGoalModel
public interface class INonlinearSolver : IRowVariableSolver, 
    ISolver, INonlinearModel, IRowVariableModel, IGoalModel
type INonlinearSolver =  
    interface
        interface IRowVariableSolver
        interface ISolver
        interface INonlinearModel
        interface IRowVariableModel
        interface IGoalModel
    end
public interface INonlinearSolver extends IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel, IGoalModel

The INonlinearSolver type exposes the following members.

Properties

  Name Description
Public property FunctionEvaluator Gets or sets the value callback function that the solver invokes periodically in order to obtain function values for different variable values. (Inherited from INonlinearModel.)
Public property GoalCount Gets the number of goals in a model. (Inherited from IGoalModel.)
Public property Goals Gets the collection of goals for a model. (Inherited from IGoalModel.)
Public property GradientCapability Gets the gradient-related capabilities of a solver.
Public property GradientEvaluator Gets or sets the gradient callback function that the solver invokes periodically in order to obtain gradient information for different variable values. (Inherited from INonlinearModel.)
Public property HessianCapability Gets the Hessian-related capabilities of a solver.
Public property Indices Gets the collection of variable indexes, inclusive of rows. (Inherited from IRowVariableModel.)
Public property IntegerIndexCount Gets the number of integer variables in a model. (Inherited from IRowVariableModel.)
Public property KeyComparer Gets an object that is used to compare rows or variables. (Inherited from IRowVariableModel.)
Public property KeyCount Gets the number of keys in a model, inclusive of rows and variables. (Inherited from IRowVariableModel.)
Public property Keys Gets the variable and row key collection. (Inherited from IRowVariableModel.)
Public property NonlinearCapabilities Gets the nonlinear capabilities of a solver.
Public property RowCount Gets the number of rows in a model. (Inherited from IRowVariableModel.)
Public property RowIndices Gets the collection of row indexes in a model. (Inherited from IRowVariableModel.)
Public property RowKeys Gets the collection of row keys. (Inherited from IRowVariableModel.)
Public property VariableCount Gets the number of variables in a model. (Inherited from IRowVariableModel.)
Public property VariableIndices Gets the collection of variable indexes. (Inherited from IRowVariableModel.)
Public property VariableKeys Gets the collection of variable keys. (Inherited from IRowVariableModel.)

Top

Methods

  Name Description
Public method AddGoal Identifies the specified row as a goal row. (Inherited from IGoalModel.)
Public method AddRow Adds a row to a model. (Inherited from IRowVariableModel.)
Public method AddVariable Adds a user variable to a model. (Inherited from IRowVariableModel.)
Public method ClearGoals Clears all the goals from a model. (Inherited from IGoalModel.)
Public method GetActiveVariables Specifies the variables that participate in a row. (Inherited from INonlinearModel.)
Public method GetBounds Returns the bounds for a variable. (Inherited from IRowVariableModel.)
Public method GetGoalFromIndex Returns a goal entry if the row index is associated with a goal row. (Inherited from IGoalModel.)
Public method GetIgnoreBounds Returns a value that indicates whether the bounds of a variable are ignored. (Inherited from IRowVariableModel.)
Public method GetIndexFromKey Returns the index that is associated with a key. (Inherited from IRowVariableModel.)
Public method GetIntegrality Returns a value that indicates whether a variable is an integer variable. (Inherited from IRowVariableModel.)
Public method GetKeyFromIndex Returns the key that is associated with a variable index. (Inherited from IRowVariableModel.)
Public method GetValue Returns the value that is associated with a variable index. (Inherited from IRowVariableModel.)
Public method IsActiveVariable Returns a value that indicates whether the specified variable is active in the specified row. (Inherited from INonlinearModel.)
Public method IsGoal(Int32) Returns a value that specifies whether a row index is a goal row. (Inherited from IGoalModel.)
Public method IsGoal(Int32, IGoal%) Returns a value that specifies whether a row index is a goal row, and returns the associated goal. (Inherited from IGoalModel.)
Public method IsRow Returns a value that indicates whether a variable index is a row. (Inherited from IRowVariableModel.)
Public method RemoveGoal Removes a goal row. (Inherited from IGoalModel.)
Public method SetActiveVariable Sets a variable in the specified row to either active or inactive. (Inherited from INonlinearModel.)
Public method SetActiveVariables Sets all variables in a specified row to either active or inactive. (Inherited from INonlinearModel.)
Public method SetBounds Sets the bounds for a variable. (Inherited from IRowVariableModel.)
Public method SetIgnoreBounds Specifies whether the bounds of a variable index should be respected or ignored during a solve process. (Inherited from IRowVariableModel.)
Public method SetIntegrality Specifies that a variable is an integer variable. (Inherited from IRowVariableModel.)
Public method SetLowerBound Sets the lower bound of a variable. (Inherited from IRowVariableModel.)
Public method SetUpperBound Sets the upper bound of a variable (Inherited from IRowVariableModel.)
Public method SetValue Sets the value for the specified variable index. (Inherited from IRowVariableModel.)
Public method Shutdown Shuts down a solver instance. (Inherited from ISolver.)
Public method Solve Solves a model, using the specified parameters. (Inherited from IRowVariableSolver.)
Public method TryGetIndexFromKey Attempts to return the variable index associated with a key. (Inherited from IRowVariableModel.)

Top

See Also

Reference

Microsoft.SolverFoundation.Services Namespace