multiDimProjection.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_PROJECTION_H
#define GUM_MULTI_DIM_PROJECTION_H
 
#include <utility>
 
#include <agrum/base/graphicalModels/inference/scheduler/schedule.h>
 
namespace gum {
 
  // clang-format off
  // clang-format on
 
  template < class TABLE >
  class MultiDimProjection final {
#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;
 
    // ========================================================================
    // ========================================================================

    MultiDimProjection(TABLE (*proj)(const TABLE&, const gum::VariableSet&));

    MultiDimProjection(const MultiDimProjection< TABLE >&);

    virtual ~MultiDimProjection();

    virtual MultiDimProjection< TABLE >* clone() const;

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

    TABLE* execute(const TABLE& table, const gum::VariableSet& del_vars) const;
    void   execute(TABLE& container, const TABLE& table, const gum::VariableSet& del_vars) const;


    std::pair< ScheduleOperator*, const IScheduleMultiDim* >
        operations(const IScheduleMultiDim* table,
                   const gum::VariableSet&  del_vars,
                   const bool               is_result_persistent = false) const;


    const IScheduleMultiDim* schedule(Schedule&                schedule,
                                      const IScheduleMultiDim* table,
                                      const gum::VariableSet&  del_vars,
                                      const bool               is_result_persistent = false) const;

    void setProjectionFunction(TABLE (*proj)(const TABLE&, const gum::VariableSet&));

    TABLE (*projectionFunction())(const TABLE&, const gum::VariableSet&);

    double nbOperations(const TABLE& table, const gum::VariableSet& del_vars) const;

    double nbOperations(const Sequence< const DiscreteVariable* >& vars,
                        const gum::VariableSet&                    del_vars) const;

    std::pair< double, double > memoryUsage(const TABLE&            table,
                                            const gum::VariableSet& del_vars) const;

    std::pair< double, double > memoryUsage(const Sequence< const DiscreteVariable* >& vars,
                                            const gum::VariableSet& del_vars) const;

 
    protected:
    TABLE (*proj_)(const TABLE&, const gum::VariableSet&);
 
    private:
    MultiDimProjection< TABLE >& operator=(const MultiDimProjection< TABLE >&);
  };
 
} /* namespace gum */
 
// always include the template implementation
#include <agrum/base/multidim/utils/operators/multiDimProjection_tpl.h>
 
#endif /* GUM_MULTI_DIM_PROJECTION_H */