INonlinearModel.GetActiveVariables Method

Solver Foundation 3.0

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

Specifies the variables that participate in a row.

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

IEnumerable<int> GetActiveVariables(
	int rowVid
)

Parameters

rowVid
Type: System.Int32
The row index.

Return Value

Type: System.Collections.Generic.IEnumerable<Int32>
An enumeration of active variables in rowVid.

ExceptionCondition
ArgumentException

rowVid is not a valid row index.

In the case of a model that has explicit linear terms, that is, it implements ILinearModel, it is not necessary to specify the linear terms by using GetActiveVariables. If no call to SetActiveVariables has been made for the row, this method returns an empty result.

Show: