A class that provides support for bit_vectors that represent a balanced parentheses sequence. Implementation was proposed by Geary et al. (CPM 2004) and extended by Ohlebusch and Gog (SPIRE 2009). More...

#include <bp_support_gg.hpp>

Public Types
typedef bit_vector::size_type	size_type
typedef NearestNeighbourDictionary	nnd_type
typedef RankSupport	rank_support_type
typedef SelectSupport	select_support_type
typedef bp_support_gg < nnd_type, RankSupport, select_support_bs< RankSupport > >	bp_support_type
Public Member Functions
	bp_support_gg (const bit_vector *bp, uint32_t used_block_size=840)
	Constructor.
	bp_support_gg (const bp_support_gg &bp_support)
	Copy constructor.
	~bp_support_gg ()
	Destructor.
void	swap (bp_support_gg &bp_support)
	Swap operator.
bp_support_gg &	operator= (const bp_support_gg &bp_support)
	Assignment operator.
void	set_vector (const bit_vector *bp)
size_type	excess (size_type i) const
size_type	rank (size_type i) const
size_type	select (size_type i) const
size_type	find_close (size_type i) const
size_type	find_open (size_type i) const
	Calculate the matching opening parenthesis to the closing parenthesis at position i.
size_type	enclose (size_type i) const
	Calculate the index of the opening parenthesis corresponding to the closest matching parenthesis pair enclosing i.
size_type	rr_enclose (const size_type i, const size_type j) const
	The range restricted enclose operation for parentheses pairs $(i,\mu(i))$ and $(j,\mu(j))$ .
size_type	rmq_open (const size_type l, const size_type r) const
size_type	rr_enclose_naive (size_type i, size_type j) const
	The range restricted enclose operation.
size_type	rmq (size_type l, size_type r) const
	The range minimum query (rmq) returns the index of the parenthesis with minimal excess in the range .
size_type	double_enclose (size_type i, size_type j) const
	The double enclose operation.
size_type	preceding_closing_parentheses (size_type i) const
	Return the number of zeros which procede position i in the balanced parentheses sequence.
size_type	size () const
size_type	serialize (std::ostream &out, structure_tree_node *v=NULL, std::string name="") const
	Serializes the bp_support_gg to a stream.
void	load (std::istream &in, const bit_vector *bp)
	Load the bp_support_gg for a bit_vector v.
std::string	get_info () const
Public Attributes
const RankSupport &	bp_rank
const SelectSupport &	bp_select

Detailed Description

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>
class sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >

A class that provides support for bit_vectors that represent a balanced parentheses sequence. Implementation was proposed by Geary et al. (CPM 2004) and extended by Ohlebusch and Gog (SPIRE 2009).

This data structure supports the following methods on a bit_vector b that represents a balanced parentheses sequence:

rank
select
excess
find_open
find_close
enclose
rr_enclose

An opening parenthesis in the balanced parentheses sequence is represented by a 1 in the bit_vector and a closing parenthesis by a 0.

This class could be parametrized by four parameters:

NearestNeighbourDictionary is a class which supports rank and select with little space on sparse populated bit_vectors.
RankSupport is a class which support the rank operation on bit_vectors.
SelectSupport is a class which support the select operation on bit_vectors.

Member Function Documentation

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::double_enclose	(	size_type	i,
		size_type	j
	)		const `[inline]`

The double enclose operation.

Parameters:

i	Index of an opening parenthesis.
j	Index of an opening parenthesis $i<j \wedge findclose(i) < j$ .

Returns:: The maximal opening parenthesis, say k, such that $k<j \wedge k>findclose(j)$ . If such a k does not exists, double_enclose(i,j) returns size().

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::enclose ( size_type i ) const [inline]

Calculate the index of the opening parenthesis corresponding to the closest matching parenthesis pair enclosing i.

Parameters:

i	Index of an opening parenthesis.

Returns:: The index of the opening parenthesis corresponding to the closest matching parenthesis pair enclosing i, or size() if no such pair exists.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::excess ( size_type i ) const [inline]

Calculates the excess value at index i.

Parameters:

i	The index of which the excess value should be calculated.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::find_close ( size_type i ) const [inline]

Calculate the index of the matching closing parenthesis to the parenthesis at index i.

Parameters:

i	Index of an parenthesis. 0 <= i < size().

Returns:

* i, if the parenthesis at index i is closing,

the position j of the matching closing parenthesis, if a matching parenthesis exists,
size() if no matching closing parenthesis exists.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::find_open ( size_type i ) const [inline]

Calculate the matching opening parenthesis to the closing parenthesis at position i.

Parameters:

i	Index of a closing parenthesis.

Returns:

* i, if the parenthesis at index i is closing,

the position j of the matching opening parenthesis, if a matching parenthesis exists,
size() if no matching closing parenthesis exists.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

void sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::load	(	std::istream &	in,
		const bit_vector *	bp
	)		`[inline]`

Load the bp_support_gg for a bit_vector v.

Parameters:

in	The instream from which the data strucutre is read.
bp	Bit vector representing a balanced parentheses sequence that is supported by this data structure.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::preceding_closing_parentheses ( size_type i ) const [inline]

Return the number of zeros which procede position i in the balanced parentheses sequence.

Parameters:

i	Index of an parenthesis.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::rank ( size_type i ) const [inline]

Returns the number of opening parentheses up to and including index i.

Precondition:: { $0\leq i < size()$ }

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::rmq	(	size_type	l,
		size_type	r
	)		const `[inline]`

The range minimum query (rmq) returns the index of the parenthesis with minimal excess in the range $[l..r]$ .

    \param l The left border of the interval \form#68 ( \form#69).
    \param r The right border of the interval \form#68 ( \form#70).

TODO: bisher liefert rmq nicht immer das am weitesen rechts liegende minimum

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::rmq_open	(	const size_type	l,
		const size_type	r
	)		const `[inline]`

Search the interval [l,r-1] for an opening parenthesis, say i, such that find_close(i) >= r.

Parameters:

l	The left end (inclusive) of the interval to search for the result.
r	The right end (exclusive) of the interval to search for the result.

Returns:: the minimal opening parenthesis i with $\ell \leq i < r$ and $find_close(i) \geq r$ ; if no such i exists size() is returned.

Time complexity: $\Order{block\_size}$

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::rr_enclose	(	const size_type	i,
		const size_type	j
	)		const `[inline]`

The range restricted enclose operation for parentheses pairs $(i,\mu(i))$ and $(j,\mu(j))$ .

Parameters:

i	First opening parenthesis.
j	Second opening parenthesis $i<j \wedge findclose(i) < j$ .

Returns:: The smallest index, say k, of an opening parenthesis such that findclose(i) < k < j and findclose(j) < findclose(k). If such a k does not exists, restricted_enclose(i,j) returns size().

Time complexity: $\Order{block\_size}$

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::rr_enclose_naive	(	size_type	i,
		size_type	j
	)		const `[inline]`

The range restricted enclose operation.

Parameters:

i	Index of an opening parenthesis.
j	Index of an opening parenthesis $i<j \wedge findclose(i) < j$ .

Returns:: The minimal opening parenthesis, say k, such that and findclose(j) < findclose(k). If such a k does not exists, restricted_enclose(i,j) returns size().

Time complexity: $\Order{size()}$ in the worst case.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::select ( size_type i ) const [inline]

Returns the index of the i-th opening parenthesis.

Parameters:

i	Number of the parenthesis to select.

Precondition:: { $1\leq i < rank(size())$ }

Postcondition:: { $0\leq select(i) < size()$ }

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::serialize	(	std::ostream &	out,
		structure_tree_node *	v = `NULL`,
		std::string	name = `""`
	)		const `[inline]`

Serializes the bp_support_gg to a stream.

Parameters:

out	The outstream to which the data structure is written.

Returns:: The number of bytes written to out.

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>

size_type sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >::size ( ) const [inline]

The size of the supported balanced parentheses sequence.

Returns:: the size of the supported balanced parentheses sequence.

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

sdsl/include/sdsl/bp_support_gg.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>> class sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >

Member Function Documentation

template<class NearestNeighbourDictionary = nearest_neighbour_dictionary<30>, class RankSupport = rank_support_v<>, class SelectSupport = select_support_mcl<>>
class sdsl::bp_support_gg< NearestNeighbourDictionary, RankSupport, SelectSupport >