multiDimCombination.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 GUM_MULTI_DIM_COMBINATION_H
#define GUM_MULTI_DIM_COMBINATION_H
 
#include <utility>
#include <vector>
 
#include <agrum/agrum.h>
 
#include <agrum/base/graphicalModels/inference/scheduler/schedule.h>
 
namespace gum {

  template < class TABLE >
  class MultiDimCombination {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    // class to get the types of the TABLE's values using metaprogramming
    template < typename T >
    struct TableType {
      using value_type = T;
    };
 
    template < template < typename, typename... > class CONTAINER, typename T, typename... Args >
    struct TableType< CONTAINER< T, Args... > > {
      using value_type = T;
    };
#endif   // DOXYGEN_SHOULD_SKIP_THIS
 
    public:
    using value_type = typename TableType< TABLE >::value_type;
 
    // =========================================================================
    // =========================================================================

    MultiDimCombination();

    MultiDimCombination(const MultiDimCombination< TABLE >&);

    virtual ~MultiDimCombination();

    virtual MultiDimCombination< TABLE >* clone() const = 0;

    // =========================================================================
    // =========================================================================

    virtual TABLE* execute(const Set< const TABLE* >& set) const                   = 0;
    virtual void   execute(TABLE& container, const Set< const TABLE* >& set) const = 0;


    virtual std::pair< std::vector< ScheduleOperator* >, const IScheduleMultiDim* >
        operations(const std::vector< const IScheduleMultiDim* >& set,
                   const bool is_result_persistent = false) const
        = 0;
    virtual std::pair< std::vector< ScheduleOperator* >, const IScheduleMultiDim* >
        operations(const Set< const IScheduleMultiDim* >& set,
                   const bool                             is_result_persistent = false) const
        = 0;


    const IScheduleMultiDim* schedule(Schedule&                              schedule,
                                      const Set< const IScheduleMultiDim* >& set,
                                      const bool is_result_persistent = false) const;
    const IScheduleMultiDim* schedule(Schedule&                                      schedule,
                                      const std::vector< const IScheduleMultiDim* >& set,
                                      const bool is_result_persistent = false) const;

    virtual void setCombinationFunction(TABLE (*combine)(const TABLE&, const TABLE&)) = 0;

    virtual TABLE (*combinationFunction())(const TABLE&, const TABLE&) = 0;

    virtual double nbOperations(const Set< const TABLE* >& set) const = 0;
    virtual double nbOperations(const Set< const Sequence< const DiscreteVariable* >* >& set) const
        = 0;

    virtual std::pair< double, double > memoryUsage(const Set< const TABLE* >& set) const = 0;
    virtual std::pair< double, double >
        memoryUsage(const Set< const Sequence< const DiscreteVariable* >* >& set) const = 0;
 
    private:
    MultiDimCombination< TABLE >& operator=(const MultiDimCombination< TABLE >&);

  };
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/multidim/utils/operators/multiDimCombination_tpl.h>
 
#endif /* GUM_MULTI_DIM_COMBINATION_H */