INonlinearModel Interface

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

Encapsulates a non-linear optimization model that consists of variables, rows, goals, and a function value callback that defines the values and possible gradients of the rows.

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

Syntax

'Declaration
Public Interface INonlinearModel _
    Inherits IRowVariableModel, IGoalModel

public interface INonlinearModel : IRowVariableModel, 
    IGoalModel

public interface class INonlinearModel : IRowVariableModel, 
    IGoalModel

type INonlinearModel =  
    interface
        interface IRowVariableModel
        interface IGoalModel
    end

public interface INonlinearModel extends IRowVariableModel, IGoalModel

The INonlinearModel type exposes the following members.

Properties

	Name	Description
	FunctionEvaluator	Gets or sets the value callback function that the solver invokes periodically in order to obtain function values for different variable values.
	GoalCount	Gets the number of goals in a model. (Inherited from IGoalModel.)
	Goals	Gets the collection of goals for a model. (Inherited from IGoalModel.)
	GradientEvaluator	Gets or sets the gradient callback function that the solver invokes periodically in order to obtain gradient information for different variable values.
	Indices	Gets the collection of variable indexes, inclusive of rows. (Inherited from IRowVariableModel.)
	IntegerIndexCount	Gets the number of integer variables in a model. (Inherited from IRowVariableModel.)
	KeyComparer	Gets an object that is used to compare rows or variables. (Inherited from IRowVariableModel.)
	KeyCount	Gets the number of keys in a model, inclusive of rows and variables. (Inherited from IRowVariableModel.)
	Keys	Gets the variable and row key collection. (Inherited from IRowVariableModel.)
	RowCount	Gets the number of rows in a model. (Inherited from IRowVariableModel.)
	RowIndices	Gets the collection of row indexes in a model. (Inherited from IRowVariableModel.)
	RowKeys	Gets the collection of row keys. (Inherited from IRowVariableModel.)
	VariableCount	Gets the number of variables in a model. (Inherited from IRowVariableModel.)
	VariableIndices	Gets the collection of variable indexes. (Inherited from IRowVariableModel.)
	VariableKeys	Gets the collection of variable keys. (Inherited from IRowVariableModel.)

Top

Methods

	Name	Description
	AddGoal	Identifies the specified row as a goal row. (Inherited from IGoalModel.)
	AddRow	Adds a row to a model. (Inherited from IRowVariableModel.)
	AddVariable	Adds a user variable to a model. (Inherited from IRowVariableModel.)
	ClearGoals	Clears all the goals from a model. (Inherited from IGoalModel.)
	GetActiveVariables	Specifies the variables that participate in a row.
	GetBounds	Returns the bounds for a variable. (Inherited from IRowVariableModel.)
	GetGoalFromIndex	Returns a goal entry if the row index is associated with a goal row. (Inherited from IGoalModel.)
	GetIgnoreBounds	Returns a value that indicates whether the bounds of a variable are ignored. (Inherited from IRowVariableModel.)
	GetIndexFromKey	Returns the index that is associated with a key. (Inherited from IRowVariableModel.)
	GetIntegrality	Returns a value that indicates whether a variable is an integer variable. (Inherited from IRowVariableModel.)
	GetKeyFromIndex	Returns the key that is associated with a variable index. (Inherited from IRowVariableModel.)
	GetValue	Returns the value that is associated with a variable index. (Inherited from IRowVariableModel.)
	IsActiveVariable	Returns a value that indicates whether the specified variable is active in the specified row.
	IsGoal(Int32)	Returns a value that specifies whether a row index is a goal row. (Inherited from IGoalModel.)
	IsGoal(Int32, IGoal%)	Returns a value that specifies whether a row index is a goal row, and returns the associated goal. (Inherited from IGoalModel.)
	IsRow	Returns a value that indicates whether a variable index is a row. (Inherited from IRowVariableModel.)
	RemoveGoal	Removes a goal row. (Inherited from IGoalModel.)
	SetActiveVariable	Sets a variable in the specified row to either active or inactive.
	SetActiveVariables	Sets all variables in a specified row to either active or inactive.
	SetBounds	Sets the bounds for a variable. (Inherited from IRowVariableModel.)
	SetIgnoreBounds	Specifies whether the bounds of a variable index should be respected or ignored during a solve process. (Inherited from IRowVariableModel.)
	SetIntegrality	Specifies that a variable is an integer variable. (Inherited from IRowVariableModel.)
	SetLowerBound	Sets the lower bound of a variable. (Inherited from IRowVariableModel.)
	SetUpperBound	Sets the upper bound of a variable (Inherited from IRowVariableModel.)
	SetValue	Sets the value for the specified variable index. (Inherited from IRowVariableModel.)
	TryGetIndexFromKey	Attempts to return the variable index associated with a key. (Inherited from IRowVariableModel.)

Top

See Also

Reference

Microsoft.SolverFoundation.Services Namespace