binTreeNode.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_BIN_TREE_NODE_H
#define GUM_BIN_TREE_NODE_H

#include <agrum/agrum.h>

namespace gum {

  enum class BinTreeDir : char { LEFT_CHILD = 0, RIGHT_CHILD = 1, NO_PARENT = 2 };

  // ===========================================================================
  // ===                   GENERIC NODE FOR A BINARY TREE                    ===
  // ===========================================================================

  template < typename Val >
  class BinTreeNode {
    public:
    // ============================================================================
    // ============================================================================

    BinTreeNode(const Val& v);

    BinTreeNode(const BinTreeNode< Val >& from);

    ~BinTreeNode();

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

    BinTreeNode< Val >& operator=(const BinTreeNode< Val >& from);

    Val& operator*();

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

    Val& value();

    BinTreeNode< Val >* child(BinTreeDir dir) const;

    BinTreeNode< Val >* leftChild() const;

    BinTreeNode< Val >* rightChild() const;

    BinTreeNode< Val >* parent() const;

    BinTreeDir parentDir() const;

    BinTreeNode< Val >* insertLeftChild(const Val& val);

    void insertLeftChild(BinTreeNode< Val >& new_child);

    BinTreeNode< Val >* insertRightChild(const Val& val);

    void insertRightChild(BinTreeNode< Val >& new_child);

    BinTreeNode< Val >* insertChild(const Val& val, BinTreeDir child_dir);

    void insertChild(BinTreeNode< Val >& new_child, BinTreeDir child_dir);

    void eraseLeftLink();

    void eraseRightLink();

    void eraseLink(BinTreeDir tree_dir);

    BinTreeNode< Val >* leftmostNode() const;

    BinTreeNode< Val >* rightmostNode() const;

    BinTreeNode< Val >* root() const;


    protected:
    Val _val;

    BinTreeNode< Val >* _parent;

    BinTreeDir _parent_dir;

    BinTreeNode< Val >* _children[2];
  };

} /* namespace gum */


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::BinTreeNode< int >;
#endif


// always include the implementation of the templates
#include <agrum/core/binTreeNode_tpl.h>

#endif   // GUM_BIN_TREE_NODE_H