ITermModel Interface
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Encapsulates a nonlinear optimization model that consists of variables, rows, and goals.
Namespace: Microsoft.SolverFoundation.Services
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
Syntax
'Declaration
Public Interface ITermModel _
Inherits IRowVariableModel, IGoalModel
public interface ITermModel : IRowVariableModel,
IGoalModel
public interface class ITermModel : IRowVariableModel,
IGoalModel
type ITermModel =
interface
interface IRowVariableModel
interface IGoalModel
end
public interface ITermModel extends IRowVariableModel, IGoalModel
The ITermModel type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
GoalCount | Gets the number of goals in a model. (Inherited from IGoalModel.) |
|
Goals | Gets the collection of goals for a model. (Inherited from IGoalModel.) |
|
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 | |
|---|---|---|
.gif "Public method") |
AddConstant | Adds a constant to a model. |
|
AddGoal | Identifies the specified row as a goal row. (Inherited from IGoalModel.) |
|
AddOperation(TermModelOperation, Int32%, Int32) | Adds an operation row to a model. |
|
AddOperation(TermModelOperation, Int32%, Int32()) | Adds an operation row for operations that take an array of arguments to a model. |
|
AddOperation(TermModelOperation, Int32%, Int32, Int32) | Adds an operation row for a two-operand operation to a model. |
|
AddOperation(TermModelOperation, Int32%, Int32, Int32, Int32) | Adds an operation row for a three-operand operation to a model. |
|
AddRow | Adds a row to a model. (Inherited from IRowVariableModel.) |
|
AddVariable(Object, Int32%) | Adds a user variable to a model. (Inherited from IRowVariableModel.) |
|
AddVariable(Object, Int32%, IEnumerable<Rational>) | Adds a variable that has a fixed set of possible values to a model. |
|
AddVariable(Object, Int32%, Rational, Rational, Boolean) | Adds a variable to a model. |
|
ClearGoals | Clears all the goals from a model. (Inherited from IGoalModel.) |
|
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.) |
|
GetOperand | Returns the variable index associated with an operand. |
|
GetOperandCount | Returns the number of operands associated with a variable index. |
|
GetOperands | Returns all operands that are associated with a variable index. |
|
GetOperation | Returns the operation that is associated with a row or variable index. |
|
GetValue | Returns the value that is associated with a variable index. (Inherited from IRowVariableModel.) |
|
IsConstant | Returns a value that indicates whether a row index is associated with a constant 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.) |
|
IsOperation | Returns a value that indicates whether a row identifier is associated with an operation row. |
|
IsRow | Returns a value that indicates whether a variable index is a row. (Inherited from IRowVariableModel.) |
|
RemoveGoal | Removes a goal row. (Inherited from IGoalModel.) |
|
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