LpInterface.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN and Christophe GONZALES  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef __LP_INTERFACE__H__
#define __LP_INTERFACE__H__

#include <iostream>
#include <sstream>
#include <string>

#include <agrum/CN/LrsWrapper.h>
#include <agrum/core/hashFunc.h>
#include <agrum/core/hashTable.h>
#include <agrum/core/utils_misc.h>

namespace gum {
  namespace credal {
    namespace lp {

      class LpCol;
      class LpRow;
      template < typename GUM_SCALAR >
      class LpInterface;
      class LpExpr;

      class LpCol {
        public:

        explicit LpCol(unsigned int id);

        LpCol(const LpCol& col);

        ~LpCol();


        unsigned int id() const;


        bool operator<(const LpCol& col) const;

        bool operator==(const LpCol& col) const;

        bool operator!=(const LpCol& col) const;

        LpCol& operator=(const LpCol& col);

        friend std::ostream&
           operator<<(std::ostream& out,
                      const LpCol&  col);   // calls col.toString(),
                                           // friend is useless but
                                           // good for documentation
                                           // purpose


        std::string toString() const;

        protected:
        private:
        unsigned int __id;
      };

    }   // end of namespace lp

  }   // end of namespace credal

}   // end of namespace gum

namespace gum {

  template <>
  class HashFunc< credal::lp::LpCol > : public HashFuncBase< credal::lp::LpCol > {
    public:
    static Size castToSize(const credal::lp::LpCol& key);

    virtual Size operator()(const credal::lp::LpCol& key) const override final;
  };
}   // end of namespace gum

namespace gum {
  namespace credal {
    namespace lp {

      class LpExpr {
        friend class LpRow;
        template < typename GUM_SCALAR >
        friend class LpInterface;

        public:

        LpExpr();

        LpExpr(const LpExpr& expr);

        LpExpr(const LpExpr& expr, bool copyLeft, bool copyMiddle, bool copyRight);

        LpExpr(LpExpr&& expr);

        LpExpr(LpExpr&& expr, bool copyLeft, bool copyMiddle, bool copyRight);

        ~LpExpr();



        LpExpr& operator=(const LpCol& rhs);

        LpExpr& operator=(const LpExpr& rhs);

        LpExpr& operator=(LpExpr&& rhs);

        template < typename SCALAR >
        LpExpr& operator=(const SCALAR& rhs);



        LpExpr& operator+=(const LpCol& rhs);

        LpExpr& operator+=(const LpExpr& rhs);

        LpExpr& operator+=(LpExpr&& rhs);

        template < typename T >
        LpExpr& operator+=(const T& rhs);



        LpExpr& operator-=(const LpCol& rhs);

        LpExpr& operator-=(const LpExpr& rhs);

        template < typename T >
        LpExpr& operator-=(const T& rhs);


        void clear();

        std::string toString() const;

        template < typename T1, typename T2 >
        static LpExpr lessThan(T1&& lhs, T2&& rhs);
        template < typename SCALAR >
        static LpExpr multiply(const SCALAR& lhs, const LpCol& rhs);

        protected:
        private:
        bool __ileft;
        bool __imiddle;
        bool __iright;

        double __lValue;
        double __mValue;
        double __rValue;

        HashTable< LpCol, double >* __lCoeffs;
        HashTable< LpCol, double >* __mCoeffs;
        HashTable< LpCol, double >* __rCoeffs;


        inline void __addSide(const LpCol& from);

        inline void __addSide(const LpExpr& from);

        inline void __addSide(LpExpr&& from);

        template < typename SCALAR >
        inline void __addSide(const SCALAR& from);

      };

      class LpRow {
        template < typename GUM_SCALAR >
        friend class LpInterface;

        public:

        LpRow(const LpExpr& expr, const std::vector< LpCol >& cols);

        LpRow(LpExpr&& expr, const std::vector< LpCol >& cols);

        LpRow(const LpRow& row);

        LpRow(LpRow&& row);

        ~LpRow();



        LpRow& operator=(const LpRow& row);
        LpRow& operator=(LpRow&& row);


        friend std::ostream&
           operator<<(std::ostream& out,
                      const LpRow&  row);   // calls row.toString(),
                                           // friend is useless but
                                           // good for documentation
                                           // purpose

        std::string toString() const;

        protected:
        private:
        double __cste;

        HashTable< LpCol, double >* __coeffs;

      };   // end of class LpRow

      template < typename GUM_SCALAR >
      class LpInterface {
        public:

        LpInterface();

        LpInterface(const LpInterface< GUM_SCALAR >& from);

        LpInterface(LpInterface< GUM_SCALAR >&& from);

        ~LpInterface();



        LpInterface< GUM_SCALAR >&
           operator=(const LpInterface< GUM_SCALAR >& from);

        LpInterface< GUM_SCALAR >& operator=(LpInterface< GUM_SCALAR >&& from);


        template < typename T >
        friend std::ostream&
           operator<<(std::ostream&           out,
                      const LpInterface< T >& lpi);   // calls lpi.toString(),
                                                      // friend is useless but good
                                                      // for documentation purpose

        LpCol addCol();

        std::vector< LpCol > addCols(const unsigned int& cols);

        void addRow(const LpExpr& expr);

        void addRow(LpExpr&& expr);

        void addPositivity();

        void addSumIsOne();

        void addProba();

        std::vector< std::vector< GUM_SCALAR > > solve();

        std::vector< LpCol > getCols() const;

        std::string toString() const;

        void clear();
        void clearRows();

        protected:
        private:
        std::vector< LpRow* > __rows;
        std::vector< LpCol > __cols;

        bool __positivity;
        bool __sumIsOne;

      };   // end of class LpInterface

      inline void swap(HashTable< LpCol, double >*& a,
                       HashTable< LpCol, double >*& b);


      template < typename T2 >
      LpExpr operator+(LpExpr&& lhs, const T2& rhs);
      template < typename T2 >
      LpExpr operator+(LpExpr& lhs, const T2& rhs);

      template < typename T1, forbidden_type< T1, LpExpr > = 0 >
      LpExpr operator+(const T1& lhs, LpExpr&& rhs);
      template < typename T1, forbidden_type< T1, LpExpr > = 0 >
      LpExpr operator+(const T1& lhs, LpExpr& rhs);

      template < typename T2, forbidden_type< T2, LpExpr > = 0 >
      LpExpr operator+(const LpCol& lhs, const T2& rhs);

      template < typename T1,
                 forbidden_type< T1, LpExpr > = 0,
                 forbidden_type< T1, LpCol > = 0 >
      LpExpr operator+(const T1& lhs, const LpCol& rhs);


      template < typename T2 >
      LpExpr operator-(LpExpr&& lhs, const T2& rhs);
      template < typename T2 >
      LpExpr operator-(LpExpr& lhs, const T2& rhs);

      template < typename T1, forbidden_type< T1, LpExpr > = 0 >
      LpExpr operator-(const T1& lhs, LpExpr&& rhs);
      template < typename T1, forbidden_type< T1, LpExpr > = 0 >
      LpExpr operator-(const T1& lhs, LpExpr& rhs);

      template < typename T2, forbidden_type< T2, LpExpr > = 0 >
      LpExpr operator-(const LpCol& lhs, const T2& rhs);

      template < typename T1,
                 forbidden_type< T1, LpExpr > = 0,
                 forbidden_type< T1, LpCol > = 0 >
      LpExpr operator-(const T1& lhs, const LpCol& rhs);


      template < typename SCALAR >
      LpExpr operator*(const SCALAR& lhs, const LpCol& rhs);

      template < typename SCALAR >
      LpExpr operator*(const LpCol& lhs, const SCALAR& rhs);



      template < typename T2 >
      LpExpr operator<=(const LpExpr& lhs, T2&& rhs);
      template < typename T2 >
      LpExpr operator<=(const LpCol& lhs, T2&& rhs);
      template < typename T1,
                 forbidden_type< T1, LpExpr& > = 0,
                 forbidden_type< T1, LpCol& > = 0 >
      LpExpr operator<=(T1&& lhs, const LpExpr& rhs);
      template < typename T1,
                 forbidden_type< T1, LpExpr& > = 0,
                 forbidden_type< T1, LpCol& > = 0 >
      LpExpr operator<=(T1&& lhs, const LpCol& rhs);

      template < typename T2 >
      LpExpr operator<=(LpExpr&& lhs, T2&& rhs);
      template < typename T2 >
      LpExpr operator<=(LpCol&& lhs, T2&& rhs);
      template < typename T1,
                 forbidden_type< T1, LpExpr > = 0,
                 forbidden_type< T1, LpCol > = 0 >
      LpExpr operator<=(T1&& lhs, LpExpr&& rhs);
      template < typename T1,
                 forbidden_type< T1, LpExpr > = 0,
                 forbidden_type< T1, LpCol > = 0 >
      LpExpr operator<=(T1&& lhs, LpCol&& rhs);


    }   // end of namespace lp

  }   // namespace credal

}   // end of namespace gum

#include <agrum/CN/LpInterface_tpl.h>

#ifndef GUM_NO_INLINE
#  include <agrum/CN/LpInterface_inl.h>
#endif /* GUM_NO_INLINE */

#endif