INonlinearModel.GetActiveVariables Method
[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)
Syntax
'Declaration
Function GetActiveVariables ( _
rowVid As Integer _
) As IEnumerable(Of Integer)
IEnumerable<int> GetActiveVariables(
int rowVid
)
IEnumerable<int>^ GetActiveVariables(
int rowVid
)
abstract GetActiveVariables :
rowVid:int -> IEnumerable<int>
function GetActiveVariables(
rowVid : int
) : IEnumerable<int>
Parameters
- rowVid
Type: System.Int32
The row index.
Return Value
Type: System.Collections.Generic.IEnumerable<Int32>
An enumeration of active variables in rowVid.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentException | rowVid is not a valid row index. |
Remarks
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.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.