flopc::MP_constraint Class Reference
[Public interface]

Semantic representation of a linear constraint. More...

#include <MP_constraint.hpp>

Inheritance diagram for flopc::MP_constraint:
Inheritance graph
[legend]
Collaboration diagram for flopc::MP_constraint:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 MP_constraint (const MP_set_base &s1=MP_set::getEmpty(), const MP_set_base &s2=MP_set::getEmpty(), const MP_set_base &s3=MP_set::getEmpty(), const MP_set_base &s4=MP_set::getEmpty(), const MP_set_base &s5=MP_set::getEmpty())
 construct the MP_constraint with appropriate sets for indexing.
MP_constraintoperator() (const MP_index_exp &i1=MP_index_exp::getEmpty(), const MP_index_exp &i2=MP_index_exp::getEmpty(), const MP_index_exp &i3=MP_index_exp::getEmpty(), const MP_index_exp &i4=MP_index_exp::getEmpty(), const MP_index_exp &i5=MP_index_exp::getEmpty())
 operator int ()
virtual ~MP_constraint ()
double price (int i1=0, int i2=0, int i3=0, int i4=0, int i5=0) const
void coefficients (vector< MP::Coef > &cfs)
int row_number () const
MP_constraintsuch_that (const MP_boolean &b)
void insertVariables (set< MP_variable * > &v)
void operator= (const Constraint &v)
void display (string s="") const

Public Attributes

MP_modelM
int offset
MP_expression left
MP_expression right
Sense_enum sense

Private Attributes

MP_boolean B
const MP_set_baseS1
const MP_set_baseS2
const MP_set_baseS3
const MP_set_baseS4
const MP_set_baseS5
MP_index_exp I1
MP_index_exp I2
MP_index_exp I3
MP_index_exp I4
MP_index_exp I5

Detailed Description

Semantic representation of a linear constraint.

This is one of the main public interface classes. It is always constructed through operator overloading between expressions, constants, and variables. There are many 'friend' overloaded operators to do the constuction. The basic idea is to make the constraint look like a paper-model constraint in C++ code. Once constructed, it should be added to the model.

The snippet below is an overly simplistic example, but is ok for illustration.
MP_model aModel; // your model
MP_set I; // the set the constraint is defined over.
MP_variable x(I); // your variable
...
MP_constraint cons(I); // construct the right number of constraints.
cons = x <= 3;
// Assign in the semantic rep to it. aModel.add(cons); // add it to the model

There is quite a bit of C++ machinery going on there.

Definition at line 207 of file MP_constraint.hpp.


Constructor & Destructor Documentation

flopc::MP_constraint::MP_constraint ( const MP_set_base s1 = MP_set::getEmpty(),
const MP_set_base s2 = MP_set::getEmpty(),
const MP_set_base s3 = MP_set::getEmpty(),
const MP_set_base s4 = MP_set::getEmpty(),
const MP_set_base s5 = MP_set::getEmpty() 
)

construct the MP_constraint with appropriate sets for indexing.

virtual flopc::MP_constraint::~MP_constraint (  )  [inline, virtual]

Definition at line 234 of file MP_constraint.hpp.


Member Function Documentation

MP_constraint& flopc::MP_constraint::operator() ( const MP_index_exp i1 = MP_index_exp::getEmpty(),
const MP_index_exp i2 = MP_index_exp::getEmpty(),
const MP_index_exp i3 = MP_index_exp::getEmpty(),
const MP_index_exp i4 = MP_index_exp::getEmpty(),
const MP_index_exp i5 = MP_index_exp::getEmpty() 
) [inline]

Definition at line 218 of file MP_constraint.hpp.

flopc::MP_constraint::operator int (  )  [inline]

Definition at line 229 of file MP_constraint.hpp.

double flopc::MP_constraint::price ( int  i1 = 0,
int  i2 = 0,
int  i3 = 0,
int  i4 = 0,
int  i5 = 0 
) const
void flopc::MP_constraint::coefficients ( vector< MP::Coef > &  cfs  ) 
int flopc::MP_constraint::row_number (  )  const
MP_constraint& flopc::MP_constraint::such_that ( const MP_boolean b  )  [inline]

Definition at line 242 of file MP_constraint.hpp.

void flopc::MP_constraint::insertVariables ( set< MP_variable * > &  v  ) 
void flopc::MP_constraint::operator= ( const Constraint v  ) 
void flopc::MP_constraint::display ( string  s = ""  )  const

Member Data Documentation

Definition at line 253 of file MP_constraint.hpp.

Definition at line 254 of file MP_constraint.hpp.

Definition at line 255 of file MP_constraint.hpp.

Definition at line 255 of file MP_constraint.hpp.

Definition at line 256 of file MP_constraint.hpp.

Definition at line 258 of file MP_constraint.hpp.

Definition at line 259 of file MP_constraint.hpp.

Definition at line 259 of file MP_constraint.hpp.

Definition at line 259 of file MP_constraint.hpp.

Definition at line 259 of file MP_constraint.hpp.

Definition at line 259 of file MP_constraint.hpp.

Definition at line 260 of file MP_constraint.hpp.

Definition at line 260 of file MP_constraint.hpp.

Definition at line 260 of file MP_constraint.hpp.

Definition at line 260 of file MP_constraint.hpp.

Definition at line 260 of file MP_constraint.hpp.


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

Generated on 15 Mar 2015 for Coin-All by  doxygen 1.6.1