Share via

ILinearModel Interface

  • Article

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

Syntax

'Declaration
Public Interface ILinearModel

public interface ILinearModel

public interface class ILinearModel

type ILinearModel =  interface end

public interface ILinearModel

The ILinearModel type exposes the following members.

Properties

  Name Description
Public property CoefficientCount Gets the number of nonzero coefficients in a linear model.
Public property GoalCount Gets the number of goals in a linear model.
Public property Goals Gets the goal collection of a linear model.
Public property Indices Gets the variable index collection of a linear model, inclusive of rows.
Public property IntegerIndexCount Gets the number of integer variables in a linear model.
Public property IsQuadraticModel Gets a value that indicates whether a model has a quadratic term on the objective function.
Public property IsSpecialOrderedSet Gets a value that indicates whether a linear model is a special ordered set.
Public property KeyComparer Gets the key that is used to compare rows or variables.
Public property KeyCount Gets the number of keys in a linear model, inclusive of rows and variables.
Public property Keys Gets the variable and row key collection of a linear model.
Public property RowCount Gets the number of rows in a linear model.
Public property RowIndices Gets the collection of row indexes for a linear model.
Public property RowKeys Gets the collection of row keys for a linear model.
Public property VariableCount Gets the number of variables in a linear model.
Public property VariableIndices Gets the collection of variable indexes for a linear model.
Public property VariableKeys Gets the collection of variable keys for linear model.

Top

Methods

  Name Description
Public method AddGoal Creates an ILinearGoal object and adds it to the goal list in a model.
Public method AddRow(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 method AddRow(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 method AddVariable Returns a value that indicates whether a user variable is added to a model.
Public method ClearGoals Clears all the goals in a model.
Public method GetBasic Returns a value that indicates whether a variable is a basic variable.
Public method GetBounds Returns the bounds for a variable.
Public method GetCoefficient(Int32, Int32) Returns the coefficient of the A matrix in a linear model.
Public method GetCoefficient(Int32, Int32, Int32) Returns the coefficient of the Q matrix on the objective row.
Public method GetGoalFromIndex Returns the goal entry if the row identifier is associated with a goal.
Public method GetIgnoreBounds Returns a value that indicates whether the bounds of a variable are ignored.
Public method GetIndexFromKey Returns an index that corresponds to the specified key.
Public method GetIntegrality Returns a value that indicates whether a variable is an integer variable.
Public method GetKeyFromIndex Returns the key that is associated with a variable index.
Public method GetRowEntries Returns the collection of nonzero variable entries.
Public method GetRowEntryCount Returns the number of nonzero coefficients for the specified row index.
Public method GetRowQuadraticEntries Returns a collection of nonzero variable entries on a quadratic row.
Public method GetSpecialOrderedSetTypeRowIndexes Returns a list of rows for a special ordered set.
Public method GetValue Returns the value that is associated with a variable index.
Public method GetValueState Gets the value state for the variable.
Public method GetVariableEntries Gets a collection of non-zero column entries for the specified column variable index.
Public method GetVariableEntryCount Returns the number of nonzero coefficients for the specified column variable index.
Public method IsGoal(Int32) Returns a value that indicates whether a row identifier is associated with a goal row.
Public method IsGoal(Int32, ILinearGoal%) Returns a value that indicates whether a row identifier is associated with a goal row.
Public method IsQuadraticVariable Returns a value that indicates whether a variable is in any quadratic row.
Public method IsRow Returns a value that indicates whether a variable index is associated with a row.
Public method RemoveGoal Attempts to remove a goal row and returns a value that indicates whether the row is removed successfully.
Public method SetBasic Sets the basic status for a variable.
Public method SetBounds Sets the bounds for a variable.
Public method SetCoefficient(Int32, Int32, Rational) Sets the coefficient of the A matrix in a linear model.
Public method SetCoefficient(Int32, Rational, Int32, Int32) Sets the coefficient of the Q matrix on the objective row.
Public method SetIgnoreBounds Sets a value that specifies whether to ignore or respect the bounds of a variable during a solve process.
Public method SetIntegrality Sets a value that indicates whether a variable is an integer.
Public method SetLowerBound Sets the lower bound of a variable.
Public method SetUpperBound Sets the upper bound of a variable.
Public method SetValue Sets the value of a linear model.
Public method TryGetIndexFromKey Returns a value that indicates whether a variable index exists for the specified key.

Top

See Also

Reference

Microsoft.SolverFoundation.Services Namespace