Dune::BitSetVectorConstReference< block_size, Alloc > Class Template Reference

A proxy class that acts as a const reference to a single bitset in a BitSetVector. More...

#include <dune/common/bitsetvector.hh>

Inheritance diagram for Dune::BitSetVectorConstReference< block_size, Alloc >:
Inheritance graph

List of all members.

Public Types

typedef std::bitset< block_size > bitset
typedef std::vector< bool,
Alloc >::const_reference 
reference
typedef std::vector< bool,
Alloc >::const_reference 
const_reference
typedef size_t size_type

Public Member Functions

bitset operator<< (size_type n) const
 Returns a copy of *this shifted left by n bits.
bitset operator>> (size_type n) const
 Returns a copy of *this shifted right by n bits.
bitset operator~ () const
 Returns a copy of *this with all of its bits flipped.
size_type size () const
 Returns block_size.
size_type count () const
 Returns the number of bits that are set.
bool any () const
 Returns true if any bits are set.
bool none () const
 Returns true if no bits are set.
bool test (size_type n) const
 Returns true if bit n is set.
const_reference operator[] (size_type i) const
 operator bitset () const
 cast to bitset
bool operator== (const bitset &bs) const
 Equality of reference and std::bitset.
bool operator== (const BitSetVectorConstReference &bs) const
 Equality of reference and other reference.
bool operator!= (const bitset &bs) const
 Inequality of reference and std::bitset.
bool operator!= (const BitSetVectorConstReference &bs) const
 Inequality of reference and other reference.

Protected Types

typedef Dune::BitSetVector
< block_size, Alloc > 
BitSetVector

Protected Member Functions

 BitSetVectorConstReference (const BitSetVector &blockBitField, int block_number)
BitSetVectorConstReferenceoperator= (const BitSetVectorConstReference &b)
 hide assignment operator
const_reference getBit (size_type i) const
template<class BS >
bool equals (const BS &bs) const

Protected Attributes

const BitSetVectorblockBitField
int block_number

Friends

class Dune::BitSetVector< block_size, Alloc >
class BitSetVectorReference< block_size, Alloc >
std::ostream & operator<< (std::ostream &s, const BitSetVectorConstReference &v)

Detailed Description

template<int block_size, class Alloc>
class Dune::BitSetVectorConstReference< block_size, Alloc >

A proxy class that acts as a const reference to a single bitset in a BitSetVector.

It contains a conversion to std::bitset and most of the interface of const std::bitset.

Warning:
As this is only a proxy class, you can not get the address of the bitset.

Member Typedef Documentation

template<int block_size, class Alloc >
typedef std::bitset<block_size> Dune::BitSetVectorConstReference< block_size, Alloc >::bitset
template<int block_size, class Alloc >
typedef Dune::BitSetVector<block_size, Alloc> Dune::BitSetVectorConstReference< block_size, Alloc >::BitSetVector [protected]
template<int block_size, class Alloc >
typedef std::vector<bool, Alloc>::const_reference Dune::BitSetVectorConstReference< block_size, Alloc >::const_reference
template<int block_size, class Alloc >
typedef std::vector<bool, Alloc>::const_reference Dune::BitSetVectorConstReference< block_size, Alloc >::reference
template<int block_size, class Alloc >
typedef size_t Dune::BitSetVectorConstReference< block_size, Alloc >::size_type

Constructor & Destructor Documentation

template<int block_size, class Alloc >
Dune::BitSetVectorConstReference< block_size, Alloc >::BitSetVectorConstReference ( const BitSetVector blockBitField,
int  block_number 
) [inline, protected]

Member Function Documentation

template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::any (  )  const [inline]
template<int block_size, class Alloc >
size_type Dune::BitSetVectorConstReference< block_size, Alloc >::count (  )  const [inline]
template<int block_size, class Alloc >
template<class BS >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::equals ( const BS &  bs  )  const [inline, protected]
template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::none (  )  const [inline]

Returns true if no bits are set.

References Dune::BitSetVectorConstReference< block_size, Alloc >::any().

template<int block_size, class Alloc >
Dune::BitSetVectorConstReference< block_size, Alloc >::operator bitset (  )  const [inline]
template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::operator!= ( const bitset bs  )  const [inline]

Inequality of reference and std::bitset.

References Dune::BitSetVectorConstReference< block_size, Alloc >::equals().

template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::operator!= ( const BitSetVectorConstReference< block_size, Alloc > &  bs  )  const [inline]

Inequality of reference and other reference.

References Dune::BitSetVectorConstReference< block_size, Alloc >::equals().

template<int block_size, class Alloc >
bitset Dune::BitSetVectorConstReference< block_size, Alloc >::operator<< ( size_type  n  )  const [inline]

Returns a copy of *this shifted left by n bits.

template<int block_size, class Alloc >
BitSetVectorConstReference& Dune::BitSetVectorConstReference< block_size, Alloc >::operator= ( const BitSetVectorConstReference< block_size, Alloc > &  b  )  [protected]

hide assignment operator

template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::operator== ( const BitSetVectorConstReference< block_size, Alloc > &  bs  )  const [inline]

Equality of reference and other reference.

References Dune::BitSetVectorConstReference< block_size, Alloc >::equals().

template<int block_size, class Alloc >
bool Dune::BitSetVectorConstReference< block_size, Alloc >::operator== ( const bitset bs  )  const [inline]

Equality of reference and std::bitset.

References Dune::BitSetVectorConstReference< block_size, Alloc >::equals().

template<int block_size, class Alloc >
bitset Dune::BitSetVectorConstReference< block_size, Alloc >::operator>> ( size_type  n  )  const [inline]

Returns a copy of *this shifted right by n bits.

template<int block_size, class Alloc >
const_reference Dune::BitSetVectorConstReference< block_size, Alloc >::operator[] ( size_type  i  )  const [inline]
template<int block_size, class Alloc >
bitset Dune::BitSetVectorConstReference< block_size, Alloc >::operator~ (  )  const [inline]

Returns a copy of *this with all of its bits flipped.

template<int block_size, class Alloc >
size_type Dune::BitSetVectorConstReference< block_size, Alloc >::size (  )  const [inline]

Returns block_size.


Friends And Related Function Documentation

template<int block_size, class Alloc >
friend class BitSetVectorReference< block_size, Alloc > [friend]
template<int block_size, class Alloc >
friend class Dune::BitSetVector< block_size, Alloc > [friend]
template<int block_size, class Alloc >
std::ostream& operator<< ( std::ostream &  s,
const BitSetVectorConstReference< block_size, Alloc > &  v 
) [friend]

missing operators:

  • unsigned long to_ulong() const

Member Data Documentation


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

Generated on Fri Apr 29 2011 with Doxygen (ver 1.7.1) [doxygen-log,error-log].