projectionRegister4MultiDim.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_PROJECTION_REGISTER_4_MULTI_DIM_H
#define GUM_PROJECTION_REGISTER_4_MULTI_DIM_H
 
#include <atomic>
#include <iostream>
#include <string>
#include <utility>
 
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {
 
  // the base object used by the projections
  template < typename GUM_SCALAR >
  class MultiDimImplementation;
 
  // ===========================================================================
  // ===                  GUM_MULTI_DIM_PROJECTION_REGISTER                  ===
  // ===========================================================================
  // clang-format off
  // clang-format on
 
  template < typename GUM_SCALAR >
  class ProjectionRegister4MultiDim {
    public:
    using ProjectionPtr
        = MultiDimImplementation< GUM_SCALAR >* (*)(const MultiDimImplementation< GUM_SCALAR >*,
                                                    const gum::VariableSet&);
 
    // ========================================================================
    // ========================================================================

    void insert(const std::string& projection_name,
                const std::string& type_multidim,
                ProjectionPtr      newFunction);

    void erase(const std::string& projection_name, const std::string& type_multidim);

    bool exists(const std::string& projection_name, const std::string& type_multidim) const;

    ProjectionPtr get(const std::string& projection_name, const std::string& type_multidim) const;

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

    static ProjectionRegister4MultiDim& Register();

 
    private:
    // ========================================================================
    // ========================================================================

    ProjectionRegister4MultiDim();

    ProjectionRegister4MultiDim(const ProjectionRegister4MultiDim&);

    ~ProjectionRegister4MultiDim();


    using ProjectionSet = HashTable< std::string, ProjectionPtr >;

    HashTable< std::string, ProjectionSet* > _set_;
  };

  template < typename GUM_SCALAR >
  void registerProjection(
      const std::string&                                                projection_name,
      const std::string&                                                type_multidim,
      typename ProjectionRegister4MultiDim< GUM_SCALAR >::ProjectionPtr function);
 
  // a display operator for ProjectionPtrs
 
} /* namespace gum */
 
// always include the implementations
#include <agrum/base/multidim/utils/operators/projectionRegister4MultiDim_tpl.h>
 
#endif /* GUM_PROJECTION_REGISTER_MULTI_DIM_H */