CompactQuasiNewtonModel Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Defines the compact quasi-Newton (CQN) solver for nonlinear models.
Inheritance Hierarchy
System.Object
Microsoft.SolverFoundation.Solvers.UnconstrainedNonlinearModel
Microsoft.SolverFoundation.Solvers.CompactQuasiNewtonModel
Microsoft.SolverFoundation.Solvers.CompactQuasiNewtonSolver
Namespace: Microsoft.SolverFoundation.Solvers
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
Syntax
'Declaration
Public MustInherit Class CompactQuasiNewtonModel _
Inherits UnconstrainedNonlinearModel
public abstract class CompactQuasiNewtonModel : UnconstrainedNonlinearModel
public ref class CompactQuasiNewtonModel abstract : public UnconstrainedNonlinearModel
[<AbstractClass>]
type CompactQuasiNewtonModel =
class
inherit UnconstrainedNonlinearModel
end
public abstract class CompactQuasiNewtonModel extends UnconstrainedNonlinearModel
The CompactQuasiNewtonModel type exposes the following members.
Constructors
Name | Description | |
---|---|---|
CompactQuasiNewtonModel | Initializes a new instance of the RowVariableModel class. |
Top
Properties
Name | Description | |
---|---|---|
FunctionEvaluator | Function value callback. (Inherited from UnconstrainedNonlinearModel.) | |
GradientEvaluator | Gradient callback. (Inherited from UnconstrainedNonlinearModel.) | |
Indices | Returns the variable index collection, inclusive of rows (Inherited from UnconstrainedNonlinearModel.) | |
KeyComparer | Is used for row or variable key comparison (Inherited from UnconstrainedNonlinearModel.) | |
KeyCount | Returns the number of keys, inclusive of rows and variables. (Inherited from UnconstrainedNonlinearModel.) | |
Keys | Returns the variable and row key collection. Indices are guaranteed to be greater than or equal to 0 and less than the KeyCount. (Inherited from UnconstrainedNonlinearModel.) | |
RowCount | Returns the number of rows in the model (Inherited from UnconstrainedNonlinearModel.) | |
RowIndices | Returns the row index collection (Inherited from UnconstrainedNonlinearModel.) | |
RowKeys | Returns the row key collection (Inherited from UnconstrainedNonlinearModel.) | |
RowValue | Sets the value of the only row of the model (Inherited from UnconstrainedNonlinearModel.) | |
TheGoal | The only goal of the model (Inherited from UnconstrainedNonlinearModel.) | |
VariableCount | Gets the number of variables in the model. (Inherited from UnconstrainedNonlinearModel.) | |
VariableIndices | Gets an IEnumerable containing the variable indexes. (Inherited from UnconstrainedNonlinearModel.) | |
VariableKeyCount | Returns a count for keys (not including null) for variables (Inherited from UnconstrainedNonlinearModel.) | |
VariableKeys | Gets an IEnumerable containing the variable keys. (Inherited from UnconstrainedNonlinearModel.) |
Top
Methods
Name | Description | |
---|---|---|
AddGoal | Marks a row as a goal. (Inherited from UnconstrainedNonlinearModel.) | |
AddRow | Adds a row to the model. (Inherited from UnconstrainedNonlinearModel.) | |
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. (Inherited from UnconstrainedNonlinearModel.) | |
AddVariable | The method ensures that a user variable with the given key is in the model. (Inherited from UnconstrainedNonlinearModel.) | |
CopyVariableValuesFrom | Copies variable values from an array. (Inherited from UnconstrainedNonlinearModel.) | |
CopyVariableValuesTo | Copies variable values to an array. (Inherited from UnconstrainedNonlinearModel.) | |
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. (Inherited from UnconstrainedNonlinearModel.) | |
GetGoalFromIndex | Returns a goal entry if the row id is a goal (Inherited from UnconstrainedNonlinearModel.) | |
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 (Inherited from UnconstrainedNonlinearModel.) | |
GetKeyFromIndex | Maps the variable index to the key. If not found, ArgumentException will be thrown (Inherited from UnconstrainedNonlinearModel.) | |
GetProperty | Returns the value of a property that is at the specified index. | |
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. (Inherited from UnconstrainedNonlinearModel.) | |
IsGoal(Int32) | Checks if a row identified by the specified id is a goal row. (Inherited from UnconstrainedNonlinearModel.) | |
IsGoal(Int32, IGoal%) | Checks if a row identified by the specified id is a goal row. If true, return the goal entry (Inherited from UnconstrainedNonlinearModel.) | |
IsRow | Validates whether the specified id represents a row index (Inherited from UnconstrainedNonlinearModel.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
PreChange | Invoke this function before modfying the model. (Inherited from UnconstrainedNonlinearModel.) | |
RemoveGoal | Removes a goal row (Inherited from UnconstrainedNonlinearModel.) | |
SetBounds | Sets the upper and lower bounds for a vid. (Inherited from UnconstrainedNonlinearModel.) | |
SetGoalValue | Sets the goal value. (Inherited from UnconstrainedNonlinearModel.) | |
SetLowerBound | Sets the lower bound for a vid. (Inherited from UnconstrainedNonlinearModel.) | |
SetProperty | Sets a property that is at the specified variable index. | |
SetUpperBound | Sets the upper bound for a vid. (Inherited from UnconstrainedNonlinearModel.) | |
SetValue | Sets the value of model identified by the vid. The default value for a vid is Indeterminate. (Inherited from UnconstrainedNonlinearModel.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryGetIndexFromKey | Attempts to get the variable index based on the specified key (Inherited from UnconstrainedNonlinearModel.) | |
ValidateVid | Validates a vid, and throws ArgumentException if not valid. (Inherited from UnconstrainedNonlinearModel.) |
Top
Explicit Interface Implementations
Name | Description | |
---|---|---|
IGoalModel.ClearGoals | Clears all the goals (Inherited from UnconstrainedNonlinearModel.) | |
IGoalModel.GoalCount | The number of goals in this model (Inherited from UnconstrainedNonlinearModel.) | |
IGoalModel.Goals | Returns the goal collection of this model. (Inherited from UnconstrainedNonlinearModel.) | |
INonlinearModel.GetActiveVariables | Specifies variables that participate in the row. (Inherited from UnconstrainedNonlinearModel.) | |
INonlinearModel.IsActiveVariable | Determines whether a variable is active in a specific row (Inherited from UnconstrainedNonlinearModel.) | |
INonlinearModel.SetActiveVariable | Sets a specific variable in a row to be active or inactive (Inherited from UnconstrainedNonlinearModel.) | |
INonlinearModel.SetActiveVariables | Sets all variables in a row to be active or inactive (Inherited from UnconstrainedNonlinearModel.) | |
IRowVariableModel.GetIgnoreBounds | Gets the flag that specifies whether bounds are ignored (Inherited from UnconstrainedNonlinearModel.) | |
IRowVariableModel.GetIntegrality | Checks if a variable is an integer variable (Inherited from UnconstrainedNonlinearModel.) | |
IRowVariableModel.IntegerIndexCount | Returns the number of integer variables (Inherited from UnconstrainedNonlinearModel.) | |
IRowVariableModel.SetIgnoreBounds | Adjusts whether the bounds of a vid should be respected or ignored during solving. By default, bounds are respected. (Inherited from UnconstrainedNonlinearModel.) | |
IRowVariableModel.SetIntegrality | Marks a variable as an integer variable (Inherited from UnconstrainedNonlinearModel.) |
Top
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.