scheduleMultiDim.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_SCHEDULE_MULTI_DIM_H
#define GUM_SCHEDULE_MULTI_DIM_H

#include <string>

#include <agrum/agrum.h>

#include <agrum/core/hashTable.h>
#include <agrum/core/sequence.h>
#include <agrum/multidim/implementations/multiDimDecorator.h>
#include <agrum/multidim/implementations/multiDimImplementation.h>
#include <agrum/variables/discreteVariable.h>

namespace gum {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
  // we should grant ScheduleDeleteMultiDim the access to the hashtable actually
  // containing the MultiDimImplementation: thus, when ScheduleDeleteMultiDim
  // deletes an implementation, it can remove it from the hashtable and, thus,
  // the ScheduleMultiDims pointing to it will become abstract.
  template < typename GUM_SCALAR >
  class ScheduleDeleteMultiDim;
#endif

  template < typename GUM_SCALAR >
  class ScheduleMultiDim {
    public:
    // ############################################################################
    // ############################################################################

    explicit ScheduleMultiDim(const MultiDimImplementation< GUM_SCALAR >&);

    explicit ScheduleMultiDim(const MultiDimDecorator< GUM_SCALAR >&);


    explicit ScheduleMultiDim(const Sequence< const DiscreteVariable* >& vars);

    ScheduleMultiDim(const ScheduleMultiDim< GUM_SCALAR >&);

    ~ScheduleMultiDim();


    // ############################################################################
    // ############################################################################


    ScheduleMultiDim< GUM_SCALAR >&
       operator=(const ScheduleMultiDim< GUM_SCALAR >&);

    bool operator==(const ScheduleMultiDim< GUM_SCALAR >&) const;

    bool operator!=(const ScheduleMultiDim< GUM_SCALAR >&) const;


    // ############################################################################
    // ############################################################################


    bool isAbstract() const;

    const MultiDimImplementation< GUM_SCALAR >& multiDim() const;

    Idx id() const;

    const Sequence< const DiscreteVariable* >& variablesSequence() const;

    Size domainSize() const;


    void setMultiDim(const MultiDimImplementation< GUM_SCALAR >&);


    void setMultiDim(const MultiDimDecorator< GUM_SCALAR >&);

    std::string toString() const;


    private:
    friend class ScheduleDeleteMultiDim< GUM_SCALAR >;

    Idx __id;

    static Idx __newId();

    static HashTable< Idx, const MultiDimImplementation< GUM_SCALAR >* >&
       __id2multidim();


    static HashTable< const MultiDimImplementation< GUM_SCALAR >*, Idx >&
       __multidim2id();

    static HashTable< Idx, Idx >& __id2refs();

    static HashTable< Idx, const Sequence< const DiscreteVariable* >* >&
       __id2vars();

    static HashTable< Idx, Size >& __id2size();
  };

} /* namespace gum */

// always include the template implementation
#include <agrum/graphicalModels/inference/scheduleMultiDim_tpl.h>

#endif /* GUM_SCHEDULE_MULTI_DIM_H */