indexedTree.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {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_INDEXED_TREE_H
#define GUM_INDEXED_TREE_H

#include <iostream>

#include <agrum/agrum.h>
#include <agrum/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/core/indexedTree_tpl.h>

#endif /* GUM_INDEXED_TREE_H */