1 /* static_bitsequence.h
2 * Copyright (C) 2008, Francisco Claude, all rights reserved.
4 * static_bitsequence definition
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.
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.
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
22 #ifndef _STATIC_BITSEQUENCE_H
23 #define _STATIC_BITSEQUENCE_H
34 /** Base class for static bitsequences, contains many abstract functions, so this can't
35 * be instantiated. It includes base implementations for rank0, select0 and select1 based
38 * @author Francisco Claude
40 class static_bitsequence {
43 virtual ~static_bitsequence() {};
45 /** Returns the number of zeros until position i */
46 virtual uint rank0(uint i);
48 /** Returns the position of the i-th zero
49 * @return (uint)-1 if i=0, len if i>num_zeros or the position */
50 virtual uint select0(uint i);
52 /** Returns the number of ones until position i */
53 virtual uint rank1(uint i);
55 /** Returns the position of the i-th one
56 * @return (uint)-1 if i=0, len if i>num_ones or the position */
57 virtual uint select1(uint i);
59 /** Returns the i-th bit */
60 virtual bool access(uint i);
62 /** Returns the length in bits of the bitmap */
63 virtual uint length();
65 /** Returns how many ones are in the bitstring */
66 virtual uint count_one();
68 /** Returns how many zeros are in the bitstring */
69 virtual uint count_zero();
71 /** Returns the size of the structure in bytes */
72 virtual uint size()=0;
74 /** Stores the bitmap given a file pointer, return 0 in case of success */
75 virtual int save(FILE * fp)=0;
77 /** Reads a bitmap determining the type */
78 static static_bitsequence * load(FILE * fp);
81 /** Length of the bitstring */
83 /** Number of ones in the bitstring */
88 #include "static_bitsequence_rrr02.h"
89 #include "static_bitsequence_naive.h"
90 #include "static_bitsequence_brw32.h"
92 #endif /* _STATIC_BITSEQUENCE_H */