CompactQuasiNewtonSolver Class

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

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 Class CompactQuasiNewtonSolver _
    Inherits CompactQuasiNewtonModel _
    Implements INonlinearSolver, IRowVariableSolver, ISolver, INonlinearModel,  _
    IRowVariableModel, IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties,  _
    IReportProvider
public class CompactQuasiNewtonSolver : CompactQuasiNewtonModel, 
    INonlinearSolver, IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel, 
    IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider
public ref class CompactQuasiNewtonSolver : public CompactQuasiNewtonModel, 
    INonlinearSolver, IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel, 
    IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider
type CompactQuasiNewtonSolver =  
    class
        inherit CompactQuasiNewtonModel
        interface INonlinearSolver
        interface IRowVariableSolver
        interface ISolver
        interface INonlinearModel
        interface IRowVariableModel
        interface IGoalModel
        interface INonlinearSolution
        interface ISolverSolution
        interface ISolverProperties
        interface IReportProvider
    end
public class CompactQuasiNewtonSolver extends CompactQuasiNewtonModel implements INonlinearSolver, IRowVariableSolver, ISolver, INonlinearModel, IRowVariableModel, IGoalModel, INonlinearSolution, ISolverSolution, ISolverProperties, IReportProvider

The CompactQuasiNewtonSolver type exposes the following members.

Constructors

  Name Description
Public method CompactQuasiNewtonSolver() Initializes a new instance of the CompactQuasiNewtonSolver class.
Public method CompactQuasiNewtonSolver(IEqualityComparer<Object>) Initializes a new instance of the CompactQuasiNewtonSolver class, using the specified comparison object.

Top

Properties

  Name Description
Public property EvaluationCallCount Gets the number of function evaluation calls.
Public property FunctionEvaluator Function value callback. (Inherited from UnconstrainedNonlinearModel.)
Public property GradientCapability Gets the gradient-related capabilities of a solver.
Public property GradientEvaluator Gradient callback. (Inherited from UnconstrainedNonlinearModel.)
Public property HessianCapability Gets the Hessian-related capabilities of a solver.
Public property Indices Returns the variable index collection, inclusive of rows (Inherited from UnconstrainedNonlinearModel.)
Public property IterationCount Gets the number of iterations that have been performed by a solver.
Public property KeyComparer Is used for row or variable key comparison (Inherited from UnconstrainedNonlinearModel.)
Public property KeyCount Returns the number of keys, inclusive of rows and variables. (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Public property NonlinearCapabilities Gets the nonlinear capabilities of a solver.
Public property Result Gets the result of a solve attempt.
Public property RowCount Returns the number of rows in the model (Inherited from UnconstrainedNonlinearModel.)
Public property RowIndices Returns the row index collection (Inherited from UnconstrainedNonlinearModel.)
Public property RowKeys Returns the row key collection (Inherited from UnconstrainedNonlinearModel.)
Protected property RowValue Sets the value of the only row of the model (Inherited from UnconstrainedNonlinearModel.)
Public property SolutionQuality Gets the quality level of a solution.
Public property TheGoal The only goal of the model (Inherited from UnconstrainedNonlinearModel.)
Public property ToleranceDifference Gets the difference between the solution tolerance and the requested tolerance.
Public property VariableCount Gets the number of variables in the model. (Inherited from UnconstrainedNonlinearModel.)
Public property VariableIndices Gets an IEnumerable containing the variable indexes. (Inherited from UnconstrainedNonlinearModel.)
Protected property VariableKeyCount Returns a count for keys (not including null) for variables (Inherited from UnconstrainedNonlinearModel.)
Public property VariableKeys Gets an IEnumerable containing the variable keys. (Inherited from UnconstrainedNonlinearModel.)

Top

Methods

  Name Description
Public method AddGoal Marks a row as a goal. (Inherited from UnconstrainedNonlinearModel.)
Public method AddRow Adds a row to the model. (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Public method AddVariable The method ensures that a user variable with the given key is in the model. (Inherited from UnconstrainedNonlinearModel.)
Protected method CopyVariableValuesFrom Copies variable values from an array. (Inherited from UnconstrainedNonlinearModel.)
Protected method CopyVariableValuesTo Copies variable values to an array. (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Public method GetGoalFromIndex Returns a goal entry if the row id is a goal (Inherited from UnconstrainedNonlinearModel.)
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 (Inherited from UnconstrainedNonlinearModel.)
Public method GetKeyFromIndex Maps the variable index to the key. If not found, ArgumentException will be thrown (Inherited from UnconstrainedNonlinearModel.)
Public method GetProperty Returns the value of a property that is at the specified index. (Overrides CompactQuasiNewtonModel.GetProperty(String, Int32).)
Public method GetReport Generates a report.
Public method GetSolutionValue Returns the objective value of a goal.
Public method GetSolvedGoal Returns information about a solved goal.
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. (Inherited from UnconstrainedNonlinearModel.)
Public method IsGoal(Int32) Checks if a row identified by the specified id is a goal row. (Inherited from UnconstrainedNonlinearModel.)
Public method 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.)
Public method IsRow Validates whether the specified id represents a row index (Inherited from UnconstrainedNonlinearModel.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method PreChange Invoke this function before modfying the model. (Inherited from UnconstrainedNonlinearModel.)
Public method RemoveGoal Removes a goal row (Inherited from UnconstrainedNonlinearModel.)
Public method SetBounds Sets the upper and lower bounds for a vid. (Inherited from UnconstrainedNonlinearModel.)
Protected method SetGoalValue Sets the goal value. (Inherited from UnconstrainedNonlinearModel.)
Public method SetLowerBound Sets the lower bound for a vid. (Inherited from UnconstrainedNonlinearModel.)
Public method SetProperty Sets a property at the specified variable index. (Overrides CompactQuasiNewtonModel.SetProperty(String, Int32, Object).)
Public method SetUpperBound Sets the upper bound for a vid. (Inherited from UnconstrainedNonlinearModel.)
Public method SetValue Sets the value of model identified by the vid. The default value for a vid is Indeterminate. (Inherited from UnconstrainedNonlinearModel.)
Public method Shutdown Stops a solver instance.
Public method Solve Solves a model by using the specified parameters.
Public method ToString Returns a string that represents the current object. (Overrides Object.ToString().)
Public method TryGetIndexFromKey Attempts to get the variable index based on the specified key (Inherited from UnconstrainedNonlinearModel.)
Protected method ValidateVid Validates a vid, and throws ArgumentException if not valid. (Inherited from UnconstrainedNonlinearModel.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IGoalModel.ClearGoals Clears all the goals (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate property IGoalModel.GoalCount The number of goals in this model (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate property IGoalModel.Goals Returns the goal collection of this model. (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method INonlinearModel.GetActiveVariables Specifies variables that participate in the row. (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method INonlinearModel.IsActiveVariable Determines whether a variable is active in a specific row (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method INonlinearModel.SetActiveVariable Sets a specific variable in a row to be active or inactive (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method INonlinearModel.SetActiveVariables Sets all variables in a row to be active or inactive (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method INonlinearSolution.GetValue Returns the value of a specified variable.
Explicit interface implemetationPrivate property INonlinearSolution.SolvedGoalCount Gets the number of goals being solved.
Explicit interface implemetationPrivate method IRowVariableModel.GetIgnoreBounds Gets the flag that specifies whether bounds are ignored (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method IRowVariableModel.GetIntegrality Checks if a variable is an integer variable (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate property IRowVariableModel.IntegerIndexCount Returns the number of integer variables (Inherited from UnconstrainedNonlinearModel.)
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. (Inherited from UnconstrainedNonlinearModel.)
Explicit interface implemetationPrivate method IRowVariableModel.SetIntegrality Marks a variable as an integer variable (Inherited from UnconstrainedNonlinearModel.)

Top

Remarks

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

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

Reference

Microsoft.SolverFoundation.Solvers Namespace