nodeGraphPart.cpp

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                           *
 *                                                                          *
 ****************************************************************************/
 

#include <agrum/base/graphs/parts/nodeGraphPart.h>
 
#ifdef GUM_NO_INLINE
#  include <agrum/base/graphs/parts/nodeGraphPart_inl.h>
#endif   // GU%_NO_INLINE
 
namespace gum {

  NodeGraphPart::NodeGraphPart(Size holes_size, bool holes_resize_policy) :
      _holes_size_(holes_size), _holes_resize_policy_(holes_resize_policy),
      _endIteratorSafe_(*this), _boundVal_(0) {
    _holes_ = nullptr;
    GUM_CONSTRUCTOR(NodeGraphPart);
    _updateEndIteratorSafe_();
  }
 
  NodeGraphPart::NodeGraphPart(const NodeGraphPart& s) :
      _holes_size_(s._holes_size_), _holes_resize_policy_(s._holes_resize_policy_),
      _endIteratorSafe_(*this), _boundVal_(s._boundVal_) {
    _holes_ = nullptr;
 
    if (s._holes_) _holes_ = new NodeSet(*s._holes_);
 
    _names_ = s._cloneNames_();
 
    _updateEndIteratorSafe_();
 
    GUM_CONS_CPY(NodeGraphPart);
  }
 
  NodeGraphPart::NodeGraphPart(NodeGraphPart&& s) :
      _holes_(s._holes_), _names_(std::move(s._names_)), _holes_size_(s._holes_size_),
      _holes_resize_policy_(s._holes_resize_policy_), _endIteratorSafe_(*this),
      _boundVal_(s._boundVal_) {
    s._holes_    = nullptr;
    s._boundVal_ = 0;
 
    _updateEndIteratorSafe_();
 
    GUM_CONS_MOV(NodeGraphPart);
  }
 
  NodeGraphPart::~NodeGraphPart() {
    if (_holes_) delete _holes_;
 
    GUM_DESTRUCTOR(NodeGraphPart);
  }
 
  void NodeGraphPart::populateNodes(const NodeGraphPart& s) {
    clear();   // "virtual" flush of the nodes set
    _holes_size_          = s._holes_size_;
    _holes_resize_policy_ = s._holes_resize_policy_;
 
    if (s._holes_) _holes_ = new NodeSet(*s._holes_);
 
    _names_ = s._cloneNames_();
 
    _boundVal_ = s._boundVal_;
 
    _updateEndIteratorSafe_();
  }
 
  // id is assumed to belong to NodeGraphPart
  void NodeGraphPart::_addHole_(NodeId node) {
    // we assume that the node exists
    if (node + 1 == _boundVal_) {
      // we remove the max : no new hole and maybe a bunch of holes to remove
      --_boundVal_;
 
      if (_holes_) {
        while (_holes_->contains(_boundVal_ - 1)) {
          // a bunch of holes to remove. We do not use inHoles for optimisation
          // :
          // not to repeat the test if ( _holes_) each time
          _holes_->erase(--_boundVal_);
        }
 
        if (_holes_->empty()) {
          delete _holes_;
          _holes_ = nullptr;
        }
      }
 
      _updateEndIteratorSafe_();
    } else {
      if (!_holes_) _holes_ = new NodeSet(_holes_size_, _holes_resize_policy_);
 
      _holes_->insert(node);
    }
  }
 
  std::string NodeGraphPart::toString() const {
    std::string s     = "{";
    bool        first = true;
 
    const bool hasNames = (_names_ != nullptr);
    for (NodeId id = 0; id < _boundVal_; ++id) {
      if (_inHoles_(id)) continue;
 
      if (!first) s += ",";
      first = false;
 
      if (hasNames && _names_->existsFirst(id)) s += std::format("{}<{}>", id, _names_->second(id));
      else s += std::format("{}", id);
    }
 
    s += "}";
 
    return s;
  }
 
  std::string NodeGraphPart::nameFromId(NodeId id) const {
    if (_names_ && _names_->existsFirst(id)) return _names_->second(id);
    return std::to_string(id);
  }
 
  std::optional< NodeId > NodeGraphPart::idFromName(const std::string& name) const {
    if (_names_ && _names_->existsSecond(name)) return _names_->first(name);
    return std::nullopt;
  }
 
  void NodeGraphPart::setName(NodeId id, const std::string& name) {
    if (!existsNode(id)) GUM_ERROR(InvalidNode, "node " << id << " does not exist")
    if (_names_) {
      auto owner = _names_->tryFirst(name);
      if (owner.has_value()) {
        if (*owner != id)
          GUM_ERROR(DuplicateElement, "name '" << name << "' already used by node " << *owner)
        return;
      }
      if (_names_->existsFirst(id)) _names_->eraseFirst(id);
    } else {
      _names_ = std::make_unique< Bijection< NodeId, std::string > >();
    }
    _names_->insert(id, name);
  }
 
  bool NodeGraphPart::hasName(NodeId id) const { return _names_ && _names_->existsFirst(id); }
 
  std::string NodeGraphPart::dotNodeLabel(NodeId id) const {
    if (!hasName(id)) return "";
    const std::string& name = _names_->second(id);
    std::string        result;
    result.reserve(name.size() * 2 + 24);
    result = " [label=\"(";
    result += std::to_string(id);
    result += ") ";
    for (const char c: name) {
      switch (c) {
        case '"' : result += "\\\""; break;
        case '\\' : result += "\\\\"; break;
        case '\n' : result += "\\n"; break;
        case '\r' : result += "\\r"; break;
        default : result += c;
      }
    }
    result += "\"]";
    return result;
  }
 
  std::ostream& operator<<(std::ostream& stream, const NodeGraphPart& set) {
    stream << set.toString();
    return stream;
  }
 
  void NodeGraphPart::addNodeWithId(const NodeId id) {
    if (id >= _boundVal_) {
      if (id > _boundVal_) {   // we have to add holes
        if (!_holes_) _holes_ = new NodeSet(_holes_size_, _holes_resize_policy_);
 
        for (NodeId i = _boundVal_; i < id; ++i)
          _holes_->insert(i);
      }
 
      _boundVal_ = id + 1;
 
      _updateEndIteratorSafe_();
    } else {
      if (_inHoles_(id)) {   // we fill a hole
        _eraseHole_(id);
      } else {
        GUM_ERROR(DuplicateElement, "Id " << id << " is already used")
      }
    }
 
    GUM_EMIT1(onNodeAdded, id);
  }
 
  void NodeGraphPart::_clearNodes_() {
    NodeId bound = _boundVal_;
    _boundVal_   = 0;
 
    if (onNodeDeleted.hasListener()) {
      for (NodeId n = 0; n < bound; ++n) {
        if (!_inHoles_(n)) GUM_EMIT1(onNodeDeleted, n);
      }
    }
 
    _updateEndIteratorSafe_();
 
    delete (_holes_);
    _holes_ = nullptr;
    _names_.reset();
  }
 
  void NodeGraphPartIteratorSafe::whenNodeDeleted(const void* src, NodeId id) {
    if (id == pos_) {   // we just deleted the pos_ in NodeGraphPart
      valid_ = false;
    }
 
    if (pos_ >= nodes_->bound()) {   // moreover, it was the last position
      pos_   = nodes_->bound();
      valid_ = false;
    }
  }
 
} /* namespace gum */