splay.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_SPLAY_H
#define GUM_SPLAY_H
 
#include <iostream>
// #include <stdlib.h>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/hashTable.h>
 
namespace gum {
 
  template < class Element >
  class SplayBinaryNode;
  template < class Element >
  class SplayTree;

 
  template < typename Element >
  INLINE std::ostream& operator<<(std::ostream& out, const SplayBinaryNode< Element >& e);

 
  template < typename Element >
  INLINE std::ostream& operator<<(std::ostream& out, const SplayTree< Element >& s);
 
  // =========================================================================
  // ===                                   NODE                            ===
  // =========================================================================
  template < class Element >
  class SplayBinaryNode {
    public:
    // ============================================================================
    // ============================================================================

    int position() const;

    const Element& getElement() const;

    const SplayBinaryNode< Element >* getFg() const;

    const SplayBinaryNode< Element >* getFd() const;

 
    protected:
    // ============================================================================
    // ============================================================================

    SplayBinaryNode(const Element&                                     e,
                    HashTable< Element, SplayBinaryNode< Element >* >& addr,
                    SplayBinaryNode*                                   g = 0,
                    SplayBinaryNode*                                   d = 0,
                    SplayBinaryNode*                                   p = 0);

    SplayBinaryNode(const SplayBinaryNode< Element >&                  from,
                    HashTable< Element, SplayBinaryNode< Element >* >& addr);

    void copy_(const SplayBinaryNode< Element >&                  from,
               HashTable< Element, SplayBinaryNode< Element >* >& addr);

    ~SplayBinaryNode();

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

    SplayBinaryNode< Element >* zig();

    SplayBinaryNode< Element >* zag();

    SplayBinaryNode< Element >* splay();

    SplayBinaryNode< Element >* join(const SplayBinaryNode< Element >*                  e,
                                     HashTable< Element, SplayBinaryNode< Element >* >& addr);

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

    Element elt;

    Size size;

    SplayBinaryNode* fg;

    SplayBinaryNode* fd;

    SplayBinaryNode* pere;


    friend class SplayTree< Element >;

    friend std::ostream& operator<< <>(std::ostream& out, const SplayBinaryNode< Element >&);
  };
 
  // ============================================================================
  // ===                                SPLAY TREE ===
  // ============================================================================
  template < class Element >
  class SplayTree {
    public:
    // ============================================================================
    // ============================================================================

    SplayTree();

    SplayTree(const Element& e);

    SplayTree(const SplayTree& from);

    ~SplayTree();

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

    SplayTree< Element >& operator=(const SplayTree< Element >& from);

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

    Element& operator[](const unsigned int i);

    const Element& operator[](const unsigned int i) const;
 

    Element& front();

    Element& back();

    void popFront();

    void popBack();

    void pushFront(const Element& e);

    void pushBack(const Element& e);

    void insert(const Element& e);

    void join(const SplayTree< Element >& s);
 

    SplayTree< Element > split(const int i);
 

    SplayTree< Element > split_by_val(const Element& e);

    Size size() const;

    bool contains(const Element& e) const;

 
    protected:
    // ============================================================================
    // ============================================================================

    SplayBinaryNode< Element >* root;

    HashTable< Element, SplayBinaryNode< Element >* > addr;


    void copy_(const SplayTree< Element >&);

    friend std::ostream& operator<< <>(std::ostream& out, const SplayTree< Element >&);
  };
 
} /* namespace gum */
 
// always include the tpl_.h as it contains only templates
#include <agrum/base/core/splay_tpl.h>
 
#endif /* GUM_SPLAY_H */