partialInstantiationRegister4MultiDim.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_PARTIAL_INSTANTIATION_REGISTER_4_MULTI_DIM_H
#define GUM_PARTIAL_INSTANTIATION_REGISTER_4_MULTI_DIM_H

#include <agrum/core/hashTable.h>
#include <agrum/core/set.h>
#include <agrum/variables/discreteVariable.h>
#include <iostream>
#include <string>
#include <utility>

namespace gum {

  // the base object used by the partial instantiations
  template < typename GUM_SCALAR >
  class MultiDimImplementation;

  // ==========================================================================
  // ===            GUM_MULTI_DIM_PARTIAL_INSTANTIATION_REGISTER            ===
  // ==========================================================================
  template < typename GUM_SCALAR >
  class PartialInstantiationRegister4MultiDim {
    public:
    typedef MultiDimImplementation< GUM_SCALAR >* (*PartialInstantiationPtr)(
       const MultiDimImplementation< GUM_SCALAR >*,
       const HashTable< const DiscreteVariable*, Idx >&);

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


    void insert(const std::string&      instantiation_func_name,
                const std::string&      type_multidim,
                PartialInstantiationPtr newFunction);

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

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

    PartialInstantiationPtr get(const std::string& instantiation_func_name,
                                const std::string& type_multidim) const;

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

    static PartialInstantiationRegister4MultiDim& Register();


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

    PartialInstantiationRegister4MultiDim();

    PartialInstantiationRegister4MultiDim(
       const PartialInstantiationRegister4MultiDim&);

    ~PartialInstantiationRegister4MultiDim();


    typedef HashTable< std::string, PartialInstantiationPtr >
       PartialInstantiationSet;

    HashTable< std::string, PartialInstantiationSet* > __set;
  };

  template < typename GUM_SCALAR >
  void registerPartialInstantiation(
     const std::string& instantiation_func_name,
     const std::string& type_multidim,
     typename PartialInstantiationRegister4MultiDim<
        GUM_SCALAR >::PartialInstantiationPtr function);

} /* namespace gum */

// always include the implementations
#include <agrum/multidim/utils/partialInstantiationRegister4MultiDim_tpl.h>

#endif /* GUM_PARTIAL_INSTANTIATION_REGISTER_MULTI_DIM_H */