TermModel Class
[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.
Inheritance Hierarchy
System.Object
Microsoft.SolverFoundation.Services.RowVariableModel
Microsoft.SolverFoundation.Services.RowVariableGoalModel
Microsoft.SolverFoundation.Services.TermModel
Namespace: Microsoft.SolverFoundation.Services
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
Syntax
'Declaration
Public Class TermModel _
Inherits RowVariableGoalModel _
Implements ITermModel, IRowVariableModel, IGoalModel
public class TermModel : RowVariableGoalModel, ITermModel,
IRowVariableModel, IGoalModel
public ref class TermModel : public RowVariableGoalModel,
ITermModel, IRowVariableModel, IGoalModel
type TermModel =
class
inherit RowVariableGoalModel
interface ITermModel
interface IRowVariableModel
interface IGoalModel
end
public class TermModel extends RowVariableGoalModel implements ITermModel, IRowVariableModel, IGoalModel
The TermModel type exposes the following members.
Constructors
Name | Description | |
---|---|---|
TermModel | Initializes a new instance of the TermModel class. |
Top
Properties
Name | Description | |
---|---|---|
GoalCount | Gets the number of goals in a linear model. (Inherited from RowVariableGoalModel.) | |
Goals | Gets the collection of goals in a linear model. (Inherited from RowVariableGoalModel.) | |
Indices | Gets the collection of row and variable indexes for a model. (Inherited from RowVariableModel.) | |
IntegerIndexCount | Gets the number of integer variables in a model. (Inherited from RowVariableModel.) | |
IsMipModel | Gets a value that indicates whether a model is a mixed integer programming (MIP) model. (Inherited from RowVariableModel.) | |
KeyComparer | Gets the object that is used to compare keys for rows or variables. (Inherited from RowVariableModel.) | |
KeyCount | Gets the number of keys that are in a model. (Inherited from RowVariableModel.) | |
Keys | Gets the variable key and row key collection. (Inherited from RowVariableModel.) | |
RowCount | Gets the number of rows in a model. (Inherited from RowVariableModel.) | |
RowIndices | Gets the collection of row indexes in a model. (Inherited from RowVariableModel.) | |
RowKeys | Gets the collection of row keys. (Inherited from RowVariableModel.) | |
VariableCount | Gets the number of variables in a model. (Inherited from RowVariableModel.) | |
VariableIndices | Gets the collection of variable indexes. (Inherited from RowVariableModel.) | |
VariableKeys | Gets the collection of variable keys. (Inherited from RowVariableModel.) |
Top
Methods
Name | Description | |
---|---|---|
AddConstant | Adds a constant to a model. | |
AddGoal | Marks a row as a goal row. (Inherited from RowVariableGoalModel.) | |
AddOperation(TermModelOperation, Int32%, Int32) | Adds an operation row to a model. | |
AddOperation(TermModelOperation, Int32%, Int32()) | Adds an operation row to a model for operations that take an array of arguments. | |
AddOperation(TermModelOperation, Int32%, Int32, Int32) | Adds an operation row for two-operand operations to a model. | |
AddOperation(TermModelOperation, Int32%, Int32, Int32, Int32) | Adds an operation row for three-operand operations to a model. | |
AddRow | Adds a row to a model. (Overrides RowVariableModel.AddRow(Object, Int32%).) | |
AddVariable(Object, Int32%) | Adds a user variable to a model. (Inherited from RowVariableModel.) | |
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 in a model. (Inherited from RowVariableGoalModel.) | |
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
GetBounds | Returns the bounds for a variable. (Inherited from RowVariableModel.) | |
GetGoalFromIndex | Returns a goal entry that is associated with a row index. (Inherited from RowVariableGoalModel.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetIgnoreBounds | Returns a value that indicates whether the bounds of a variable are ignored. (Inherited from RowVariableModel.) | |
GetIndexFromKey | Returns the index that is associated with a specified key. (Inherited from RowVariableModel.) | |
GetIntegrality | Returns a value that indicates whether a variable is an integer variable. (Inherited from RowVariableModel.) | |
GetKeyFromIndex | Returns the key that is associated with the specified variable index. (Inherited from RowVariableModel.) | |
GetOperand | Returns an operand that is associated with a row or variable index. | |
GetOperandCount | Returns the number of operands that are associated with a specified row or variable index. | |
GetOperands | Returns all operands that are associated with a row or variable index. | |
GetOperation | Returns the operation that is associated with a row or variable index. | |
GetProperty | Returns the value of a property that is at the specified index. (Inherited from RowVariableModel.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetValue | Returns the value that is associated with the specified variable index. (Inherited from RowVariableModel.) | |
IsConstant | Returns a value that indicates whether a row index is associated with a constant row. | |
IsGoal(Int32) | Returns a value that indicates whether a row index corresponds to a goal row. (Inherited from RowVariableGoalModel.) | |
IsGoal(Int32, IGoal%) | Returns a value that indicates whether a row index corresponds to a goal row, and returns the goal entry. (Inherited from RowVariableGoalModel.) | |
IsOperation | Returns a value that indicates whether a specified row index is associated with an operation row. | |
IsRow | Returns a value that indicates whether a variable index corresponds to a row. (Inherited from RowVariableModel.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
RemoveGoal | Removes a goal row. (Inherited from RowVariableGoalModel.) | |
SetBounds | Sets the bounds for the specified row. (Overrides RowVariableModel.SetBounds(Int32, Rational, Rational).) | |
SetIgnoreBounds | Specifies whether the bounds of a variable should be respected or ignored during a solve attempt. (Inherited from RowVariableModel.) | |
SetIntegrality | Specifies whether a variable is an integer variable. (Inherited from RowVariableModel.) | |
SetLowerBound | Sets or adjusts the lower bound of the specified variable. (Overrides RowVariableModel.SetLowerBound(Int32, Rational).) | |
SetProperty | Sets a property that is at the specified variable index. (Inherited from RowVariableModel.) | |
SetUpperBound | Sets or adjusts the upper bound of the specified variable. (Overrides RowVariableModel.SetUpperBound(Int32, Rational).) | |
SetValue | Sets the value for the specified variable index. (Overrides RowVariableModel.SetValue(Int32, Rational).) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TryGetIndexFromKey | Attempts to return the variable index that is associated with the specified key. (Inherited from RowVariableModel.) |
Top
Fields
Name | Description | |
---|---|---|
m_cvidInt | Represents the number of integer variables. (Inherited from RowVariableModel.) | |
m_mpkeyvid | Represents the mapping from key to variable index. (Inherited from RowVariableModel.) |
Top
Remarks
TermModel is the default implementation of ITermModel. TermModel can be inherited by a plug-in solver class.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.