splay.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_SPLAY_H
#define GUM_SPLAY_H

#include <iostream>
//#include <stdlib.h>

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

#endif /* GUM_SPLAY_H */