Export (0) Print
Expand All

ITermModel Interface

Solver Foundation 3.0

[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)

public interface ITermModel : IRowVariableModel, 
	IGoalModel

The ITermModel type exposes the following members.

  NameDescription
Public propertyGoalCountGets the number of goals in a model. (Inherited from IGoalModel.)
Public propertyGoalsGets the collection of goals for a model. (Inherited from IGoalModel.)
Public propertyIndicesGets the collection of variable indexes, inclusive of rows. (Inherited from IRowVariableModel.)
Public propertyIntegerIndexCountGets the number of integer variables in a model. (Inherited from IRowVariableModel.)
Public propertyKeyComparerGets an object that is used to compare rows or variables. (Inherited from IRowVariableModel.)
Public propertyKeyCountGets the number of keys in a model, inclusive of rows and variables. (Inherited from IRowVariableModel.)
Public propertyKeysGets the variable and row key collection. (Inherited from IRowVariableModel.)
Public propertyRowCountGets the number of rows in a model. (Inherited from IRowVariableModel.)
Public propertyRowIndicesGets the collection of row indexes in a model. (Inherited from IRowVariableModel.)
Public propertyRowKeysGets the collection of row keys. (Inherited from IRowVariableModel.)
Public propertyVariableCountGets the number of variables in a model. (Inherited from IRowVariableModel.)
Public propertyVariableIndicesGets the collection of variable indexes. (Inherited from IRowVariableModel.)
Public propertyVariableKeysGets the collection of variable keys. (Inherited from IRowVariableModel.)
Top

  NameDescription
Public methodAddConstantAdds a constant to a model.
Public methodAddGoalIdentifies the specified row as a goal row. (Inherited from IGoalModel.)
Public methodAddOperation(TermModelOperation, Int32, Int32)Adds an operation row to a model.
Public methodAddOperation(TermModelOperation, Int32, Int32[])Adds an operation row for operations that take an array of arguments to a model.
Public methodAddOperation(TermModelOperation, Int32, Int32, Int32)Adds an operation row for a two-operand operation to a model.
Public methodAddOperation(TermModelOperation, Int32, Int32, Int32, Int32)Adds an operation row for a three-operand operation to a model.
Public methodAddRowAdds a row to a model. (Inherited from IRowVariableModel.)
Public methodAddVariable(Object, Int32)Adds a user variable to a model. (Inherited from IRowVariableModel.)
Public methodAddVariable(Object, Int32, IEnumerable<Rational>)Adds a variable that has a fixed set of possible values to a model.
Public methodAddVariable(Object, Int32, Rational, Rational, Boolean)Adds a variable to a model.
Public methodClearGoalsClears all the goals from a model. (Inherited from IGoalModel.)
Public methodGetBoundsReturns the bounds for a variable. (Inherited from IRowVariableModel.)
Public methodGetGoalFromIndexReturns a goal entry if the row index is associated with a goal row. (Inherited from IGoalModel.)
Public methodGetIgnoreBoundsReturns a value that indicates whether the bounds of a variable are ignored. (Inherited from IRowVariableModel.)
Public methodGetIndexFromKeyReturns the index that is associated with a key. (Inherited from IRowVariableModel.)
Public methodGetIntegralityReturns a value that indicates whether a variable is an integer variable. (Inherited from IRowVariableModel.)
Public methodGetKeyFromIndexReturns the key that is associated with a variable index. (Inherited from IRowVariableModel.)
Public methodGetOperandReturns the variable index associated with an operand.
Public methodGetOperandCountReturns the number of operands associated with a variable index.
Public methodGetOperandsReturns all operands that are associated with a variable index.
Public methodGetOperationReturns the operation that is associated with a row or variable index.
Public methodGetValueReturns the value that is associated with a variable index. (Inherited from IRowVariableModel.)
Public methodIsConstantReturns a value that indicates whether a row index is associated with a constant row.
Public methodIsGoal(Int32)Returns a value that specifies whether a row index is a goal row. (Inherited from IGoalModel.)
Public methodIsGoal(Int32, IGoal)Returns a value that specifies whether a row index is a goal row, and returns the associated goal. (Inherited from IGoalModel.)
Public methodIsOperationReturns a value that indicates whether a row identifier is associated with an operation row.
Public methodIsRowReturns a value that indicates whether a variable index is a row. (Inherited from IRowVariableModel.)
Public methodRemoveGoalRemoves a goal row. (Inherited from IGoalModel.)
Public methodSetBoundsSets the bounds for a variable. (Inherited from IRowVariableModel.)
Public methodSetIgnoreBoundsSpecifies whether the bounds of a variable index should be respected or ignored during a solve process. (Inherited from IRowVariableModel.)
Public methodSetIntegralitySpecifies that a variable is an integer variable. (Inherited from IRowVariableModel.)
Public methodSetLowerBoundSets the lower bound of a variable. (Inherited from IRowVariableModel.)
Public methodSetUpperBoundSets the upper bound of a variable (Inherited from IRowVariableModel.)
Public methodSetValueSets the value for the specified variable index. (Inherited from IRowVariableModel.)
Public methodTryGetIndexFromKeyAttempts to return the variable index associated with a key. (Inherited from IRowVariableModel.)
Top
Show:
© 2014 Microsoft