Export (0) Print
Expand All

CompactQuasiNewtonSolver 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.]

Finds a local minimum or maximum for an unconstrained nonlinear function.

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

public class CompactQuasiNewtonSolver : CompactQuasiNewtonModel, 
	INonlinearSolver, IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel, 
	IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider

The CompactQuasiNewtonSolver type exposes the following members.

  NameDescription
Public methodCompactQuasiNewtonSolver()Initializes a new instance of the CompactQuasiNewtonSolver class.
Public methodCompactQuasiNewtonSolver(IEqualityComparer<Object>)Initializes a new instance of the CompactQuasiNewtonSolver class, using the specified comparison object.
Top

  NameDescription
Public propertyEvaluationCallCountGets the number of function evaluation calls.
Public propertyFunctionEvaluator Function value callback. (Inherited from UnconstrainedNonlinearModel.)
Public propertyGradientCapabilityGets the gradient-related capabilities of a solver.
Public propertyGradientEvaluator Gradient callback. (Inherited from UnconstrainedNonlinearModel.)
Public propertyHessianCapabilityGets the Hessian-related capabilities of a solver.
Public propertyIndicesReturns the variable index collection, inclusive of rows (Inherited from UnconstrainedNonlinearModel.)
Public propertyIterationCountGets the number of iterations that have been performed by a solver.
Public propertyKeyComparerIs used for row or variable key comparison (Inherited from UnconstrainedNonlinearModel.)
Public propertyKeyCountReturns the number of keys, inclusive of rows and variables. (Inherited from UnconstrainedNonlinearModel.)
Public propertyKeysReturns 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.)
Public propertyNonlinearCapabilitiesGets the nonlinear capabilities of a solver.
Public propertyResultGets the result of a solve attempt.
Public propertyRowCountReturns the number of rows in the model (Inherited from UnconstrainedNonlinearModel.)
Public propertyRowIndicesReturns the row index collection (Inherited from UnconstrainedNonlinearModel.)
Public propertyRowKeysReturns the row key collection (Inherited from UnconstrainedNonlinearModel.)
Protected propertyRowValue Sets the value of the only row of the model (Inherited from UnconstrainedNonlinearModel.)
Public propertySolutionQualityGets the quality level of a solution.
Public propertyTheGoal The only goal of the model (Inherited from UnconstrainedNonlinearModel.)
Public propertyToleranceDifferenceGets the difference between the solution tolerance and the requested tolerance.
Public propertyVariableCount Gets the number of variables in the model. (Inherited from UnconstrainedNonlinearModel.)
Public propertyVariableIndices Gets an IEnumerable containing the variable indexes. (Inherited from UnconstrainedNonlinearModel.)
Protected propertyVariableKeyCountReturns a count for keys (not including null) for variables (Inherited from UnconstrainedNonlinearModel.)
Public propertyVariableKeys Gets an IEnumerable containing the variable keys. (Inherited from UnconstrainedNonlinearModel.)
Top

  NameDescription
Public methodAddGoalMarks a row as a goal. (Inherited from UnconstrainedNonlinearModel.)
Public methodAddRowAdds a row to the model. (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Public methodAddVariable The method ensures that a user variable with the given key is in the model. (Inherited from UnconstrainedNonlinearModel.)
Protected methodCopyVariableValuesFromCopies variable values from an array. (Inherited from UnconstrainedNonlinearModel.)
Protected methodCopyVariableValuesToCopies variable values to an array. (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Public methodGetGoalFromIndex Returns a goal entry if the row id is a goal (Inherited from UnconstrainedNonlinearModel.)
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 (Inherited from UnconstrainedNonlinearModel.)
Public methodGetKeyFromIndex Maps the variable index to the key. If not found, ArgumentException will be thrown (Inherited from UnconstrainedNonlinearModel.)
Public methodGetPropertyReturns the value of a property that is at the specified index. (Overrides CompactQuasiNewtonModel.GetProperty(String, Int32).)
Public methodGetReportGenerates a report.
Public methodGetSolutionValueReturns the objective value of a goal.
Public methodGetSolvedGoalReturns information about a solved goal.
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. (Inherited from UnconstrainedNonlinearModel.)
Public methodIsGoal(Int32) Checks if a row identified by the specified id is a goal row. (Inherited from UnconstrainedNonlinearModel.)
Public methodIsGoal(Int32, IGoal) Checks if a row identified by the specified id is a goal row. If true, return the goal entry (Inherited from UnconstrainedNonlinearModel.)
Public methodIsRowValidates whether the specified id represents a row index (Inherited from UnconstrainedNonlinearModel.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodPreChangeInvoke this function before modfying the model. (Inherited from UnconstrainedNonlinearModel.)
Public methodRemoveGoal Removes a goal row (Inherited from UnconstrainedNonlinearModel.)
Public methodSetBoundsSets the upper and lower bounds for a vid. (Inherited from UnconstrainedNonlinearModel.)
Protected methodSetGoalValueSets the goal value. (Inherited from UnconstrainedNonlinearModel.)
Public methodSetLowerBound Sets the lower bound for a vid. (Inherited from UnconstrainedNonlinearModel.)
Public methodSetPropertySets a property at the specified variable index. (Overrides CompactQuasiNewtonModel.SetProperty(String, Int32, Object).)
Public methodSetUpperBound Sets the upper bound for a vid. (Inherited from UnconstrainedNonlinearModel.)
Public methodSetValueSets the value of model identified by the vid. The default value for a vid is Indeterminate. (Inherited from UnconstrainedNonlinearModel.)
Public methodShutdownStops a solver instance.
Public methodSolveSolves a model by using the specified parameters.
Public methodToStringReturns a string that represents the current object. (Overrides Object.ToString().)
Public methodTryGetIndexFromKey Attempts to get the variable index based on the specified key (Inherited from UnconstrainedNonlinearModel.)
Protected methodValidateVid Validates a vid, and throws ArgumentException if not valid. (Inherited from UnconstrainedNonlinearModel.)
Top

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

Uses the L-BFGS algorithm, a limited memory quasi-Newton method.

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