UnconstrainedNonlinearModel Class

[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.

Inheritance Hierarchy


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


Public MustInherit Class UnconstrainedNonlinearModel _
    Implements INonlinearModel, IRowVariableModel, IGoalModel
public abstract class UnconstrainedNonlinearModel : INonlinearModel, 
    IRowVariableModel, IGoalModel
public ref class UnconstrainedNonlinearModel abstract : INonlinearModel, 
    IRowVariableModel, IGoalModel
type UnconstrainedNonlinearModel =  
        interface INonlinearModel
        interface IRowVariableModel
        interface IGoalModel
public abstract class UnconstrainedNonlinearModel implements INonlinearModel, IRowVariableModel, IGoalModel

The UnconstrainedNonlinearModel type exposes the following members.


  Name Description
Protected method UnconstrainedNonlinearModel Creates a new instance of the UnconstrainedNonlinearModel class, by using the specified key comparer.



  Name Description
Public property FunctionEvaluator Function value callback.
Public property GradientEvaluator Gradient callback.
Public property Indices Returns the variable index collection, inclusive of rows
Public property KeyComparer Is used for row or variable key comparison
Public property KeyCount Returns the number of keys, inclusive of rows and variables.
Public property Keys Returns the variable and row key collection. Indices are guaranteed to be greater than or equal to 0 and less than the KeyCount.
Public property RowCount Returns the number of rows in the model
Public property RowIndices Returns the row index collection
Public property RowKeys Returns the row key collection
Protected property RowValue Sets the value of the only row of the model
Public property TheGoal The only goal of the model
Public property VariableCount Gets the number of variables in the model.
Public property VariableIndices Gets an IEnumerable containing the variable indexes.
Protected property VariableKeyCount Returns a count for keys (not including null) for variables
Public property VariableKeys Gets an IEnumerable containing the variable keys.



  Name Description
Public method AddGoal Marks a row as a goal.
Public method AddRow Adds a row to the model.
Public method 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.
Public method AddVariable The method ensures that a user variable with the given key is in the model.
Protected method CopyVariableValuesFrom Copies variable values from an array.
Protected method CopyVariableValuesTo Copies variable values to an array.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetBounds Returns the bounds for a vid.
Public method GetGoalFromIndex Returns a goal entry if the row id is a goal
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetIndexFromKey Maps the variable index from the key. If not found, KeyNotFoundException will be thrown
Public method GetKeyFromIndex Maps the variable index to the key. If not found, ArgumentException will be thrown
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method GetValue Gets the value associated with the variable index. This is typically used when retrieving results.
Public method IsGoal(Int32) Checks if a row identified by the specified id is a goal row.
Public method IsGoal(Int32, IGoal%) Checks if a row identified by the specified id is a goal row. If true, return the goal entry
Public method IsRow Validates whether the specified id represents a row index
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method PreChange Invoke this function before modfying the model.
Public method RemoveGoal Removes a goal row
Public method SetBounds Sets the upper and lower bounds for a vid.
Protected method SetGoalValue Sets the goal value.
Public method SetLowerBound Sets the lower bound for a vid.
Public method SetUpperBound Sets the upper bound for a vid.
Public method SetValue Sets the value of model identified by the vid. The default value for a vid is Indeterminate.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method TryGetIndexFromKey Attempts to get the variable index based on the specified key
Protected method ValidateVid Validates a vid, and throws ArgumentException if not valid.


Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IGoalModel.ClearGoals Clears all the goals
Explicit interface implemetationPrivate property IGoalModel.GoalCount The number of goals in this model
Explicit interface implemetationPrivate property IGoalModel.Goals Returns the goal collection of this model.
Explicit interface implemetationPrivate method INonlinearModel.GetActiveVariables Specifies variables that participate in the row.
Explicit interface implemetationPrivate method INonlinearModel.IsActiveVariable Determines whether a variable is active in a specific row
Explicit interface implemetationPrivate method INonlinearModel.SetActiveVariable Sets a specific variable in a row to be active or inactive
Explicit interface implemetationPrivate method INonlinearModel.SetActiveVariables Sets all variables in a row to be active or inactive
Explicit interface implemetationPrivate method IRowVariableModel.GetIgnoreBounds Gets the flag that specifies whether bounds are ignored
Explicit interface implemetationPrivate method IRowVariableModel.GetIntegrality Checks if a variable is an integer variable
Explicit interface implemetationPrivate property IRowVariableModel.IntegerIndexCount Returns the number of integer variables
Explicit interface implemetationPrivate method IRowVariableModel.SetIgnoreBounds Adjusts whether the bounds of a vid should be respected or ignored during solving. By default, bounds are respected.
Explicit interface implemetationPrivate method IRowVariableModel.SetIntegrality Marks a variable as an integer variable


Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also


Microsoft.SolverFoundation.Solvers Namespace