My Project
OSMatlab Class Reference

The OSMatlab Class. More...

#include <OSMatlabSolver.h>

Public Member Functions

 OSMatlab ()
 the OSMatlab class constructor
 
 ~OSMatlab ()
 the OSMatlab class destructor
 
std::string solve ()
 Solve the problem instance.
 
void createOSInstance ()
 Create an OSInstance.
 

Public Attributes

SparseMatrixsparseMat
 sparseMat is a pointer to an OS Sprase Matrix data structure
 
double * bl
 bl is a pointer to the lower bounds on the constraints
 
double * bu
 bu is a pointer to the upper bounds on the constraints
 
double * obj
 obj is a pointer to the objective function coefficients
 
double * vl
 vl is a pointer to the lower bounds on the varialbes
 
double * vu
 vu is a pointer to the upper bounds on the variables
 
int numVar
 numVar is the number of variables in the problem
 
int numCon
 numCon is the number of constraints in the problem
 
char * varType
 varType is a pointer to the variable type eg C, B, I
 
bool objType
 objType indicates whether or not we have a max (1) or a min (0)
 
int numQTerms
 numQTerms is the number of quadratic terms
 
int * qRows
 qRows is a pointer to the row index of each quadratic term
 
int * qIndex1
 qIndex1 is a pointer to the index of the first variable in each of the quadratic terms
 
int * qIndex2
 qIndex2 is a pointer to the index of the second variable in each of the quadratic terms
 
double * qVal
 qVal is a pointer to the coefficient value of each of the quadratic terms.
 
DefaultSolversolverType
 solverType is the a pointer to the sovler that will be requested
 
std::string instanceName
 instanceName is the name of the problem instance
 
std::string sSolverName
 sSolverName is the name of the solver
 
std::string sAgentAddress
 is the address of the solver service
 
OSInstanceosinstance
 osinstance is a pointer to an OSInstance object that gets created from the MATLAB data structures
 
std::string osil
 is the osil instance that gets created from the MATLAB data structures
 

Detailed Description

The OSMatlab Class.

Author
Robert Fourer, Jun Ma, Kipp Martin
Version
1.0, 03/14/2004
Since
OS 1.0
Remarks
the OSMatlab class is used by the matlabSolver mex (Matlab EXecutable) which takes MATLAB data structures and creats an OSiL string.

for now we can only handle linear integer and quadratic programming problems, not general nonlinear problems

Definition at line 49 of file OSMatlabSolver.h.

Constructor & Destructor Documentation

◆ OSMatlab()

OSMatlab::OSMatlab ( )

the OSMatlab class constructor

Definition at line 36 of file OSMatlabSolver.cpp.

◆ ~OSMatlab()

OSMatlab::~OSMatlab ( )

the OSMatlab class destructor

Definition at line 61 of file OSMatlabSolver.cpp.

Member Function Documentation

◆ solve()

std::string OSMatlab::solve ( )

Solve the problem instance.

Returns
a string with the solution in OSrL format

Definition at line 66 of file OSMatlabSolver.cpp.

◆ createOSInstance()

void OSMatlab::createOSInstance ( )

Create an OSInstance.

Definition at line 200 of file OSMatlabSolver.cpp.

Member Data Documentation

◆ sparseMat

SparseMatrix* OSMatlab::sparseMat

sparseMat is a pointer to an OS Sprase Matrix data structure

Definition at line 63 of file OSMatlabSolver.h.

◆ bl

double* OSMatlab::bl

bl is a pointer to the lower bounds on the constraints

Definition at line 68 of file OSMatlabSolver.h.

◆ bu

double* OSMatlab::bu

bu is a pointer to the upper bounds on the constraints

Definition at line 73 of file OSMatlabSolver.h.

◆ obj

double* OSMatlab::obj

obj is a pointer to the objective function coefficients

Definition at line 78 of file OSMatlabSolver.h.

◆ vl

double* OSMatlab::vl

vl is a pointer to the lower bounds on the varialbes

Definition at line 83 of file OSMatlabSolver.h.

◆ vu

double* OSMatlab::vu

vu is a pointer to the upper bounds on the variables

Definition at line 88 of file OSMatlabSolver.h.

◆ numVar

int OSMatlab::numVar

numVar is the number of variables in the problem

Definition at line 93 of file OSMatlabSolver.h.

◆ numCon

int OSMatlab::numCon

numCon is the number of constraints in the problem

Definition at line 98 of file OSMatlabSolver.h.

◆ varType

char* OSMatlab::varType

varType is a pointer to the variable type eg C, B, I

Definition at line 103 of file OSMatlabSolver.h.

◆ objType

bool OSMatlab::objType

objType indicates whether or not we have a max (1) or a min (0)

Definition at line 108 of file OSMatlabSolver.h.

◆ numQTerms

int OSMatlab::numQTerms

numQTerms is the number of quadratic terms

Definition at line 111 of file OSMatlabSolver.h.

◆ qRows

int* OSMatlab::qRows

qRows is a pointer to the row index of each quadratic term

Definition at line 116 of file OSMatlabSolver.h.

◆ qIndex1

int* OSMatlab::qIndex1

qIndex1 is a pointer to the index of the first variable in each of the quadratic terms

Definition at line 121 of file OSMatlabSolver.h.

◆ qIndex2

int* OSMatlab::qIndex2

qIndex2 is a pointer to the index of the second variable in each of the quadratic terms

Definition at line 126 of file OSMatlabSolver.h.

◆ qVal

double* OSMatlab::qVal

qVal is a pointer to the coefficient value of each of the quadratic terms.

Definition at line 131 of file OSMatlabSolver.h.

◆ solverType

DefaultSolver* OSMatlab::solverType

solverType is the a pointer to the sovler that will be requested

Definition at line 136 of file OSMatlabSolver.h.

◆ instanceName

std::string OSMatlab::instanceName

instanceName is the name of the problem instance

Definition at line 139 of file OSMatlabSolver.h.

◆ sSolverName

std::string OSMatlab::sSolverName

sSolverName is the name of the solver

Definition at line 142 of file OSMatlabSolver.h.

◆ sAgentAddress

std::string OSMatlab::sAgentAddress

is the address of the solver service

Definition at line 145 of file OSMatlabSolver.h.

◆ osinstance

OSInstance* OSMatlab::osinstance

osinstance is a pointer to an OSInstance object that gets created from the MATLAB data structures

Definition at line 163 of file OSMatlabSolver.h.

◆ osil

std::string OSMatlab::osil

is the osil instance that gets created from the MATLAB data structures

Definition at line 168 of file OSMatlabSolver.h.


The documentation for this class was generated from the following files: