indexedTree.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_INDEXED_TREE_H
#define GUM_INDEXED_TREE_H
 
#include <iostream>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/hashTable.h>
 
namespace gum {
 
  // =========================================================================
  // ===                NODES FOR GENERIC TREE (DATA) STRUCTURE === */
  // =========================================================================

  template < typename Key, typename Data >
  class IndexedTree {
    public:
    // ============================================================================
    // ============================================================================

    IndexedTree(Data* data = nullptr);

    IndexedTree(const Key& theKey, Data* data = nullptr);

    IndexedTree(const Key& theKey, const Data& data);

    IndexedTree(const IndexedTree< Key, Data >& from);

    IndexedTree< Key, Data >& operator=(const IndexedTree< Key, Data >& from);

    ~IndexedTree();

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

    void insertNode(const std::vector< Key >& index, const Data* data);

    void insertNode(const std::vector< Key >& index, const Data& data);

    void setNode(const std::vector< Key >& index, Data* data);

    void setNode(const std::vector< Key >& index, const Data& data);

    Data& getData(const std::vector< Key >& index) const;

    IndexedTree< Key, Data >& getNode(const std::vector< Key >& index) const;

 
    private:
    Key key;

    Data* data;

    IndexedTree< Key, Data >* parent;

    HashTable< Key, IndexedTree< Key, Data >* > children;
  };

  template < typename Key, typename Data >
  std::ostream& operator<<(std::ostream&, const IndexedTree< Key, Data >&);
 
} /* namespace gum */
 
// always include the templated implementations
#include <agrum/base/core/indexedTree_tpl.h>
 
#endif /* GUM_INDEXED_TREE_H */