multiDimPartialInstantiation.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_MULTI_DIM_PARTIAL_INSTANTIATION_H
#define GUM_MULTI_DIM_PARTIAL_INSTANTIATION_H

#include <agrum/core/set.h>
#include <agrum/multidim/implementations/multiDimDecorator.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/multidim/utils/partialInstantiationRegister4MultiDim.h>
#include <agrum/variables/discreteVariable.h>
#include <utility>

namespace gum {

  template < typename GUM_SCALAR, template < typename > class TABLE >
  class MultiDimPartialInstantiation {
    public:
    // =========================================================================
    // =========================================================================

    MultiDimPartialInstantiation();

    MultiDimPartialInstantiation(
       const MultiDimPartialInstantiation< GUM_SCALAR, TABLE >& src);

    virtual ~MultiDimPartialInstantiation();

    MultiDimPartialInstantiation< GUM_SCALAR, TABLE >&
       operator=(const MultiDimPartialInstantiation< GUM_SCALAR, TABLE >& src);

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

    virtual MultiDimPartialInstantiation< GUM_SCALAR, TABLE >* newFactory() const;

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

    TABLE< GUM_SCALAR >*
       instantiate(const TABLE< GUM_SCALAR >&                       table,
                   const HashTable< const DiscreteVariable*, Idx >& inst_vars);

    void instantiate(TABLE< GUM_SCALAR >&                             container,
                     const TABLE< GUM_SCALAR >&                       table,
                     const HashTable< const DiscreteVariable*, Idx >& inst_vars);

  };

} /* namespace gum */

// always include the template implementation
#include <agrum/multidim/implementations/multiDimPartialInstantiation_tpl.h>

#endif /* GUM_MULTI_DIM_PARTIAL_INSTANTIATION_H */