UnconstrainedNonlinearModel Class
Solver Foundation 3.0
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Represents the base class for unconstrained nonlinear models.
System.Object
Microsoft.SolverFoundation.Solvers.UnconstrainedNonlinearModel
Microsoft.SolverFoundation.Solvers.CompactQuasiNewtonModel
Microsoft.SolverFoundation.Solvers.NelderMeadSolver
Microsoft.SolverFoundation.Solvers.UnconstrainedNonlinearModel
Microsoft.SolverFoundation.Solvers.CompactQuasiNewtonModel
Microsoft.SolverFoundation.Solvers.NelderMeadSolver
Namespace: Microsoft.SolverFoundation.Solvers
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
The UnconstrainedNonlinearModel type exposes the following members.
| Name | Description | |
|---|---|---|
![]() | UnconstrainedNonlinearModel | Creates a new instance of the UnconstrainedNonlinearModel class, by using the specified key comparer. |
| Name | Description | |
|---|---|---|
![]() | FunctionEvaluator | Function value callback. |
![]() | GradientEvaluator | Gradient callback. |
![]() | Indices | Returns the variable index collection, inclusive of rows |
![]() | KeyComparer | Is used for row or variable key comparison |
![]() | KeyCount | Returns the number of keys, inclusive of rows and variables. |
![]() | Keys | Returns the variable and row key collection. Indices are guaranteed to be greater than or equal to 0 and less than the KeyCount. |
![]() | RowCount | Returns the number of rows in the model |
![]() | RowIndices | Returns the row index collection |
![]() | RowKeys | Returns the row key collection |
![]() | RowValue | Sets the value of the only row of the model |
![]() | TheGoal | The only goal of the model |
![]() | VariableCount | Gets the number of variables in the model. |
![]() | VariableIndices | Gets an IEnumerable containing the variable indexes. |
![]() | VariableKeyCount | Returns a count for keys (not including null) for variables |
![]() | VariableKeys | Gets an IEnumerable containing the variable keys. |
| Name | Description | |
|---|---|---|
![]() | AddGoal | Marks a row as a goal. |
![]() | AddRow | Adds a row to the model. |
![]() | AddRowAsGoal | Adds a row as a goal. Unconstrained models can have just one row. By convention this row will always have 0 as an index. |
![]() | AddVariable | The method ensures that a user variable with the given key is in the model. |
![]() | CopyVariableValuesFrom | Copies variable values from an array. |
![]() | CopyVariableValuesTo | Copies variable values to an array. |
![]() | Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
![]() | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
![]() | GetBounds | Returns the bounds for a vid. |
![]() | GetGoalFromIndex | Returns a goal entry if the row id is a goal |
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetIndexFromKey | Maps the variable index from the key. If not found, KeyNotFoundException will be thrown |
![]() | GetKeyFromIndex | Maps the variable index to the key. If not found, ArgumentException will be thrown |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetValue | Gets the value associated with the variable index. This is typically used when retrieving results. |
![]() | IsGoal(Int32) | Checks if a row identified by the specified id is a goal row. |
![]() | IsGoal(Int32, IGoal) | Checks if a row identified by the specified id is a goal row. If true, return the goal entry |
![]() | IsRow | Validates whether the specified id represents a row index |
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | PreChange | Invoke this function before modfying the model. |
![]() | RemoveGoal | Removes a goal row |
![]() | SetBounds | Sets the upper and lower bounds for a vid. |
![]() | SetGoalValue | Sets the goal value. |
![]() | SetLowerBound | Sets the lower bound for a vid. |
![]() | SetUpperBound | Sets the upper bound for a vid. |
![]() | SetValue | Sets the value of model identified by the vid. The default value for a vid is Indeterminate. |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
![]() | TryGetIndexFromKey | Attempts to get the variable index based on the specified key |
![]() | ValidateVid | Validates a vid, and throws ArgumentException if not valid. |
| Name | Description | |
|---|---|---|
![]() ![]() | IGoalModel.ClearGoals | Clears all the goals |
![]() ![]() | IGoalModel.GoalCount | The number of goals in this model |
![]() ![]() | IGoalModel.Goals | Returns the goal collection of this model. |
![]() ![]() | INonlinearModel.GetActiveVariables | Specifies variables that participate in the row. |
![]() ![]() | INonlinearModel.IsActiveVariable | Determines whether a variable is active in a specific row |
![]() ![]() | INonlinearModel.SetActiveVariable | Sets a specific variable in a row to be active or inactive |
![]() ![]() | INonlinearModel.SetActiveVariables | Sets all variables in a row to be active or inactive |
![]() ![]() | IRowVariableModel.GetIgnoreBounds | Gets the flag that specifies whether bounds are ignored |
![]() ![]() | IRowVariableModel.GetIntegrality | Checks if a variable is an integer variable |
![]() ![]() | IRowVariableModel.IntegerIndexCount | Returns the number of integer variables |
![]() ![]() | IRowVariableModel.SetIgnoreBounds | Adjusts whether the bounds of a vid should be respected or ignored during solving. By default, bounds are respected. |
![]() ![]() | IRowVariableModel.SetIntegrality | Marks a variable as an integer variable |
Show:

