SecondOrderConicModel Class
[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]
Defines a second order conic optimization problem.
Inheritance Hierarchy
System.Object
Microsoft.SolverFoundation.Services.RowVariableModel
Microsoft.SolverFoundation.Services.LinearModel
Microsoft.SolverFoundation.Services.SecondOrderConicModel
Microsoft.SolverFoundation.Solvers.InteriorPointSolver
Namespace: Microsoft.SolverFoundation.Services
Assembly: Microsoft.Solver.Foundation (in Microsoft.Solver.Foundation.dll)
Syntax
'Declaration
Public Class SecondOrderConicModel _
Inherits LinearModel _
Implements ISecondOrderConicModel, ILinearModel
public class SecondOrderConicModel : LinearModel,
ISecondOrderConicModel, ILinearModel
public ref class SecondOrderConicModel : public LinearModel,
ISecondOrderConicModel, ILinearModel
type SecondOrderConicModel =
class
inherit LinearModel
interface ISecondOrderConicModel
interface ILinearModel
end
public class SecondOrderConicModel extends LinearModel implements ISecondOrderConicModel, ILinearModel
The SecondOrderConicModel type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SecondOrderConicModel | Initializes a new instance of the SecondOrderConicModel class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
CoefficientCount | Gets the number of non-zero coefficients in a linear model. (Inherited from LinearModel.) |
|
ConeCount | Gets the number of cones in a model. |
|
Cones | Gets the cone collection of a model. |
|
GoalCount | Gets the number of goals in a linear model. (Inherited from LinearModel.) |
|
Goals | Gets the goal collection of a linear model. (Inherited from LinearModel.) |
|
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.) |
|
IsQuadraticModel | Gets a value that indicates whether a model has a quadratic term on the objective function. (Inherited from LinearModel.) |
|
IsSocpModel | Gets a value that indicates whether a model contains any second order cones. |
|
IsSpecialOrderedSet | Gets a value that indicates whether a linear model is a special ordered set. (Inherited from LinearModel.) |
|
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 of a linear model. (Inherited from LinearModel.) |
|
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 | |
|---|---|---|
|
AddGoal | Creates an ILinearGoal object and adds it to the goal list in a model. (Inherited from LinearModel.) |
|
AddRow(Object, Int32%) | Adds a row to a linear model. (Inherited from LinearModel.) |
|
AddRow(Object, SpecialOrderedSetType, Int32%) | Adds a reference row for a special ordered set to a linear model. (Inherited from LinearModel.) |
|
AddRow(Object, SecondOrderConeType, Int32%) | Adds a row for a second order cone to a model. |
|
AddRow(Object, Int32, SecondOrderConeRowType, Int32%) | Returns a value that indicates whether a conic row is added to a model. |
|
AddVariable | Adds a user variable to a model. (Inherited from RowVariableModel.) |
|
ClearGoals | Clears all the goals in a linear model. (Inherited from LinearModel.) |
|
Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetBasic | Returns a value that indicates whether a variable is a basic variable. (Inherited from LinearModel.) |
|
GetBounds | Returns the bounds for a variable. (Inherited from RowVariableModel.) |
|
GetCoefficient(Int32, Int32) | Returns the coefficient of the A matrix in a linear model. (Inherited from LinearModel.) |
|
GetCoefficient(Int32, Int32, Int32) | Returns the coefficient of the Q matrix on the objective row. (Inherited from LinearModel.) |
|
GetConicRowCount | Returns the number of row for the specified cone. |
|
GetConicRowIndexes | Returns the rows for the specified cone. |
|
GetGoalFromIndex | Returns a goal entry if the row index is associated with a goal. (Inherited from LinearModel.) |
|
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.) |
|
GetProperty | Returns the value of a property that is at the specified index. (Inherited from RowVariableModel.) |
|
GetRowEntries | Returns the collection of non-zero variable entries. (Inherited from LinearModel.) |
|
GetRowEntryCount | Returns the number of non-zero coefficients for the given row index. (Inherited from LinearModel.) |
|
GetRowQuadraticEntries | Returns a collection of non-zero variable entries on a quadratic row. (Inherited from LinearModel.) |
|
GetSpecialOrderedSetTypeRowIndexes | Returns a list of rows for a special ordered set. (Inherited from LinearModel.) |
|
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.) |
|
GetValueState | Returns the value state for a variable. (Inherited from LinearModel.) |
|
GetVariableEntries | Returns a collection of non-zero column entries. (Inherited from LinearModel.) |
|
GetVariableEntryCount | Returns the number of non-zero coefficients for a given column variable index. (Inherited from LinearModel.) |
|
InitModel | Allocates data structures for a new model. (Inherited from LinearModel.) |
|
IsConicRow | Returns a value that indicates whether a row is a conic row. |
|
IsGoal(Int32) | Returns a value that indicates whether a row identifier is a goal row. (Inherited from LinearModel.) |
|
IsGoal(Int32, ILinearGoal%) | Returns a value that indicates whether a row identifier is a goal row. (Inherited from LinearModel.) |
|
IsQuadraticVariable | Returns a value that indicates whether a variable is in any quadratic row. (Inherited from LinearModel.) |
|
IsRow | Returns a value that indicates whether a variable index corresponds to a row. (Inherited from RowVariableModel.) |
|
LoadLinearModel | Loads the information from one linear model into another model. (Inherited from LinearModel.) |
|
LoadSecondOrderConicModel | Loads information for a second order conic model. |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
Preallocate | Allocates data structures for a new linear model. (Inherited from LinearModel.) |
|
RemoveGoal | Removes a goal row. (Inherited from LinearModel.) |
|
SetBasic | Sets the basic status for a variable. (Inherited from LinearModel.) |
|
SetBounds | Sets the bounds for a row. (Inherited from RowVariableModel.) |
|
SetCoefficient(Int32, Int32, Rational) | Sets the coefficient of the A matrix in a model. (Overrides LinearModel.SetCoefficient(Int32, Int32, Rational).) |
|
SetCoefficient(Int32, Rational, Int32, Int32) | Sets the coefficient of the Q matrix on the objective row. (Inherited from LinearModel.) |
|
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 the lower bound of a variable. (Inherited from RowVariableModel.) |
|
SetPrimaryConic | Specifies a primary variable for a cone. |
|
SetProperty | Sets a property that is at the specified variable index. (Inherited from RowVariableModel.) |
|
SetUpperBound | Sets the upper bound of a variable. (Inherited from RowVariableModel.) |
|
SetValue | Sets the value for the specified variable index. (Inherited from RowVariableModel.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
|
TryGetConeFromIndex | Attempts to return a second order cone associated with a specified row. |
|
TryGetIndexFromKey | Attempts to return the variable index that is associated with the specified key. (Inherited from RowVariableModel.) |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Protected field") |
m_cvidBasic | Represents the number of variables that are marked as basic. (Inherited from LinearModel.) |
|
m_cvidInt | Represents the number of integer variables. (Inherited from RowVariableModel.) |
|
m_mpkeyvid | Represents the mapping from key to variable index. (Inherited from RowVariableModel.) |
|
m_qpRowVar | The goal variable that has the QP form. (Inherited from LinearModel.) |
Top
Remarks
Second order conic (SOCP) models are distinguished from linear models by the use of conic constraints. Cones come in two types: quadratic and rotated quadratic.
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.