SDSL 3.0.1
Succinct Data Structure Library
Loading...
Searching...
No Matches
sdsl::rank_support_v< t_b, t_pat_len > Class Template Reference

A rank structure proposed by Sebastiano Vigna. More...

#include <rank_support_v.hpp>

Inheritance diagram for sdsl::rank_support_v< t_b, t_pat_len >:
sdsl::rank_support

Public Types

enum  { bit_pat = t_b }
 
enum  { bit_pat_len = t_pat_len }
 
typedef bit_vector bit_vector_type
 
typedef rank_support_trait< t_b, t_pat_len > trait_type
 
- Public Types inherited from sdsl::rank_support
typedef bit_vector::size_type size_type
 

Public Member Functions

 rank_support_v (const bit_vector *v=nullptr)
 
 rank_support_v (const rank_support_v &)=default
 
 rank_support_v (rank_support_v &&)=default
 
rank_support_voperator= (const rank_support_v &)=default
 
rank_support_voperator= (rank_support_v &&)=default
 
size_type rank (size_type idx) const
 Answers rank queries for the supported bit_vector.
 
size_type operator() (size_type idx) const
 Alias for rank(i)
 
size_type size () const
 
size_type serialize (std::ostream &out, structure_tree_node *v=nullptr, std::string name="") const
 Serializes rank_support.
 
void load (std::istream &in, const int_vector< 1 > *v=nullptr)
 Loads the rank_support.
 
template<typename archive_t >
void CEREAL_SAVE_FUNCTION_NAME (archive_t &ar) const
 
template<typename archive_t >
void CEREAL_LOAD_FUNCTION_NAME (archive_t &ar)
 
bool operator== (const rank_support_v &other) const noexcept
 
bool operator!= (const rank_support_v &other) const noexcept
 
void set_vector (const bit_vector *v=nullptr)
 Sets the supported bit_vector to the given pointer.
 
- Public Member Functions inherited from sdsl::rank_support
 rank_support (const bit_vector *v=nullptr)
 Constructor.
 
 rank_support (const rank_support &)=default
 Copy constructor.
 
 rank_support (rank_support &&)=default
 
rank_supportoperator= (const rank_support &)=default
 
rank_supportoperator= (rank_support &&)=default
 
virtual ~rank_support ()
 Destructor.
 
virtual size_type rank (size_type i) const =0
 Answers rank queries for the supported bit_vector.
 
virtual size_type operator() (size_type idx) const =0
 Alias for rank(i)
 
virtual size_type serialize (std::ostream &out, structure_tree_node *v, std::string name) const =0
 Serializes rank_support.
 
virtual void load (std::istream &in, const bit_vector *v=nullptr)=0
 Loads the rank_support.
 
virtual void set_vector (const bit_vector *v=nullptr)=0
 Sets the supported bit_vector to the given pointer.
 

Additional Inherited Members

- Protected Attributes inherited from sdsl::rank_support
const bit_vectorm_v
 Pointer to the rank supported bit_vector.
 

Detailed Description

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
class sdsl::rank_support_v< t_b, t_pat_len >

A rank structure proposed by Sebastiano Vigna.

Space complexity
$ 0.25n$ for a bit vector of length n bits.

The superblock size is 512. Each superblock is subdivided into 512/64 = 8 blocks. So absolute counts for the superblock add 64/512 bits on top of each supported bit. Since the first of the 8 relative count values is 0, we can fit the remaining 7 (each of width log(512)=9) in a 64bit word. The relative counts add another 64/512 bits on top of each supported bit. In total this results in 128/512=25% overhead.

Template Parameters
t_bBit pattern 0,1,10,01 which should be ranked.
t_pat_lenLength of the bit pattern.
Reference
Sebastiano Vigna: Broadword Implementation of Rank/Select Queries. WEA 2008: 154-168

Definition at line 39 of file rank_support_v.hpp.

Member Typedef Documentation

◆ bit_vector_type

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
typedef bit_vector sdsl::rank_support_v< t_b, t_pat_len >::bit_vector_type

Definition at line 47 of file rank_support_v.hpp.

◆ trait_type

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
typedef rank_support_trait<t_b, t_pat_len> sdsl::rank_support_v< t_b, t_pat_len >::trait_type

Definition at line 48 of file rank_support_v.hpp.

Member Enumeration Documentation

◆ anonymous enum

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
anonymous enum
Enumerator
bit_pat 

Definition at line 49 of file rank_support_v.hpp.

◆ anonymous enum

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
anonymous enum
Enumerator
bit_pat_len 

Definition at line 53 of file rank_support_v.hpp.

Constructor & Destructor Documentation

◆ rank_support_v() [1/3]

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
sdsl::rank_support_v< t_b, t_pat_len >::rank_support_v ( const bit_vector v = nullptr)
inlineexplicit

Definition at line 63 of file rank_support_v.hpp.

◆ rank_support_v() [2/3]

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
sdsl::rank_support_v< t_b, t_pat_len >::rank_support_v ( const rank_support_v< t_b, t_pat_len > &  )
default

◆ rank_support_v() [3/3]

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
sdsl::rank_support_v< t_b, t_pat_len >::rank_support_v ( rank_support_v< t_b, t_pat_len > &&  )
default

Member Function Documentation

◆ CEREAL_LOAD_FUNCTION_NAME()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
template<typename archive_t >
void sdsl::rank_support_v< t_b, t_pat_len >::CEREAL_LOAD_FUNCTION_NAME ( archive_t &  ar)
inline

Definition at line 154 of file rank_support_v.hpp.

◆ CEREAL_SAVE_FUNCTION_NAME()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
template<typename archive_t >
void sdsl::rank_support_v< t_b, t_pat_len >::CEREAL_SAVE_FUNCTION_NAME ( archive_t &  ar) const
inline

Definition at line 148 of file rank_support_v.hpp.

◆ load()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
void sdsl::rank_support_v< t_b, t_pat_len >::load ( std::istream &  in,
const int_vector< 1 > *  v = nullptr 
)
inlinevirtual

Loads the rank_support.

Parameters
inIn-Stream to load the rank_support data from.
vThe supported bit_vector.

Implements sdsl::rank_support.

Definition at line 141 of file rank_support_v.hpp.

◆ operator!=()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
bool sdsl::rank_support_v< t_b, t_pat_len >::operator!= ( const rank_support_v< t_b, t_pat_len > &  other) const
inlinenoexcept

Definition at line 161 of file rank_support_v.hpp.

◆ operator()()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
size_type sdsl::rank_support_v< t_b, t_pat_len >::operator() ( size_type  idx) const
inlinevirtual

Alias for rank(i)

Implements sdsl::rank_support.

Definition at line 128 of file rank_support_v.hpp.

◆ operator=() [1/2]

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
rank_support_v & sdsl::rank_support_v< t_b, t_pat_len >::operator= ( const rank_support_v< t_b, t_pat_len > &  )
default

◆ operator=() [2/2]

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
rank_support_v & sdsl::rank_support_v< t_b, t_pat_len >::operator= ( rank_support_v< t_b, t_pat_len > &&  )
default

◆ operator==()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
bool sdsl::rank_support_v< t_b, t_pat_len >::operator== ( const rank_support_v< t_b, t_pat_len > &  other) const
inlinenoexcept

Definition at line 159 of file rank_support_v.hpp.

◆ rank()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
size_type sdsl::rank_support_v< t_b, t_pat_len >::rank ( size_type  i) const
inlinevirtual

Answers rank queries for the supported bit_vector.

Parameters
iArgument for the length of the prefix v[0..i-1].
Returns
Number of 1-bits in the prefix [0..i-1] of the supported bit_vector.
Note
Method init has to be called before the first call of rank.
See also
init

Implements sdsl::rank_support.

Definition at line 116 of file rank_support_v.hpp.

◆ serialize()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
size_type sdsl::rank_support_v< t_b, t_pat_len >::serialize ( std::ostream &  out,
structure_tree_node v = nullptr,
std::string  name = "" 
) const
inlinevirtual

Serializes rank_support.

Parameters
outOut-Stream to serialize the data to.

Implements sdsl::rank_support.

Definition at line 132 of file rank_support_v.hpp.

◆ set_vector()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
void sdsl::rank_support_v< t_b, t_pat_len >::set_vector ( const bit_vector v = nullptr)
inlinevirtual

Sets the supported bit_vector to the given pointer.

Parameters
vThe new bit_vector to support.
Note
Method init has to be called before the next call of rank.
See also
init, rank

Implements sdsl::rank_support.

Definition at line 163 of file rank_support_v.hpp.

◆ size()

template<uint8_t t_b = 1, uint8_t t_pat_len = 1>
size_type sdsl::rank_support_v< t_b, t_pat_len >::size ( ) const
inline

Definition at line 130 of file rank_support_v.hpp.


The documentation for this class was generated from the following files: