variableNodeMap.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_VARIABLE_NODE_MAP_H
#define GUM_VARIABLE_NODE_MAP_H
 
#include <iostream>
#include <string>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/bijection.h>
#include <agrum/base/graphs/graphElements.h>
#include <agrum/base/variables/discreteVariable.h>
 
namespace gum {

  class VariableNodeMap {
    public:


    VariableNodeMap();

    VariableNodeMap(const VariableNodeMap& source);

    VariableNodeMap(VariableNodeMap&& source);

    ~VariableNodeMap();

    VariableNodeMap& operator=(const VariableNodeMap& source);

    VariableNodeMap& operator=(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;

    bool exists(std::string_view name) const;


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


    void erase(NodeId id);


    void erase(const DiscreteVariable& var);


    void changeName(NodeId id, std::string_view new_name);

    void clear();

    Size size() 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(std::string_view name) const;
    const DiscreteVariable& variableFromName(std::string_view 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/base/graphicalModels/variableNodeMap_inl.h>
#endif /* GUM_NO_INLINE */
 
#endif /* GUM_VARIABLE_NODE_MAP_H*/