A hybrid-encoded compressed bitvector representation. More...

#include <hyb_vector.hpp>

Public Types
typedef bit_vector::size_type	size_type

typedef bit_vector::value_type	value_type

typedef bit_vector::difference_type	difference_type

typedef random_access_const_iterator< hyb_vector >	iterator

typedef rank_support_hyb< 1, k_sblock_rate >	rank_1_type

typedef rank_support_hyb< 0, k_sblock_rate >	rank_0_type

typedef select_support_hyb< 1, k_sblock_rate >	select_1_type

typedef select_support_hyb< 0, k_sblock_rate >	select_0_type

Public Member Functions
	hyb_vector ()=default
	Default constructor.

	hyb_vector (hyb_vector const &hybrid)=default

	hyb_vector (hyb_vector &&hybrid)=default

hyb_vector &	operator= (hyb_vector const &hybrid)=default

hyb_vector &	operator= (hyb_vector &&hybrid)=default

	hyb_vector (bit_vector const &bv)
	Constructor.

uint64_t	get_int (size_type idx, const uint8_t len=64) const
	Get the integer value of the binary string of length len starting at position idx.

value_type	operator[] (size_type i) const
	Accessing the i-th element of the original bitvector.

size_type	size () const
	Returns the size of the original bitvector.

size_type	serialize (std::ostream &out, structure_tree_node *v=nullptr, std::string name="") const
	Serializes the data structure into the given ostream.

void	load (std::istream &in)
	Loads the data structure from the given istream.

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)

iterator	begin () const

iterator	end () const

bool	operator== (hyb_vector const &v) const

bool	operator!= (hyb_vector const &v) const

Friends
class	rank_support_hyb< 1, k_sblock_rate >

class	rank_support_hyb< 0, k_sblock_rate >

class	select_support_hyb< 1, k_sblock_rate >

class	select_support_hyb< 0, k_sblock_rate >

Detailed Description

template<uint32_t k_sblock_rate = 16>
class sdsl::hyb_vector< k_sblock_rate >

A hybrid-encoded compressed bitvector representation.

Template Parameters

k_sblock_rate Superblock rate (number of blocks inside superblock)

References:

Juha Karkkainen, Dominik Kempa and Simon J. Puglisi. Hybrid Compression of Bitvectors for the FM-Index. DCC 2014.

Definition at line 72 of file hyb_vector.hpp.

Member Typedef Documentation

◆ difference_type

template<uint32_t k_sblock_rate = 16>

typedef bit_vector::difference_type sdsl::hyb_vector< k_sblock_rate >::difference_type

Definition at line 77 of file hyb_vector.hpp.

◆ iterator

template<uint32_t k_sblock_rate = 16>

typedef random_access_const_iterator<hyb_vector> sdsl::hyb_vector< k_sblock_rate >::iterator

Definition at line 78 of file hyb_vector.hpp.

◆ rank_0_type

template<uint32_t k_sblock_rate = 16>

typedef rank_support_hyb<0, k_sblock_rate> sdsl::hyb_vector< k_sblock_rate >::rank_0_type

Definition at line 80 of file hyb_vector.hpp.

◆ rank_1_type

template<uint32_t k_sblock_rate = 16>

typedef rank_support_hyb<1, k_sblock_rate> sdsl::hyb_vector< k_sblock_rate >::rank_1_type

Definition at line 79 of file hyb_vector.hpp.

◆ select_0_type

template<uint32_t k_sblock_rate = 16>

typedef select_support_hyb<0, k_sblock_rate> sdsl::hyb_vector< k_sblock_rate >::select_0_type

Definition at line 82 of file hyb_vector.hpp.

◆ select_1_type

template<uint32_t k_sblock_rate = 16>

typedef select_support_hyb<1, k_sblock_rate> sdsl::hyb_vector< k_sblock_rate >::select_1_type

Definition at line 81 of file hyb_vector.hpp.

◆ size_type

template<uint32_t k_sblock_rate = 16>

typedef bit_vector::size_type sdsl::hyb_vector< k_sblock_rate >::size_type

Definition at line 75 of file hyb_vector.hpp.

◆ value_type

template<uint32_t k_sblock_rate = 16>

typedef bit_vector::value_type sdsl::hyb_vector< k_sblock_rate >::value_type

Definition at line 76 of file hyb_vector.hpp.

Constructor & Destructor Documentation

◆ hyb_vector() [1/4]

template<uint32_t k_sblock_rate = 16>

sdsl::hyb_vector< k_sblock_rate >::hyb_vector ( )

default

Default constructor.

◆ hyb_vector() [2/4]

template<uint32_t k_sblock_rate = 16>

sdsl::hyb_vector< k_sblock_rate >::hyb_vector ( hyb_vector< k_sblock_rate > const & hybrid )

default

◆ hyb_vector() [3/4]

template<uint32_t k_sblock_rate = 16>

sdsl::hyb_vector< k_sblock_rate >::hyb_vector ( hyb_vector< k_sblock_rate > && hybrid )

default

◆ hyb_vector() [4/4]

template<uint32_t k_sblock_rate = 16>

sdsl::hyb_vector< k_sblock_rate >::hyb_vector ( bit_vector const & bv )

inline

Constructor.

Definition at line 110 of file hyb_vector.hpp.

Member Function Documentation

◆ begin()

template<uint32_t k_sblock_rate = 16>

iterator sdsl::hyb_vector< k_sblock_rate >::begin ( ) const

inline

Definition at line 680 of file hyb_vector.hpp.

◆ CEREAL_LOAD_FUNCTION_NAME()

template<uint32_t k_sblock_rate = 16>

template<typename archive_t>

void sdsl::hyb_vector< k_sblock_rate >::CEREAL_LOAD_FUNCTION_NAME ( archive_t & ar )

inline

Definition at line 672 of file hyb_vector.hpp.

◆ CEREAL_SAVE_FUNCTION_NAME()

template<uint32_t k_sblock_rate = 16>

template<typename archive_t>

void sdsl::hyb_vector< k_sblock_rate >::CEREAL_SAVE_FUNCTION_NAME ( archive_t & ar ) const

inline

Definition at line 663 of file hyb_vector.hpp.

◆ end()

template<uint32_t k_sblock_rate = 16>

iterator sdsl::hyb_vector< k_sblock_rate >::end ( ) const

inline

Definition at line 685 of file hyb_vector.hpp.

◆ get_int()

template<uint32_t k_sblock_rate = 16>

uint64_t sdsl::hyb_vector< k_sblock_rate >::get_int	(	size_type	idx,
		const uint8_t	len = 64 ) const

inline

Get the integer value of the binary string of length len starting at position idx.

Parameters

idx	Starting index of the binary representation of the integer.
len	Length of the binary representation of the integer. Default value is 64.

Returns: The integer value of the binary string of length len starting at position idx.

Precondition: idx+len-1 in [0..size()-1]; len in [1..64]

Definition at line 617 of file hyb_vector.hpp.

◆ load()

template<uint32_t k_sblock_rate = 16>

void sdsl::hyb_vector< k_sblock_rate >::load ( std::istream & in )

inline

Loads the data structure from the given istream.

Definition at line 654 of file hyb_vector.hpp.

◆ operator!=()

template<uint32_t k_sblock_rate = 16>

bool sdsl::hyb_vector< k_sblock_rate >::operator!= ( hyb_vector< k_sblock_rate > const & v ) const

inline

Definition at line 696 of file hyb_vector.hpp.

◆ operator=() [1/2]

template<uint32_t k_sblock_rate = 16>

hyb_vector & sdsl::hyb_vector< k_sblock_rate >::operator= ( hyb_vector< k_sblock_rate > && hybrid )

default

◆ operator=() [2/2]

template<uint32_t k_sblock_rate = 16>

hyb_vector & sdsl::hyb_vector< k_sblock_rate >::operator= ( hyb_vector< k_sblock_rate > const & hybrid )

default

◆ operator==()

template<uint32_t k_sblock_rate = 16>

bool sdsl::hyb_vector< k_sblock_rate >::operator== ( hyb_vector< k_sblock_rate > const & v ) const

inline

Definition at line 690 of file hyb_vector.hpp.

◆ operator[]()

template<uint32_t k_sblock_rate = 16>

value_type sdsl::hyb_vector< k_sblock_rate >::operator[] ( size_type i ) const

inline

Accessing the i-th element of the original bitvector.

Definition at line 629 of file hyb_vector.hpp.

◆ serialize()

template<uint32_t k_sblock_rate = 16>

size_type sdsl::hyb_vector< k_sblock_rate >::serialize	(	std::ostream &	out,
		structure_tree_node *	v = nullptr,
		std::string	name = "" ) const

inline

Serializes the data structure into the given ostream.

Definition at line 641 of file hyb_vector.hpp.

◆ size()

template<uint32_t k_sblock_rate = 16>

size_type sdsl::hyb_vector< k_sblock_rate >::size ( ) const

inline

Returns the size of the original bitvector.

Definition at line 635 of file hyb_vector.hpp.

Friends And Related Symbol Documentation

◆ rank_support_hyb< 0, k_sblock_rate >

template<uint32_t k_sblock_rate = 16>

friend class rank_support_hyb< 0, k_sblock_rate >

friend

Definition at line 82 of file hyb_vector.hpp.

◆ rank_support_hyb< 1, k_sblock_rate >

template<uint32_t k_sblock_rate = 16>

friend class rank_support_hyb< 1, k_sblock_rate >

friend

Definition at line 82 of file hyb_vector.hpp.

◆ select_support_hyb< 0, k_sblock_rate >

template<uint32_t k_sblock_rate = 16>

friend class select_support_hyb< 0, k_sblock_rate >

friend

Definition at line 82 of file hyb_vector.hpp.

◆ select_support_hyb< 1, k_sblock_rate >

template<uint32_t k_sblock_rate = 16>

friend class select_support_hyb< 1, k_sblock_rate >

friend

Definition at line 82 of file hyb_vector.hpp.

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

/builddir/build/BUILD/sdsl-lite-3.0.3-build/sdsl-lite-3.0.3/include/sdsl/hyb_vector.hpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ difference_type

◆ iterator

◆ rank_0_type

◆ rank_1_type

◆ select_0_type

◆ select_1_type

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ hyb_vector() [1/4]

◆ hyb_vector() [2/4]

◆ hyb_vector() [3/4]

◆ hyb_vector() [4/4]

Member Function Documentation

◆ begin()

◆ CEREAL_LOAD_FUNCTION_NAME()

◆ CEREAL_SAVE_FUNCTION_NAME()

◆ end()

◆ get_int()

◆ load()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ operator[]()

◆ serialize()

◆ size()

Friends And Related Symbol Documentation

◆ rank_support_hyb< 0, k_sblock_rate >

◆ rank_support_hyb< 1, k_sblock_rate >

◆ select_support_hyb< 0, k_sblock_rate >

◆ select_support_hyb< 1, k_sblock_rate >