InteriorPointSolver Class

[This documentation is for preview only, and is subject to change in later releases. Blank topics are included as placeholders.]

Solves linear and nonlinear convex optimization problems.

Inheritance Hierarchy

System.Object
  Microsoft.SolverFoundation.Services.RowVariableModel
    Microsoft.SolverFoundation.Services.LinearModel
      Microsoft.SolverFoundation.Services.SecondOrderConicModel
        Microsoft.SolverFoundation.Solvers.InteriorPointSolver

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

Syntax

'Declaration
Public Class InteriorPointSolver _
    Inherits SecondOrderConicModel _
    Implements ILinearSolver, ISolver, ILinearModel, ILinearSolution,  _
    ISolverSolution, ILogSource, IInteriorPointStatistics, IReportProvider, ILinearSolverSensitivityReport,  _
    ILinearSolverReport

public class InteriorPointSolver : SecondOrderConicModel, 
    ILinearSolver, ISolver, ILinearModel, ILinearSolution, ISolverSolution, 
    ILogSource, IInteriorPointStatistics, IReportProvider, ILinearSolverSensitivityReport, ILinearSolverReport

public ref class InteriorPointSolver : public SecondOrderConicModel, 
    ILinearSolver, ISolver, ILinearModel, ILinearSolution, ISolverSolution, 
    ILogSource, IInteriorPointStatistics, IReportProvider, ILinearSolverSensitivityReport, ILinearSolverReport

type InteriorPointSolver =  
    class
        inherit SecondOrderConicModel
        interface ILinearSolver
        interface ISolver
        interface ILinearModel
        interface ILinearSolution
        interface ISolverSolution
        interface ILogSource
        interface IInteriorPointStatistics
        interface IReportProvider
        interface ILinearSolverSensitivityReport
        interface ILinearSolverReport
    end

public class InteriorPointSolver extends SecondOrderConicModel implements ILinearSolver, ISolver, ILinearModel, ILinearSolution, ISolverSolution, ILogSource, IInteriorPointStatistics, IReportProvider, ILinearSolverSensitivityReport, ILinearSolverReport

The InteriorPointSolver type exposes the following members.

Constructors

	Name	Description
	InteriorPointSolver()	Initializes a new instance of the InteriorPointSolver class.
	InteriorPointSolver(IEqualityComparer<Object>)	Initializes a new instance of the InteriorPointSolver class.
	InteriorPointSolver(ISolverEnvironment)	Initializes a new instance of the InteriorPointSolver class.

Top

Properties

	Name	Description
	Algorithm	Gets the type of algorithm that is used for interior point programming.
	CoefficientCount	Gets the number of non-zero coefficients in a linear model. (Inherited from LinearModel.)
	ConeCount	Gets the number of cones in a model. (Inherited from SecondOrderConicModel.)
	Cones	Gets the cone collection of a model. (Inherited from SecondOrderConicModel.)
	Dual	Gets the dual version of the objective.
	Gap	Gets the gap between primal and dual objective values.
	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.)
	IsInteriorPoint	Gets a value that indicates whether a solver is an interior point solver.
	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. (Inherited from SecondOrderConicModel.)
	IsSpecialOrderedSet	Gets a value that indicates whether a linear model is a special ordered set. (Inherited from LinearModel.)
	IterationCount	Gets the number of iterations that have occurred.
	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.)
	KktForm	Gets the form of the Karush-Kuhn-Tucker (KKT) algorithm used.
	LpResult	Gets the result of solving the linear programming (LP) relaxation.
	MipBestBound	Gets the best result from the mixed integer programming solver (MIP) solver.
	MipResult	Gets a result after considering the integrality conditions.
	Parameters	Gets or sets the options for solving and reporting events.
	Primal	Gets the primal version of the objective.
	Result	Gets the result of a solve attempt.
	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.)
	SolutionQuality	Gets the quality level of a solution.
	SolvedGoalCount	Gets the number of goals being solved.
	Statistics	Gets the metrics for the interior point method algorithm solution.
	VarCount	Gets the total number of user and slack variables.
	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.)
	AddListener	Attempts to add a tracing listener and returns a value that indicates whether a tracing listener is added.
	AddRow(Object, Int32%)	Adds a row to a linear model. (Inherited from LinearModel.)
	AddRow(Object, SecondOrderConeType, Int32%)	Adds a row for a second order cone to a model. (Inherited from SecondOrderConicModel.)
	AddRow(Object, SpecialOrderedSetType, Int32%)	Returns a value that indicates whether a reference row is added to a model for a special ordered set. (Overrides LinearModel.AddRow(Object, SpecialOrderedSetType, Int32%).)
	AddRow(Object, Int32, SecondOrderConeRowType, Int32%)	Returns a value that indicates whether a conic row is added to a model. (Inherited from SecondOrderConicModel.)
	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.)
	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. (Inherited from SecondOrderConicModel.)
	GetConicRowIndexes	Returns the rows for the specified cone. (Inherited from SecondOrderConicModel.)
	GetDualValue	Returns the dual value for a row constraint.
	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. (Overrides RowVariableModel.GetProperty(String, Int32).)
	GetReport(LinearSolverReportType)	Generates a sensitivity report.
	GetReport(SolverContext, Solution, SolutionMapping)	Generates a report.
	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.)
	GetSolutionValue	Returns the objective value of a goal.
	GetSolvedGoal	Returns information about a solved goal.
	GetSpecialOrderedSetTypeRowIndexes	Returns a list of row indexes for SOS1 or SOS2 types. (Overrides LinearModel.GetSpecialOrderedSetTypeRowIndexes(SpecialOrderedSetType).)
	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. (Inherited from SecondOrderConicModel.)
	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. (Inherited from SecondOrderConicModel.)
	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.)
	RemoveListener	Removes a tracing listener.
	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. (Inherited from SecondOrderConicModel.)
	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	Sets a value that indicates whether a variable is an integer. (Overrides RowVariableModel.SetIntegrality(Int32, Boolean).)
	SetLowerBound	Sets the lower bound of a variable. (Inherited from RowVariableModel.)
	SetPrimaryConic	Specifies a primary variable for a cone. (Inherited from SecondOrderConicModel.)
	SetProperty	Sets the value of a property. (Overrides RowVariableModel.SetProperty(String, Int32, Object).)
	SetUpperBound	Sets the upper bound of a variable. (Inherited from RowVariableModel.)
	SetValue	Sets the value for the specified variable index. (Inherited from RowVariableModel.)
	Shutdown	Stops a solver instance.
	Solve(array<InteriorPointSolverParams[])	Runs a solver using one thread per solver parameter.
	Solve(ISolverParameters)	Runs a solver, using one solver parameter.
	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. (Inherited from SecondOrderConicModel.)
	TryGetIndexFromKey	Attempts to return the variable index that is associated with the specified key. (Inherited from RowVariableModel.)

Top

Fields

	Name	Description
	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

Explicit Interface Implementations

	Name	Description
	IInteriorPointStatistics.Gap	Gets the difference between primal and dual objective values.
	IInteriorPointStatistics.RowCount	Gets the number of rows in the solver model.
	ILinearSolverSensitivityReport.GetObjectiveCoefficientRange(Int32)	Returns the coefficient range of the first goal row.
	ILinearSolverSensitivityReport.GetObjectiveCoefficientRange(Int32, Int32)	Returns the coefficient range of a goal row.
	ILinearSolverSensitivityReport.GetVariableRange	Returns the range of a variable.

Top

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.

See Also

Reference

Microsoft.SolverFoundation.Solvers Namespace