gum::credal::lp::LpInterface< GUM_SCALAR > Class Template Reference

Class representing a linear program. More...

#include <agrum/CN/LpInterface.h>

Collaboration diagram for gum::credal::lp::LpInterface< GUM_SCALAR >:

Public Member Functions
LpCol	addCol ()
	Insert a new column, i.e. More...
std::vector< LpCol >	addCols (const unsigned int &cols)
	Insert new columns, i.e. More...
void	addRow (const LpExpr &expr)
	Add rows to the linear program according to a given expression ( which must be at least an inequality ). More...
void	addRow (LpExpr &&expr)
	Add rows to the linear program according to a given expression ( which must be at least an inequality ). More...
void	addPositivity ()
	Add positivity constraints for all variables. More...
void	addSumIsOne ()
	Add sum of variables is 1 constraints. More...
void	addProba ()
	Add positivity constraints and sum of variables is 1 ( probability constraints ) More...
std::vector< std::vector< GUM_SCALAR > >	solve ()
	Solve the linear program (H-representation of the polytope) by enumeration (of the polytope vertices) using lexicographic reverse search (lrs). More...
std::vector< LpCol >	getCols () const
	Get the variables of the LP. More...
std::string	toString () const
	Get the string representation of a calling linear program. More...
void	clear ()
	Reset the rows (inequalities) and columns (variables) of the LP as if it was created. More...
void	clearRows ()
	Reset the rows (inequalities) of the LP but not the columns (variables are kept). More...
Constructor / Destructor
	LpInterface ()
	Default constructor, empty problem. More...
	LpInterface (const LpInterface< GUM_SCALAR > &from)
	Copy constructor. More...
	LpInterface (LpInterface< GUM_SCALAR > &&from)
	Move copy constructor. More...
	~LpInterface ()
	Default destructor. More...
Compound assignment operator
LpInterface< GUM_SCALAR > &	operator= (const LpInterface< GUM_SCALAR > &from)
	Copy compound assignment. More...
LpInterface< GUM_SCALAR > &	operator= (LpInterface< GUM_SCALAR > &&from)
	Move coumpound assignment. More...

Friends
template<typename T >
std::ostream &	operator<< (std::ostream &out, const LpInterface< T > &lpi)
	Overload of << to use with output streams ( such as std::cout << ). More...

Detailed Description

template<typename GUM_SCALAR>
class gum::credal::lp::LpInterface< GUM_SCALAR >

Class representing a linear program.

Author

Matthieu HOURBRACQ and Pierre-Henri WUILLEMIN

Definition at line 49 of file LpInterface.h.

Constructor & Destructor Documentation

LpInterface() [1/3]

template<typename GUM_SCALAR >

gum::credal::lp::LpInterface< GUM_SCALAR >::LpInterface

(

)

Default constructor, empty problem.

class LpInterface

Definition at line 750 of file LpInterface_tpl.h.

                                             {
        __positivity = false;
        __sumIsOne = false;
        GUM_CONSTRUCTOR(LpInterface);
      }

LpInterface() [2/3]

template<typename GUM_SCALAR >

gum::credal::lp::LpInterface< GUM_SCALAR >::LpInterface

(

const LpInterface< GUM_SCALAR > &

from

)

Copy constructor.

Parameters

from	The LpInterface to be copied.

Definition at line 757 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__rows.

                                                :
          __cols(from.__cols),
          __positivity(from.__positivity), __sumIsOne(from.__sumIsOne) {
        __rows.resize(from.__rows.size());

        for (unsigned int i = 0, end = from.__rows.size(); i < end; i++)
          __rows[i] = new LpRow(*from.__rows[i]);

        GUM_CONS_CPY(LpInterface);
      }

LpInterface() [3/3]

template<typename GUM_SCALAR >

gum::credal::lp::LpInterface< GUM_SCALAR >::LpInterface

(

LpInterface< GUM_SCALAR > &&

from

)

Move copy constructor.

Parameters

from	The temporary LpInterface to be moved.

Definition at line 770 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, and gum::credal::lp::LpInterface< GUM_SCALAR >::__rows.

                                                                             :
          __positivity(from.__positivity), __sumIsOne(from.__sumIsOne) {
        __rows.swap(from.__rows);
        __cols.swap(from.__cols);
        GUM_CONS_CPY(LpInterface);
      }

~LpInterface()

template<typename GUM_SCALAR >

gum::credal::lp::LpInterface< GUM_SCALAR >::~LpInterface

(

)

Default destructor.

Definition at line 778 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and gum::credal::lp::LpInterface< GUM_SCALAR >::operator=().

                                              {
        for (const auto row : __rows)
          delete row;

        GUM_DESTRUCTOR(LpInterface);
      }

Here is the call graph for this function:

Member Function Documentation

addCol()

template<typename GUM_SCALAR >

LpCol gum::credal::lp::LpInterface< GUM_SCALAR >::addCol

(

)

Insert a new column, i.e.

a new variable.

Returns

A copy of the variable.

Definition at line 826 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols.

                                              {
        LpCol col((unsigned int)__cols.size());

        __cols.push_back(col);

        return col;
      }

addCols()

template<typename GUM_SCALAR >

std::vector< LpCol > gum::credal::lp::LpInterface< GUM_SCALAR >::addCols

(

const unsigned int &

cols

)

Insert new columns, i.e.

new variables.

Parameters

cols	the constant reference to the number of variables we want.

Returns

The copy of the vector of all variables of the problem.

Definition at line 836 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, and GUM_ERROR.

                                                                    {
        if (cols < 1)
          GUM_ERROR(OperationNotAllowed,
                    "LpInterface::addCols ( cols ) : cols "
                    "needs must be equal or greater than 1 : "
                       << cols << " < 1");

        for (unsigned int i = 0; i < cols; i++) {
          __cols.push_back(LpCol((unsigned int)__cols.size()));
        }

        return __cols;
      }

addPositivity()

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::addPositivity

(

)

Add positivity constraints for all variables.

Definition at line 903 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, and gum::credal::lp::LpInterface< GUM_SCALAR >::addRow().

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addProba().

                                                    {
        if (__positivity) return;

        for (const auto& col : __cols)
          addRow(0 <= col);

        __positivity = true;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

addProba()

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::addProba

(

)

Add positivity constraints and sum of variables is 1 ( probability constraints )

Definition at line 927 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne, gum::credal::lp::LpInterface< GUM_SCALAR >::addPositivity(), gum::credal::lp::LpInterface< GUM_SCALAR >::addRow(), and gum::credal::lp::LpInterface< GUM_SCALAR >::addSumIsOne().

                                               {
        if (__positivity && __sumIsOne) {
          return;
        } else if (__positivity && !__sumIsOne) {
          addSumIsOne();
          return;
        } else if (!__positivity && __sumIsOne) {
          addPositivity();
          return;
        }

        // we can do both with one loop, don't call the above functions.
        // addPositivity();
        // addSumIsOne();
        LpExpr expr;

        for (const auto& col : __cols) {
          addRow(0 <= col);
          expr += col;
        }

        addRow(1 <= std::move(expr) <= 1);

        __sumIsOne = true;
        __positivity = true;
      }

Here is the call graph for this function:

addRow() [1/2]

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::addRow

(

const LpExpr &

expr

)

Add rows to the linear program according to a given expression ( which must be at least an inequality ).

Parameters

expr	the constant reference to the expression to convert to rows.

Definition at line 851 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpExpr::__ileft, gum::credal::lp::LpExpr::__iright, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, GUM_ERROR, and gum::credal::lp::LpExpr::toString().

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addPositivity(), gum::credal::lp::LpInterface< GUM_SCALAR >::addProba(), and gum::credal::lp::LpInterface< GUM_SCALAR >::addSumIsOne().

                                                               {
        if (!expr.__ileft && !expr.__iright)
          GUM_ERROR(OperationNotAllowed,
                    "addRow ( const LpExpr & expr ) : expr : "
                       << expr.toString() << "is not an inequality.");

        if ((expr.__ileft && !expr.__iright) || (!expr.__ileft && expr.__iright)) {
          __rows.push_back(new LpRow(expr, __cols));
        } else {
          LpExpr lexpr(expr, true, true, false);
          LpExpr rexpr(expr, false, true, true);

          __rows.push_back(
             new LpRow(std::move(lexpr),
                       __cols));   
          __rows.push_back(
             new LpRow(std::move(rexpr),
                       __cols));   
        }
      }

Here is the call graph for this function:

Here is the caller graph for this function:

addRow() [2/2]

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::addRow

(

LpExpr &&

expr

)

Add rows to the linear program according to a given expression ( which must be at least an inequality ).

Parameters

expr	the temporary expression to move to rows.

Definition at line 873 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpExpr::__imiddle, gum::credal::lp::LpExpr::__mCoeffs, gum::credal::lp::LpExpr::__mValue, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and GUM_ERROR.

                                                          {
        if (!expr.__ileft && !expr.__iright)
          GUM_ERROR(OperationNotAllowed,
                    "addRow ( const LpExpr & expr ) : expr : "
                       << expr.toString() << "is not an inequality.");

        if ((expr.__ileft && !expr.__iright) || (!expr.__ileft && expr.__iright)) {
          __rows.push_back(new LpRow(std::move(expr), __cols));
        } else {
          LpExpr lexpr(std::move(expr), true, true, false);

          LpExpr rexpr(std::move(expr), false, false, true);


          *rexpr.__mCoeffs = *lexpr.__mCoeffs;
          rexpr.__mValue = lexpr.__mValue;
          rexpr.__imiddle = true;

          __rows.push_back(
             new LpRow(std::move(lexpr),
                       __cols));   
          __rows.push_back(
             new LpRow(std::move(rexpr),
                       __cols));   
        }
      }

addSumIsOne()

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::addSumIsOne

(

)

Add sum of variables is 1 constraints.

Definition at line 913 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne, and gum::credal::lp::LpInterface< GUM_SCALAR >::addRow().

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addProba().

                                                  {
        if (__sumIsOne) return;

        LpExpr expr;

        for (const auto& col : __cols)
          expr += col;

        addRow(1 <= std::move(expr) <= 1);

        __sumIsOne = true;
      }

Here is the call graph for this function:

Here is the caller graph for this function:

clear()

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::clear

(

)

Reset the rows (inequalities) and columns (variables) of the LP as if it was created.

Definition at line 1005 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne.

                                            {
        for (const auto& row : __rows)
          delete row;

        __rows.clear();
        __rows.shrink_to_fit();   

        __cols.clear();
        __cols.shrink_to_fit();

        __positivity = false;
        __sumIsOne = false;
      }

clearRows()

template<typename GUM_SCALAR >

void gum::credal::lp::LpInterface< GUM_SCALAR >::clearRows

(

)

Reset the rows (inequalities) of the LP but not the columns (variables are kept).

Definition at line 1023 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne.

                                                {
        for (const auto& row : __rows)
          delete row;

        __rows.clear();
        __rows.shrink_to_fit();

        __positivity = false;
        __sumIsOne = false;
      }

getCols()

template<typename GUM_SCALAR >

std::vector< LpCol > gum::credal::lp::LpInterface< GUM_SCALAR >::getCols

(

)

const

Get the variables of the LP.

Returns

A copy of the variables as a vector of variables.

Definition at line 981 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols.

                                                                  {
        return __cols;
      }

operator=() [1/2]

template<typename GUM_SCALAR >

LpInterface< GUM_SCALAR > & gum::credal::lp::LpInterface< GUM_SCALAR >::operator=

(

const LpInterface< GUM_SCALAR > &

from

)

Copy compound assignment.

Parameters

from	The LpInterface to be copied.

Definition at line 787 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne.

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::~LpInterface().

                                                                                  {
        for (const auto& row : __rows)
          delete row;

        __rows.clear();
        __rows.shrink_to_fit();

        __rows.resize(from.__rows.size());

        for (unsigned int i = 0, end = from.__rows.size(); i < end; i++)
          __rows[i] = new LpRow(*from.__rows[i]);

        __cols = from.__cols;
        __positivity = from.__positivity;
        __sumIsOne = from.__sumIsOne;

        return *this;
      }

Here is the caller graph for this function:

operator=() [2/2]

template<typename GUM_SCALAR >

LpInterface< GUM_SCALAR > & gum::credal::lp::LpInterface< GUM_SCALAR >::operator=

(

LpInterface< GUM_SCALAR > &&

from

)

Move coumpound assignment.

Parameters

from	The temporary LpInterface to be moved.

Definition at line 809 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, and gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne.

                                                                             {
        __rows.swap(from.__rows);
        __cols.swap(from.__cols);

        __positivity = from.__positivity;
        __sumIsOne = from.__sumIsOne;

        return *this;
      }

solve()

template<typename GUM_SCALAR >

std::vector< std::vector< GUM_SCALAR > > gum::credal::lp::LpInterface< GUM_SCALAR >::solve

(

)

Solve the linear program (H-representation of the polytope) by enumeration (of the polytope vertices) using lexicographic reverse search (lrs).

Only works with bounded polyhedron (polytopes) and not unbounded ones (i.e. defined by vertices and rays).

Returns

The V-representation (vertices) of the polytope as a vector of vectors (vector of vertices).

Definition at line 955 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, gum::credal::lp::LpInterface< GUM_SCALAR >::__rows, gum::credal::LRSWrapper< GUM_SCALAR >::fillMatrix(), gum::credal::LRSWrapper< GUM_SCALAR >::getOutput(), gum::credal::LRSWrapper< GUM_SCALAR >::H2V(), and gum::credal::LRSWrapper< GUM_SCALAR >::setUpH().

                                                                            {
        LRSWrapper< GUM_SCALAR > lrs;

        lrs.setUpH((unsigned int)__cols.size());

        std::vector< std::vector< GUM_SCALAR > > lrsMatrix;

        for (const auto& row : __rows) {
          std::vector< GUM_SCALAR > expandedRow(__cols.size() + 1, 0);

          expandedRow[0] = row->__cste;

          for (const auto& elt : *row->__coeffs)
            expandedRow[elt.first.id() + 1] = elt.second;

          lrsMatrix.push_back(expandedRow);
        }

        lrs.fillMatrix(lrsMatrix);

        lrs.H2V();

        return lrs.getOutput();
      }

Here is the call graph for this function:

toString()

template<typename GUM_SCALAR >

std::string gum::credal::lp::LpInterface< GUM_SCALAR >::toString

(

)

const

Get the string representation of a calling linear program.

Returns

The string representation of the calling linear program.

Definition at line 986 of file LpInterface_tpl.h.

References gum::credal::lp::LpInterface< GUM_SCALAR >::__cols, and gum::credal::lp::LpInterface< GUM_SCALAR >::__rows.

                                                          {
        std::ostringstream s;

        s << std::endl << std::endl << "Variables : " << std::endl;

        for (const auto& col : __cols)
          s << " " << col.toString();

        s << std::endl;

        for (const auto& row : __rows)
          s << std::endl << row->toString();

        s << std::endl << std::endl;

        return s.str();
      }

Friends And Related Function Documentation

operator<<

template<typename GUM_SCALAR>

template<typename T >

std::ostream& operator<< ( std::ostream &  out, const LpInterface< T > &  lpi  )

friend

Overload of << to use with output streams ( such as std::cout << ).

Parameters

out	the reference to the caller, i.e. left side of <<.
lpi	the constant reference to the linear program whose representation we want.

Returns

The address of the caller.

Definition at line 820 of file LpInterface_tpl.h.

                                                                           {
        out << lpi.toString();
        return out;
      }

Member Data Documentation

__cols

template<typename GUM_SCALAR>

std::vector< LpCol > gum::credal::lp::LpInterface< GUM_SCALAR >::__cols

private

Variables of the problem.

Definition at line 754 of file LpInterface.h.

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addCol(), gum::credal::lp::LpInterface< GUM_SCALAR >::addCols(), gum::credal::lp::LpInterface< GUM_SCALAR >::addPositivity(), gum::credal::lp::LpInterface< GUM_SCALAR >::addProba(), gum::credal::lp::LpInterface< GUM_SCALAR >::addRow(), gum::credal::lp::LpInterface< GUM_SCALAR >::addSumIsOne(), gum::credal::lp::LpInterface< GUM_SCALAR >::clear(), gum::credal::lp::LpInterface< GUM_SCALAR >::getCols(), gum::credal::lp::LpInterface< GUM_SCALAR >::LpInterface(), gum::credal::lp::LpInterface< GUM_SCALAR >::operator=(), gum::credal::lp::LpInterface< GUM_SCALAR >::solve(), and gum::credal::lp::LpInterface< GUM_SCALAR >::toString().

__positivity

template<typename GUM_SCALAR>

bool gum::credal::lp::LpInterface< GUM_SCALAR >::__positivity

private

true if addPositivity() has been called, false otherwise.

Definition at line 758 of file LpInterface.h.

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addPositivity(), gum::credal::lp::LpInterface< GUM_SCALAR >::addProba(), gum::credal::lp::LpInterface< GUM_SCALAR >::clear(), gum::credal::lp::LpInterface< GUM_SCALAR >::clearRows(), and gum::credal::lp::LpInterface< GUM_SCALAR >::operator=().

__rows

template<typename GUM_SCALAR>

std::vector< LpRow* > gum::credal::lp::LpInterface< GUM_SCALAR >::__rows

private

Rows of the problem.

Definition at line 752 of file LpInterface.h.

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addRow(), gum::credal::lp::LpInterface< GUM_SCALAR >::clear(), gum::credal::lp::LpInterface< GUM_SCALAR >::clearRows(), gum::credal::lp::LpInterface< GUM_SCALAR >::LpInterface(), gum::credal::lp::LpInterface< GUM_SCALAR >::operator=(), gum::credal::lp::LpInterface< GUM_SCALAR >::solve(), gum::credal::lp::LpInterface< GUM_SCALAR >::toString(), and gum::credal::lp::LpInterface< GUM_SCALAR >::~LpInterface().

__sumIsOne

template<typename GUM_SCALAR>

bool gum::credal::lp::LpInterface< GUM_SCALAR >::__sumIsOne

private

true if addSumIsOne() has been called, false otherwise.

Definition at line 761 of file LpInterface.h.

Referenced by gum::credal::lp::LpInterface< GUM_SCALAR >::addProba(), gum::credal::lp::LpInterface< GUM_SCALAR >::addSumIsOne(), gum::credal::lp::LpInterface< GUM_SCALAR >::clear(), gum::credal::lp::LpInterface< GUM_SCALAR >::clearRows(), and gum::credal::lp::LpInterface< GUM_SCALAR >::operator=().

---

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

• agrum/CN/LpInterface.h
• agrum/CN/LpInterface_tpl.h