partialInstantiation4MultiDim.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_PARTIAL_INSTANTIATION_4_MULTI_DIM_H
#define GUM_PARTIAL_INSTANTIATION_4_MULTI_DIM_H
 
#include <atomic>
#include <mutex>
 
#include <agrum/base/variables/discreteVariable.h>
 
// #include <agrum/base/multidim/implementations/multiDimImplementation.h>
// #include <agrum/base/multidim/implementations/multiDimArray.h>
// #include <agrum/base/multidim/implementations/multiDimDecorator.h>
 
namespace gum {
 
  template < typename GUM_SCALAR >
  class MultiDimImplementation;
 
  template < typename GUM_SCALAR >
  class MultiDimArray;
 
  template < typename GUM_SCALAR >
  class MultiDimDecorator;

  template < typename GUM_SCALAR >
  MultiDimArray< GUM_SCALAR >*
      partialInstantiationMultiDimArray(const MultiDimArray< GUM_SCALAR >*               table,
                                        const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  template < typename GUM_SCALAR >
  MultiDimImplementation< GUM_SCALAR >*
      partialInstantiationMultiDimArray(const MultiDimImplementation< GUM_SCALAR >*      table,
                                        const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  template < typename GUM_SCALAR >
  MultiDimArray< GUM_SCALAR* >* partialInstantiationMultiDimArray4Pointers(
      const MultiDimArray< GUM_SCALAR* >*              table,
      const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  template < typename GUM_SCALAR >
  MultiDimImplementation< GUM_SCALAR* >* partialInstantiationMultiDimArray4Pointers(
      const MultiDimImplementation< GUM_SCALAR* >*     table,
      const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  template < typename GUM_SCALAR >
  MultiDimImplementation< GUM_SCALAR >*
      partialInstantiation(const MultiDimImplementation< GUM_SCALAR >&      table,
                           const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  template < typename GUM_SCALAR >
  MultiDimImplementation< GUM_SCALAR >*
      partialInstantiation(const MultiDimDecorator< GUM_SCALAR >&           table,
                           const HashTable< const DiscreteVariable*, Idx >& inst_vars);
 
  // ==========================================================================
  // DO NOT FORGET TO REGISTER YOUR PARTIAL INSTANTIATION FUNCTIONS AT THE END
  // OF FILE partialInstantiation4MultiDim_tpl.h
  // ==========================================================================

  template < typename GUM_SCALAR >
  void partialInstantiation4MultiDimInit();

  template < typename GUM_SCALAR >
  void pointerPartialInstantiation4MultiDimInit();

  template < typename GUM_SCALAR >
  struct PartialInstantiation4MultiDimInitialize {
    void init() { partialInstantiation4MultiDimInit< GUM_SCALAR >(); };
  };

  template < typename GUM_SCALAR >
  struct PartialInstantiation4MultiDimInitialize< GUM_SCALAR* > {
    void init() { pointerPartialInstantiation4MultiDimInit< GUM_SCALAR >(); };
  };
 
} /* namespace gum */
 
// always include the templatized implementations
#include <agrum/base/multidim/utils/partialInstantiation4MultiDim_tpl.h>
 
#endif /* GUM_PARTIAL_INSTANTIATION_4_MULTI_DIM_H */