binTreeNode.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_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/base/core/binTreeNode_tpl.h>
 
#endif   // GUM_BIN_TREE_NODE_H