aapl/avlbasic.h

   1 /*
   2  *  Copyright 2002 Adrian Thurston <thurston@cs.queensu.ca>
   3  */
   4
   5 /*  This file is part of Aapl.
   6  *
   7  *  Aapl is free software; you can redistribute it and/or modify it under the
   8  *  terms of the GNU Lesser General Public License as published by the Free
   9  *  Software Foundation; either version 2.1 of the License, or (at your option)
  10  *  any later version.
  11  *
  12  *  Aapl is distributed in the hope that it will be useful, but WITHOUT ANY
  13  *  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14  *  FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for
  15  *  more details.
  16  *
  17  *  You should have received a copy of the GNU Lesser General Public License
  18  *  along with Aapl; if not, write to the Free Software Foundation, Inc., 59
  19  *  Temple Place, Suite 330, Boston, MA 02111-1307 USA
  20  */
  21
  22 #ifndef _AAPL_AVLBASIC_H
  23 #define _AAPL_AVLBASIC_H
  24
  25 #include "compare.h"
  26
  27 /**
  28  * \addtogroup avltree
  29  * @{
  30  */
  31
  32 /**
  33  * \class AvlBasic
  34  * \brief AVL Tree in which the entire element structure is the key.
  35  *
  36  * AvlBasic is an AVL tree that does not distinguish between the element that
  37  * it contains and the key. The entire element structure is the key that is
  38  * used to compare the relative ordering of elements. This is similar to the
  39  * BstSet structure.
  40  *
  41  * AvlBasic does not assume ownership of elements in the tree. Items must be
  42  * explicitly de-allocated.
  43  */
  44
  45 /*@}*/
  46
  47 #define BASE_EL(name) name
  48 #define BASEKEY(name) name
  49 #define AVLMEL_CLASSDEF class Element, class Compare
  50 #define AVLMEL_TEMPDEF class Element, class Compare
  51 #define AVLMEL_TEMPUSE Element, Compare
  52 #define AvlTree AvlBasic
  53 #define AVL_BASIC
  54
  55 #include "avlcommon.h"
  56
  57 #undef BASE_EL
  58 #undef BASEKEY
  59 #undef AVLMEL_CLASSDEF
  60 #undef AVLMEL_TEMPDEF
  61 #undef AVLMEL_TEMPUSE
  62 #undef AvlTree
  63 #undef AVL_BASIC
  64
  65 #endif /* _AAPL_AVLBASIC_H */