LpInterface.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2025                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 
 
#ifndef __LP_INTERFACE__H__
#define __LP_INTERFACE__H__

 
#include <iostream>
#include <sstream>
#include <string>
 
#include <agrum/base/core/hashTable.h>
#include <agrum/CN/polytope/LrsWrapper.h>
 
#include <agrum/base/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_;


        void _addSide_(const LpCol& from);

        void _addSide_(const LpExpr& from);

        void _addSide_(LpExpr&& from);

        template < typename SCALAR >
        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

      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/polytope/LpInterface_tpl.h>
 
#ifndef GUM_NO_INLINE
#  include <agrum/CN/polytope/LpInterface_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif