variableNodeMap.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}@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_VARIABLE_NODE_MAP_H
#define GUM_VARIABLE_NODE_MAP_H

#include <iostream>
#include <string>

#include <agrum/agrum.h>

#include <agrum/core/bijection.h>
#include <agrum/graphs/graphElements.h>
#include <agrum/variables/discreteVariable.h>

namespace gum {

  class VariableNodeMap {
    public:


    VariableNodeMap();

    VariableNodeMap(const VariableNodeMap& source);

    ~VariableNodeMap();

    VariableNodeMap& operator=(const VariableNodeMap& source);


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


    const DiscreteVariable& get(NodeId id) const;


    NodeId get(const DiscreteVariable& var) const;

    bool exists(NodeId id) const;

    bool exists(const DiscreteVariable& var) const;


    NodeId insert(NodeId id, const DiscreteVariable& var);


    void erase(NodeId id);


    void erase(const DiscreteVariable& var);


    void changeName(NodeId id, const std::string& new_name);

    void clear();

    const std::string toString() const;

    const std::string& name(NodeId id) const;

    const std::string& name(const DiscreteVariable& var) const;


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


    const DiscreteVariable& operator[](NodeId id) const;


    NodeId operator[](const DiscreteVariable& var) const;


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

    NodeId                  idFromName(const std::string& name) const;
    const DiscreteVariable& variableFromName(const std::string& name) const;


    private:
    void __copy(const VariableNodeMap& source);

    Bijection< NodeId, const DiscreteVariable* > __nodes2vars;

    Bijection< std::string, NodeId > __names2nodes;
  };


  std::ostream& operator<<(std::ostream&, const VariableNodeMap&);

} /* namespace gum */

#ifndef GUM_NO_INLINE
#  include <agrum/graphicalModels/variableNodeMap_inl.h>
#endif /* GUM_NO_INLINE */

#endif /* GUM_VARIABLE_NODE_MAP_H*/