bbq Implementation Documentation
Main Page | Namespace List | Class List | File List | Namespace Members | Class Members | File Members

bbq::bit_multi_set Class Reference

This class provides and advanced (but also rather inefficient) way of handling sets, which is a major part of the algorithms underlying bbq. More...

#include <bit_multi_set.h>

List of all members.

Public Types

typedef unsigned char c_uint

Public Member Functions

 bit_multi_set (const bit_multi_set &)
 copy constructor

bit_multi_set & operator= (const bit_multi_set &vb)
 assignment operator

 bit_multi_set ()
 default constructor

 ~bit_multi_set ()
 destrcutor

bool subseteq (const bit_multi_set &) const
 Test whether this is a subset of another multiset.

bool subseteq (const bit_multi_set &, const unsigned int &J) const
bool operator< (const bit_multi_set &) const
 We obtain a canonical order on subsets of [1:k] by considering such a set as a number between 0 and 2^k-1.

bool operator== (const bit_multi_set &) const
 Two sets are considered equivalent iff they contain the same elements, not regarding their weights.

int cardinality ()
 returns the number of elements contained in the multiset

float weight ()
 in the simple form implemented here, the weight is equal to the number of elements contained in the multiset.

void intersect (const bit_multi_set &b)
 standard multiset intersection

void set (const int &j, const float &w)
 add one element j to the multiset.

void reset (const int &j, const float &w)
 change the weight of element j; only needed for sets, not for multisets.

void decrease (const int &j, const float &w)
 remove ONE element j from the multiset.

void remove (const int &j, const float &w)
 remove ALL elements j from the multiset.

bool contains (const int &)
 is there at least one element with the index passed by the parameter?


Public Attributes

c_uint * counts
float * weights

Static Public Attributes

int k = 128
 k corresponds to the number of bits and hence the number of sequence fragments in footprint_detector

bool weighted = true
 left for compatibility reasons with other set types

int k_ = 4

Friends

std::ostream & operator<< (std::ostream &o, const bit_multi_set &)

Detailed Description

This class provides and advanced (but also rather inefficient) way of handling sets, which is a major part of the algorithms underlying bbq.

This class particularly supports unweighted sets whose cardinality is unlimited. It supports multiset capabilities, but is far less memory efficient than the simple-set versions.

Member Typedef Documentation

typedef unsigned char bbq::bit_multi_set::c_uint
 

Constructor & Destructor Documentation

bbq::bit_multi_set::bit_multi_set (  const bit_multi_set &   ) 
 

copy constructor

bbq::bit_multi_set::bit_multi_set (   ) 
 

default constructor

bbq::bit_multi_set::~bit_multi_set (   )  [inline]
 

destrcutor

Member Function Documentation

int bbq::bit_multi_set::cardinality (   ) 
 

returns the number of elements contained in the multiset

bool bbq::bit_multi_set::contains (  const int &   ) 
 

is there at least one element with the index passed by the parameter?

void bbq::bit_multi_set::decrease (  const int &  j,
const float &  w
) 
 

remove ONE element j from the multiset.

void bbq::bit_multi_set::intersect (  const bit_multi_set &  b  ) 
 

standard multiset intersection

bool bbq::bit_multi_set::operator< (  const bit_multi_set &   )  const
 

We obtain a canonical order on subsets of [1:k] by considering such a set as a number between 0 and 2^k-1.

This order is needed for inserting weighted sets into (multi-)sets for the enumerate_differences() method. Note that weightings are not taken into account; two sets containing the same elements but different weights are considered equivalent (which is the reason why they are stored in a multiset rather than a set).

bit_multi_set & bbq::bit_multi_set::operator= (  const bit_multi_set &  vb  ) 
 

assignment operator

bool bbq::bit_multi_set::operator== (  const bit_multi_set &   )  const
 

Two sets are considered equivalent iff they contain the same elements, not regarding their weights.

this is needed for inserting weighted sets into (multi-)sets for the enumerate_differences() method. Note that weightings are not taken into account; two sets containing the same elements but different weights are considered equivalent (which is the reason why they are stored in a multiset rather than a set).

void bbq::bit_multi_set::remove (  const int &  j,
const float &  w
) 
 

remove ALL elements j from the multiset.

Can actually be ignored for multisets, since the remove job is taken by decrease.

void bbq::bit_multi_set::reset (  const int &  j,
const float &  w
) 
 

change the weight of element j; only needed for sets, not for multisets.

void bbq::bit_multi_set::set (  const int &  j,
const float &  w
) 
 

add one element j to the multiset.

The weight is (currently) neglected.

bool bbq::bit_multi_set::subseteq (  const bit_multi_set &  ,
const unsigned int &  J
)  const
 

bool bbq::bit_multi_set::subseteq (  const bit_multi_set &   )  const
 

Test whether this is a subset of another multiset.

float bbq::bit_multi_set::weight (   ) 
 

in the simple form implemented here, the weight is equal to the number of elements contained in the multiset.

Friends And Related Function Documentation

std::ostream& operator<< (  std::ostream &  o,
const bit_multi_set &  I
)  [friend]
 

Member Data Documentation

c_uint* bbq::bit_multi_set::counts
 

int bbq::bit_multi_set::k = 128 [static]
 

k corresponds to the number of bits and hence the number of sequence fragments in footprint_detector

int bbq::bit_multi_set::k_ = 4 [static]
 

bool bbq::bit_multi_set::weighted = true [static]
 

left for compatibility reasons with other set types

float* bbq::bit_multi_set::weights
 

The documentation for this class was generated from the following files:
bbq Implementation Documentation
Axel Mosig, Bioinformatics, University of Leipzig