Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

INonlinearSolver Interface

Solver Foundation 3.0

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Defines a solver for nonlinear programming models that correspond to INonlinearModel.

Namespace:  Microsoft.SolverFoundation.Services
Assembly:  Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
public interface INonlinearSolver : IRowVariableSolver, 
	ISolver, INonlinearModel, IRowVariableModel, IGoalModel

The INonlinearSolver type exposes the following members.

  NameDescription
Public propertyFunctionEvaluatorGets or sets the value callback function that the solver invokes periodically in order to obtain function values for different variable values. (Inherited from INonlinearModel.)
Public propertyGoalCountGets the number of goals in a model. (Inherited from IGoalModel.)
Public propertyGoalsGets the collection of goals for a model. (Inherited from IGoalModel.)
Public propertyGradientCapabilityGets the gradient-related capabilities of a solver.
Public propertyGradientEvaluatorGets or sets the gradient callback function that the solver invokes periodically in order to obtain gradient information for different variable values. (Inherited from INonlinearModel.)
Public propertyHessianCapabilityGets the Hessian-related capabilities of a solver.
Public propertyIndicesGets the collection of variable indexes, inclusive of rows. (Inherited from IRowVariableModel.)
Public propertyIntegerIndexCountGets the number of integer variables in a model. (Inherited from IRowVariableModel.)
Public propertyKeyComparerGets an object that is used to compare rows or variables. (Inherited from IRowVariableModel.)
Public propertyKeyCountGets the number of keys in a model, inclusive of rows and variables. (Inherited from IRowVariableModel.)
Public propertyKeysGets the variable and row key collection. (Inherited from IRowVariableModel.)
Public propertyNonlinearCapabilitiesGets the nonlinear capabilities of a solver.
Public propertyRowCountGets the number of rows in a model. (Inherited from IRowVariableModel.)
Public propertyRowIndicesGets the collection of row indexes in a model. (Inherited from IRowVariableModel.)
Public propertyRowKeysGets the collection of row keys. (Inherited from IRowVariableModel.)
Public propertyVariableCountGets the number of variables in a model. (Inherited from IRowVariableModel.)
Public propertyVariableIndicesGets the collection of variable indexes. (Inherited from IRowVariableModel.)
Public propertyVariableKeysGets the collection of variable keys. (Inherited from IRowVariableModel.)
Top
  NameDescription
Public methodAddGoalIdentifies the specified row as a goal row. (Inherited from IGoalModel.)
Public methodAddRowAdds a row to a model. (Inherited from IRowVariableModel.)
Public methodAddVariableAdds a user variable to a model. (Inherited from IRowVariableModel.)
Public methodClearGoalsClears all the goals from a model. (Inherited from IGoalModel.)
Public methodGetActiveVariablesSpecifies the variables that participate in a row. (Inherited from INonlinearModel.)
Public methodGetBoundsReturns the bounds for a variable. (Inherited from IRowVariableModel.)
Public methodGetGoalFromIndexReturns a goal entry if the row index is associated with a goal row. (Inherited from IGoalModel.)
Public methodGetIgnoreBoundsReturns a value that indicates whether the bounds of a variable are ignored. (Inherited from IRowVariableModel.)
Public methodGetIndexFromKeyReturns the index that is associated with a key. (Inherited from IRowVariableModel.)
Public methodGetIntegralityReturns a value that indicates whether a variable is an integer variable. (Inherited from IRowVariableModel.)
Public methodGetKeyFromIndexReturns the key that is associated with a variable index. (Inherited from IRowVariableModel.)
Public methodGetValueReturns the value that is associated with a variable index. (Inherited from IRowVariableModel.)
Public methodIsActiveVariableReturns a value that indicates whether the specified variable is active in the specified row. (Inherited from INonlinearModel.)
Public methodIsGoal(Int32)Returns a value that specifies whether a row index is a goal row. (Inherited from IGoalModel.)
Public methodIsGoal(Int32, IGoal)Returns a value that specifies whether a row index is a goal row, and returns the associated goal. (Inherited from IGoalModel.)
Public methodIsRowReturns a value that indicates whether a variable index is a row. (Inherited from IRowVariableModel.)
Public methodRemoveGoalRemoves a goal row. (Inherited from IGoalModel.)
Public methodSetActiveVariableSets a variable in the specified row to either active or inactive. (Inherited from INonlinearModel.)
Public methodSetActiveVariablesSets all variables in a specified row to either active or inactive. (Inherited from INonlinearModel.)
Public methodSetBoundsSets the bounds for a variable. (Inherited from IRowVariableModel.)
Public methodSetIgnoreBoundsSpecifies whether the bounds of a variable index should be respected or ignored during a solve process. (Inherited from IRowVariableModel.)
Public methodSetIntegralitySpecifies that a variable is an integer variable. (Inherited from IRowVariableModel.)
Public methodSetLowerBoundSets the lower bound of a variable. (Inherited from IRowVariableModel.)
Public methodSetUpperBoundSets the upper bound of a variable (Inherited from IRowVariableModel.)
Public methodSetValueSets the value for the specified variable index. (Inherited from IRowVariableModel.)
Public methodShutdownShuts down a solver instance. (Inherited from ISolver.)
Public methodSolveSolves a model, using the specified parameters. (Inherited from IRowVariableSolver.)
Public methodTryGetIndexFromKeyAttempts to return the variable index associated with a key. (Inherited from IRowVariableModel.)
Top
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.