libcds/src/static_sequence/static_sequence.h

   1 /* static_sequence.h
   2  * Copyright (C) 2008, Francisco Claude, all rights reserved.
   3  *
   4  * static_sequence definition
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  */
  21
  22 #ifndef _STATIC_SEQUENCE_H
  23 #define _STATIC_SEQUENCE_H
  24
  25
  26 #include <basics.h>
  27 #include <iostream>
  28
  29 #define WVTREE_HDR 2
  30 #define GMR_CHUNK_HDR 3
  31 #define GMR_HDR 4
  32 #define WVTREE_NOPTRS_HDR 5
  33
  34 using namespace std;
  35
  36 /** Base class for static sequences, contains many abstract functions, so this can't
  37  *  be instantiated.
  38  *
  39  *  @author Francisco Claude
  40  */
  41 class static_sequence {
  42
  43 public:
  44   static_sequence();
  45   virtual ~static_sequence();
  46
  47   /** Returns the number of occurrences of c until position i */
  48   virtual uint rank(uint c, uint i)=0;
  49   virtual uint rankLessThan(uint &i, uint j)
  50   {
  51       //assert(0); // Implemented only in static_sequence_wvtree
  52       return -1;
  53   }
  54
  55   /** Returns the position of the i-th c
  56    * @return (uint)-1 if i=0, len if i exceeds the number of cs */
  57   virtual uint select(uint c, uint i)=0;
  58
  59   /** Returns the i-th element */
  60   virtual uint access(uint i)=0;
  61   virtual uint access(uint i, uint &rank)
  62   {
  63       //assert(0); // Implemented only in static_sequence_wvtree
  64       return -1;
  65   }
  66
  67
  68   /** Returns the length of the sequence */
  69   virtual uint length();
  70
  71   /** Returns how many cs are in the sequence */
  72   virtual uint count(uint c);
  73
  74   /** Returns the size of the structure in bytes */
  75   virtual uint size()=0;
  76
  77   /** Stores the bitmap given a file pointer, return 0 in case of success */
  78   virtual uint save(FILE * fp)=0;
  79
  80         virtual bool test(uint * seq, uint n);
  81
  82   /** Reads a bitmap determining the type */
  83   static static_sequence * load(FILE * fp);
  84
  85 protected:
  86   /** Length of the bitstring */
  87   uint len;
  88
  89 };
  90
  91 #include <static_sequence_wvtree.h>
  92 #include <static_sequence_gmr_chunk.h>
  93 #include <static_sequence_wvtree_noptrs.h>
  94 #include <static_sequence_gmr.h>
  95
  96 #endif  /* _STATIC_SEQUENCE_H */