operatorRegister4MultiDim.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_OPERATOR_REGISTER_4_MULTI_DIM_H
#define GUM_OPERATOR_REGISTER_4_MULTI_DIM_H

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

namespace gum {

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

  // ===========================================================================
  // ===                   GUM_MULTI_DIM_OPERATOR_REGISTER                   ===
  // ===========================================================================
  // clang-format off
  // clang-format on
  template < typename GUM_SCALAR >
  class OperatorRegister4MultiDim {
    public:
    typedef MultiDimImplementation< GUM_SCALAR >* (*OperatorPtr)(
       const MultiDimImplementation< GUM_SCALAR >*,
       const MultiDimImplementation< GUM_SCALAR >*);

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

    void insert(const std::string& operation_name,
                const std::string& type1,
                const std::string& type2,
                OperatorPtr        newFunction);

    void erase(const std::string& operation_name,
               const std::string& type1,
               const std::string& type2);

    bool exists(const std::string& operation_name,
                const std::string& type1,
                const std::string& type2) const;

    OperatorPtr get(const std::string& operation_name,
                    const std::string& type1,
                    const std::string& type2) const;

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

    static OperatorRegister4MultiDim< GUM_SCALAR >& Register();


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

    OperatorRegister4MultiDim();

    OperatorRegister4MultiDim(const OperatorRegister4MultiDim< GUM_SCALAR >&);

    ~OperatorRegister4MultiDim();


    typedef HashTable< std::pair< std::string, std::string >, OperatorPtr >
       OperatorSet;

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

  template < typename GUM_SCALAR >
  void registerOperator(
     const std::string&                                            operation_name,
     const std::string&                                            type1,
     const std::string&                                            type2,
     typename OperatorRegister4MultiDim< GUM_SCALAR >::OperatorPtr function);

} /* namespace gum */

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

#endif /* GUM_OPERATOR_REGISTER_MULTI_DIM_H */