Export (0) Print
Expand All

ILinearModel 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 linear optimization model that consists of decision variables, constraints, and goals.

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

public interface ILinearModel

The ILinearModel type exposes the following members.

  NameDescription
Public propertyCoefficientCountGets the number of nonzero coefficients in a linear model.
Public propertyGoalCountGets the number of goals in a linear model.
Public propertyGoalsGets the goal collection of a linear model.
Public propertyIndicesGets the variable index collection of a linear model, inclusive of rows.
Public propertyIntegerIndexCountGets the number of integer variables in a linear model.
Public propertyIsQuadraticModelGets a value that indicates whether a model has a quadratic term on the objective function.
Public propertyIsSpecialOrderedSetGets a value that indicates whether a linear model is a special ordered set.
Public propertyKeyComparerGets the key that is used to compare rows or variables.
Public propertyKeyCountGets the number of keys in a linear model, inclusive of rows and variables.
Public propertyKeysGets the variable and row key collection of a linear model.
Public propertyRowCountGets the number of rows in a linear model.
Public propertyRowIndicesGets the collection of row indexes for a linear model.
Public propertyRowKeysGets the collection of row keys for a linear model.
Public propertyVariableCountGets the number of variables in a linear model.
Public propertyVariableIndicesGets the collection of variable indexes for a linear model.
Public propertyVariableKeysGets the collection of variable keys for linear model.
Top

  NameDescription
Public methodAddGoalCreates an ILinearGoal object and adds it to the goal list in a model.
Public methodAddRow(Object, Int32)Attempts to add a row to the models and returns a value that indicates whether a row is added to a model.
Public methodAddRow(Object, SpecialOrderedSetType, Int32)Attempts to add a row to the model and returns a value that indicates whether a reference row for a special ordered set is added to a model.
Public methodAddVariableReturns a value that indicates whether a user variable is added to a model.
Public methodClearGoalsClears all the goals in a model.
Public methodGetBasicReturns a value that indicates whether a variable is a basic variable.
Public methodGetBoundsReturns the bounds for a variable.
Public methodGetCoefficient(Int32, Int32)Returns the coefficient of the A matrix in a linear model.
Public methodGetCoefficient(Int32, Int32, Int32)Returns the coefficient of the Q matrix on the objective row.
Public methodGetGoalFromIndexReturns the goal entry if the row identifier is associated with a goal.
Public methodGetIgnoreBoundsReturns a value that indicates whether the bounds of a variable are ignored.
Public methodGetIndexFromKeyReturns an index that corresponds to the specified key.
Public methodGetIntegralityReturns a value that indicates whether a variable is an integer variable.
Public methodGetKeyFromIndexReturns the key that is associated with a variable index.
Public methodGetRowEntriesReturns the collection of nonzero variable entries.
Public methodGetRowEntryCountReturns the number of nonzero coefficients for the specified row index.
Public methodGetRowQuadraticEntriesReturns a collection of nonzero variable entries on a quadratic row.
Public methodGetSpecialOrderedSetTypeRowIndexesReturns a list of rows for a special ordered set.
Public methodGetValueReturns the value that is associated with a variable index.
Public methodGetValueStateGets the value state for the variable.
Public methodGetVariableEntriesGets a collection of non-zero column entries for the specified column variable index.
Public methodGetVariableEntryCountReturns the number of nonzero coefficients for the specified column variable index.
Public methodIsGoal(Int32)Returns a value that indicates whether a row identifier is associated with a goal row.
Public methodIsGoal(Int32, ILinearGoal)Returns a value that indicates whether a row identifier is associated with a goal row.
Public methodIsQuadraticVariableReturns a value that indicates whether a variable is in any quadratic row.
Public methodIsRowReturns a value that indicates whether a variable index is associated with a row.
Public methodRemoveGoalAttempts to remove a goal row and returns a value that indicates whether the row is removed successfully.
Public methodSetBasicSets the basic status for a variable.
Public methodSetBoundsSets the bounds for a variable.
Public methodSetCoefficient(Int32, Int32, Rational)Sets the coefficient of the A matrix in a linear model.
Public methodSetCoefficient(Int32, Rational, Int32, Int32)Sets the coefficient of the Q matrix on the objective row.
Public methodSetIgnoreBoundsSets a value that specifies whether to ignore or respect the bounds of a variable during a solve process.
Public methodSetIntegralitySets a value that indicates whether a variable is an integer.
Public methodSetLowerBoundSets the lower bound of a variable.
Public methodSetUpperBoundSets the upper bound of a variable.
Public methodSetValueSets the value of a linear model.
Public methodTryGetIndexFromKeyReturns a value that indicates whether a variable index exists for the specified key.
Top
Show:
© 2014 Microsoft