UnconstrainedNonlinearModel Class
Collapse the table of content
Expand the table of content

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.

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

public abstract class UnconstrainedNonlinearModel : INonlinearModel, 
	IRowVariableModel, IGoalModel

The UnconstrainedNonlinearModel type exposes the following members.

Protected methodUnconstrainedNonlinearModelCreates a new instance of the UnconstrainedNonlinearModel class, by using the specified key comparer.

Public propertyFunctionEvaluator Function value callback.
Public propertyGradientEvaluator Gradient callback.
Public propertyIndicesReturns the variable index collection, inclusive of rows
Public propertyKeyComparerIs used for row or variable key comparison
Public propertyKeyCountReturns the number of keys, inclusive of rows and variables.
Public propertyKeysReturns the variable and row key collection. Indices are guaranteed to be greater than or equal to 0 and less than the KeyCount.
Public propertyRowCountReturns the number of rows in the model
Public propertyRowIndicesReturns the row index collection
Public propertyRowKeysReturns the row key collection
Protected propertyRowValue Sets the value of the only row of the model
Public propertyTheGoal The only goal of the model
Public propertyVariableCount Gets the number of variables in the model.
Public propertyVariableIndices Gets an IEnumerable containing the variable indexes.
Protected propertyVariableKeyCountReturns a count for keys (not including null) for variables
Public propertyVariableKeys Gets an IEnumerable containing the variable keys.

Public methodAddGoalMarks a row as a goal.
Public methodAddRowAdds a row to the model.
Public methodAddRowAsGoal 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 methodAddVariable The method ensures that a user variable with the given key is in the model.
Protected methodCopyVariableValuesFromCopies variable values from an array.
Protected methodCopyVariableValuesToCopies variable values to an array.
Public methodEqualsDetermines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetBoundsReturns the bounds for a vid.
Public methodGetGoalFromIndex Returns a goal entry if the row id is a goal
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetIndexFromKey Maps the variable index from the key. If not found, KeyNotFoundException will be thrown
Public methodGetKeyFromIndex Maps the variable index to the key. If not found, ArgumentException will be thrown
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGetValue Gets the value associated with the variable index. This is typically used when retrieving results.
Public methodIsGoal(Int32) Checks if a row identified by the specified id is a goal row.
Public methodIsGoal(Int32, IGoal) Checks if a row identified by the specified id is a goal row. If true, return the goal entry
Public methodIsRowValidates whether the specified id represents a row index
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPreChangeInvoke this function before modfying the model.
Public methodRemoveGoal Removes a goal row
Public methodSetBoundsSets the upper and lower bounds for a vid.
Protected methodSetGoalValueSets the goal value.
Public methodSetLowerBound Sets the lower bound for a vid.
Public methodSetUpperBound Sets the upper bound for a vid.
Public methodSetValueSets the value of model identified by the vid. The default value for a vid is Indeterminate.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodTryGetIndexFromKey Attempts to get the variable index based on the specified key
Protected methodValidateVid Validates a vid, and throws ArgumentException if not valid.

Explicit interface implemetationPrivate methodIGoalModel.ClearGoals Clears all the goals
Explicit interface implemetationPrivate propertyIGoalModel.GoalCount The number of goals in this model
Explicit interface implemetationPrivate propertyIGoalModel.Goals Returns the goal collection of this model.
Explicit interface implemetationPrivate methodINonlinearModel.GetActiveVariablesSpecifies variables that participate in the row.
Explicit interface implemetationPrivate methodINonlinearModel.IsActiveVariableDetermines whether a variable is active in a specific row
Explicit interface implemetationPrivate methodINonlinearModel.SetActiveVariableSets a specific variable in a row to be active or inactive
Explicit interface implemetationPrivate methodINonlinearModel.SetActiveVariablesSets all variables in a row to be active or inactive
Explicit interface implemetationPrivate methodIRowVariableModel.GetIgnoreBounds Gets the flag that specifies whether bounds are ignored
Explicit interface implemetationPrivate methodIRowVariableModel.GetIntegrality Checks if a variable is an integer variable
Explicit interface implemetationPrivate propertyIRowVariableModel.IntegerIndexCount Returns the number of integer variables
Explicit interface implemetationPrivate methodIRowVariableModel.SetIgnoreBounds Adjusts whether the bounds of a vid should be respected or ignored during solving. By default, bounds are respected.
Explicit interface implemetationPrivate methodIRowVariableModel.SetIntegrality Marks a variable as an integer variable

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