partialInstantiation4MultiDim_tpl.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 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-2026                            *
 *       - 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                           *
 *                                                                          *
 ****************************************************************************/
 
#pragma once
 

 
#include <agrum/base/multidim/utils/partialInstantiation4MultiDim.h>   // to ease IDE parser
// allow partialInstantiationPatterns to be used
#define GUM_PARTIAL_INSTANTIATION_PATTERN_ALLOWED 1
 
#include <agrum/base/multidim/utils/partialInstantiationRegister4MultiDim.h>
 
#define GUM_MULTI_DIM_DECORATOR_PARTIAL_INST(NAME)                         \
  namespace gum {                                                          \
    template < typename GUM_ELEMENT >                                      \
    MultiDimImplementation< GUM_ELEMENT >*                                 \
        NAME(const MultiDimDecorator< GUM_ELEMENT >&          table,       \
             const HashTable< const DiscreteVariable*, Idx >& inst_vars) { \
      const MultiDimImplementation< GUM_ELEMENT >* impl = table.content(); \
      return NAME(*impl, inst_vars);                                       \
    }                                                                      \
  }

 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME partialInstantiationMultiDimArray
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4MultiDimArray.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME
 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_IMPL2ARRAY_NAME partialInstantiationMultiDimArray
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4MultiDimArray.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_IMPL2ARRAY_NAME
 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_POINTER_NAME partialInstantiationMultiDimArray4Pointers
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4MultiDimArray.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_POINTER_NAME
 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_POINTER_IMPL2ARRAY_NAME \
  partialInstantiationMultiDimArray4Pointers
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4MultiDimArray.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_POINTER_IMPL2ARRAY_NAME

 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME partialInstantiationMultiDimImplementation
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4BaseName.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME
 
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_POINTER_NAME \
  partialInstantiationMultiDimImplementation4Pointers
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4BaseName.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME
 
// the operators that should be used to select appropriately the functions
// to partially instantiate multiDims

#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME partialInstantiation
#include <agrum/base/multidim/utils/patterns/partialInstantiationPattern4MultiDimImplementation.h>
#undef GUM_MULTI_DIM_PARTIAL_INSTANTIATION_NAME

GUM_MULTI_DIM_DECORATOR_PARTIAL_INST(partialInstantiation)
 
//
// DO NOT FORGET TO REGISTER YOUR BINARY FUNCTIONS
//
 
namespace gum {
 
  // the function used to register all the above functions
  template < typename GUM_ELEMENT >
  void partialInstantiation4MultiDimInit() {
    // ensure that only one thread will register the projections
    static std::once_flag first;
    std::call_once(first, []() {
      std::string MultiDimArrayString("MultiDimArray");
      std::string MultiDimDecisionDiagramString("MultiDimDecisionDiagram");
      std::string BaseNameString("MultiDimImplementation");
 
      // register base functions for multiDimArrays
      registerPartialInstantiation< GUM_ELEMENT >("i",
                                                  MultiDimArrayString,
                                                  &partialInstantiationMultiDimArray);
 
      // register default basename functions
      registerPartialInstantiation< GUM_ELEMENT >("i",
                                                  BaseNameString,
                                                  &partialInstantiationMultiDimImplementation);
    });
  }
 
  // the function used to register all the above functions
  template < typename GUM_ELEMENT >
  void pointerPartialInstantiation4MultiDimInit() {
    // ensure that only one thread will register the projections
    static std::once_flag first;
    std::call_once(first, []() {
      std::string MultiDimArrayString("MultiDimArray");
      std::string BaseNameString("MultiDimImplementation");
 
      // register base functions for multiDimArrays
      registerPartialInstantiation< GUM_ELEMENT* >("i",
                                                   MultiDimArrayString,
                                                   &partialInstantiationMultiDimArray4Pointers);
 
      // register default basename functions
      registerPartialInstantiation< GUM_ELEMENT* >(
          "i",
          BaseNameString,
          &partialInstantiationMultiDimImplementation4Pointers);
    });
  }
 
  template < typename GUM_ELEMENT >
  void PartialInstantiation4MultiDimInitialize< GUM_ELEMENT >::init() {
    partialInstantiation4MultiDimInit< GUM_ELEMENT >();
  }
 
  template < typename GUM_ELEMENT >
  void PartialInstantiation4MultiDimInitialize< GUM_ELEMENT* >::init() {
    pointerPartialInstantiation4MultiDimInit< GUM_ELEMENT >();
  }
 
} /* namespace gum */
 
// remove permission to use operatorsPatterns
#undef GUM_PARTIAL_INSTANTIATION_PATTERN_ALLOWED