好记性不如铅笔头

C && C++, C++ STL, 编程

C++ STL读书笔记:bvector

备注:

本读书笔记基于侯捷先生的《STL源码剖析》,截图和注释版权均属于原作者所有。
本读书笔记中的源码部分直接拷贝自SGI-STL,部分代码删除了头部的版权注释,但代码版权属于原作者。
小弟初看stl,很多代码都不是太懂,注释可能有很多错误,还请路过的各位大牛多多给予指导。
为了降低学习难度,作者这里换到了SGI-STL-2.91.57的源码来学习,代码下载地址为【 http://jjhou.boolan.com/jjwbooks-tass.htm 】

如果我们需要存储很多位值时,我们可以使用bvector或者bitset【 http://www.cplusplus.com/reference/bitset/bitset/ 】,这里简单的笔记下bvector的代码实现:

stl_bvector.h:

//位值的存储类。这里的位是以int为载体存储的。
struct __bit_reference {
  unsigned int* p;    //指向作为载体的int。
  unsigned int mask;  //掩码值,只有一位为1,其余为0,标识了该位值在int中的位置(即偏移量)。
  __bit_reference(unsigned int* x, unsigned int y) : p(x), mask(y) {}//构造函数,简单赋值。

public:
  __bit_reference() : p(0), mask(0) {}
  operator bool() const { return !(!(*p & mask)); }//返回该位值,(以bool形式返回,注意这里使用的是重写转换函数)
  __bit_reference& operator=(bool x) { //赋值构造函数。
    if (x)      
      *p |= mask;//如果要赋的值为真(即特定的位赋值为1),很简单直接将*p和mask按位或即可,由于mask的指示方式这样特定位必定为1。
    else 
      *p &= ~mask;//如果要赋的值为0(即特定的位赋值为0),那么就将*p和mask的反按位与即可。由于mask的指示方式这样特定位必定为0,其余位和1相与,值不变。
    return *this;
  }
  __bit_reference& operator=(const __bit_reference& x) { return *this = bool(x); }
  bool operator==(const __bit_reference& x) const {//比较两个__bit_reference是否相等。
    return bool(*this) == bool(x);
  }
  bool operator<(const __bit_reference& x) const {
    return bool(*this) < bool(x);
  }
  void flip() { *p ^= mask; }//翻转该位值。直接将*p和mask按位异或即可。(异或性质:和0异或值不变,和1异或值相反)
};

inline void swap(__bit_reference x, __bit_reference y) {//交换
  bool tmp = x;
  x = y;
  y = tmp;
}

//bvector的iterator值,这里注意是继承自random_access
struct __bit_iterator : public random_access_iterator<bool, ptrdiff_t> {
  typedef __bit_reference  reference;
  typedef __bit_reference* pointer;
  typedef __bit_iterator iterator;

  unsigned int* p;      //指向作为载体的int。一个int是4个字节(双字),因此可以存储4*8个位值。
  unsigned int offset;  //标识该位值在int中的偏移量。
  void bump_up() {//递增到下一位。
    if (offset++ == __WORD_BIT - 1) {//如果offset当前的值为4*8-1,说明当前的offset已经指向了当前int的最后一位(以0起始)
      offset = 0;//那么就调到下一个int上。同时offset设置0,这样就指向了新的int的第一位。
      ++p;
    }
  }
  void bump_down() {//地见到上一位。
    if (offset-- == 0) {//如果当前的offset为0,说明指向了当前int的第一位。
      offset = __WORD_BIT - 1;//那么就跳到了上一个int上,同时offset设置为最大值(4*8-1),这样就指向了新的int的最后一位。
      --p;
    }
  }

  __bit_iterator() : p(0), offset(0) {}
  __bit_iterator(unsigned int* x, unsigned int y) : p(x), offset(y) {}//iterator构造函数
  reference operator*() const { return reference(p, 1U << offset); }//对iterator进行解引用,返回的是__bit_reference。
  //注意这里的构造函数中的第二个参数是1U << offset,即将1U左位移offset位,以作为mask。
  iterator& operator++() {//递增运算符,这里调用了bump_up。
    bump_up();
    return *this;
  }
  iterator operator++(int) {//递增运算符,这里调用了bump_up。
    iterator tmp = *this;
    bump_up();
    return tmp;
  }
  iterator& operator--() { //递增运算符,这里调用了bump_down。
    bump_down();
    return *this;
  }
  iterator operator--(int) { //递增运算符,这里调用了bump_down。
    iterator tmp = *this;
    bump_down();
    return tmp;
  }
  iterator& operator+=(difference_type i) {//iterator前后移动i个位置。
    difference_type n = i + offset;
    p += n / __WORD_BIT;
    n = n % __WORD_BIT;
    if (n < 0) {
      offset = (unsigned int) n + __WORD_BIT;
      --p;
    } else
      offset = (unsigned int) n;
    return *this;
  }
  iterator& operator-=(difference_type i) {
    *this += -i;
    return *this;
  }
  iterator operator+(difference_type i) const {
    iterator tmp = *this;
    return tmp += i;
  }
  iterator operator-(difference_type i) const {
    iterator tmp = *this;
    return tmp -= i;
  }
  //返回两个iterator间的距离,
  difference_type operator-(iterator x) const {
    return __WORD_BIT * (p - x.p) + offset - x.offset;
  }
  //重载了[]运算符。
  reference operator[](difference_type i) { return *(*this + i); }
  
  //判断两个iterator是否相等。
  bool operator==(const iterator& x) const {
    return p == x.p && offset == x.offset;
  }
  bool operator!=(const iterator& x) const {
    return p != x.p || offset != x.offset;
  }
  bool operator<(iterator x) const {
    return p < x.p || (p == x.p && offset < x.offset);
  }
};
//const_iterator
struct __bit_const_iterator
  : public random_access_iterator<bool, ptrdiff_t>
{
  typedef bool                 reference;
  typedef bool                 const_reference;
  typedef const bool*          pointer;
  typedef __bit_const_iterator const_iterator;

  unsigned int* p;
  unsigned int offset;
  void bump_up() {
    if (offset++ == __WORD_BIT - 1) {
      offset = 0;
      ++p;
    }
  }
  void bump_down() {
    if (offset-- == 0) {
      offset = __WORD_BIT - 1;
      --p;
    }
  }

  __bit_const_iterator() : p(0), offset(0) {}
  __bit_const_iterator(unsigned int* x, unsigned int y) : p(x), offset(y) {}
  __bit_const_iterator(const __bit_iterator& x) : p(x.p), offset(x.offset) {}
  const_reference operator*() const {
    return __bit_reference(p, 1U << offset);
  }
  const_iterator& operator++() {
    bump_up();
    return *this;
  }
  const_iterator operator++(int) {
    const_iterator tmp = *this;
    bump_up();
    return tmp;
  }
  const_iterator& operator--() {
    bump_down();
    return *this;
  }
  const_iterator operator--(int) {
    const_iterator tmp = *this;
    bump_down();
    return tmp;
  }
  const_iterator& operator+=(difference_type i) {
    difference_type n = i + offset;
    p += n / __WORD_BIT;
    n = n % __WORD_BIT;
    if (n < 0) {
      offset = (unsigned int) n + __WORD_BIT;
      --p;
    } else
      offset = (unsigned int) n;
    return *this;
  }
  const_iterator& operator-=(difference_type i) {
    *this += -i;
    return *this;
  }
  const_iterator operator+(difference_type i) const {
    const_iterator tmp = *this;
    return tmp += i;
  }
  const_iterator operator-(difference_type i) const {
    const_iterator tmp = *this;
    return tmp -= i;
  }
  difference_type operator-(const_iterator x) const {
    return __WORD_BIT * (p - x.p) + offset - x.offset;
  }
  const_reference operator[](difference_type i) { 
    return *(*this + i); 
  }
  bool operator==(const const_iterator& x) const {
    return p == x.p && offset == x.offset;
  }
  bool operator!=(const const_iterator& x) const {
    return p != x.p || offset != x.offset;
  }
  bool operator<(const_iterator x) const {
    return p < x.p || (p == x.p && offset < x.offset);
  }
};

// The next few lines are confusing.  What we're doing is declaring a
//  partial specialization of vector<T, Alloc> if we have the necessary
//  compiler support.  Otherwise, we define a class bit_vector which uses
//  the default allocator.  In either case, we typedef "data_allocator" 
//  appropriately.

#if defined(__STL_CLASS_PARTIAL_SPECIALIZATION) && !defined(__STL_NEED_BOOL)
#define __SGI_STL_VECBOOL_TEMPLATE
#define __BVECTOR vector
#else
#undef __SGI_STL_VECBOOL_TEMPLATE
#define __BVECTOR bit_vector
#endif

#      ifdef __SGI_STL_VECBOOL_TEMPLATE
       __STL_END_NAMESPACE
#      include <stl_vector.h>
       __STL_BEGIN_NAMESPACE
template<class Alloc> class vector<bool, Alloc>
#      else /* __SGI_STL_VECBOOL_TEMPLATE */
class bit_vector
#      endif /* __SGI_STL_VECBOOL_TEMPLATE */
{
#      ifdef __SGI_STL_VECBOOL_TEMPLATE
  typedef simple_alloc<unsigned int, Alloc> data_allocator;//以int为单位的allocator
#      else /* __SGI_STL_VECBOOL_TEMPLATE */
  typedef simple_alloc<unsigned int, alloc> data_allocator;  
#      endif /* __SGI_STL_VECBOOL_TEMPLATE */
public:
  typedef bool value_type;
  typedef size_t size_type;
  typedef ptrdiff_t difference_type; 
  typedef __bit_reference reference;
  typedef bool const_reference;
  typedef __bit_reference* pointer;
  typedef const bool* const_pointer;

  typedef __bit_iterator                iterator;
  typedef __bit_const_iterator          const_iterator;

#ifdef __STL_CLASS_PARTIAL_SPECIALIZATION
  typedef reverse_iterator<const_iterator> const_reverse_iterator;
  typedef reverse_iterator<iterator> reverse_iterator;
#else /* __STL_CLASS_PARTIAL_SPECIALIZATION */
  typedef reverse_iterator<const_iterator, value_type, const_reference, 
                           difference_type> const_reverse_iterator;
  typedef reverse_iterator<iterator, value_type, reference, difference_type>
          reverse_iterator;
#endif /* __STL_CLASS_PARTIAL_SPECIALIZATION */

protected:
  iterator start;//起始iterator
  iterator finish;//终止iterator
  unsigned int* end_of_storage;//指向最后的int的下一个int
  unsigned int* bit_alloc(size_type n) {//申请包含n个位值的空间大小。
  	//由于整数相除会简单的抹掉小数点,不会4舍5入,因此这里通过n + __WORD_BIT - 1来保证获取的最终值可以容纳n个空间
    return data_allocator::allocate((n + __WORD_BIT - 1)/__WORD_BIT);
  }
  void deallocate() {//删掉存储空间。
    if (start.p)
      data_allocator::deallocate(start.p, end_of_storage - start.p);
  }
  void initialize(size_type n) {//初始化
    unsigned int* q = bit_alloc(n);//首先申请空间。
    //然后给各个指针赋值,将end_of_storage赋值为最后的那个int的下一个int。
    end_of_storage = q + (n + __WORD_BIT - 1)/__WORD_BIT;
    start = iterator(q, 0);
    finish = start + difference_type(n);
  }
  //在指定位置插入一个位值。
  void insert_aux(iterator position, bool x) {
    if (finish.p != end_of_storage) {
    	//如果当前vector还有空的位置,那么就将position后面的值全部向后赋值一格,然后将x复制到这个位置。
      copy_backward(position, finish, finish + 1);
      *position = x;
      ++finish;
    }
    else {
    	//如果当前vector没有空的位置,那么就将当前大小扩容。
      size_type len = size() ? 2 * size() : __WORD_BIT;
      unsigned int* q = bit_alloc(len);
      iterator i = copy(begin(), position, iterator(q, 0));//然后将当前的值拷贝到新的空间中
      *i++ = x;
      finish = copy(position, end(), i);
      deallocate();//删除掉当前的空间。
      //将指针指向新的空间。
      end_of_storage = q + (len + __WORD_BIT - 1)/__WORD_BIT;
      start = iterator(q, 0);
    }
  }

//各种范围插入方法。
#ifdef __STL_MEMBER_TEMPLATES
  template <class InputIterator>
  void initialize_range(InputIterator first, InputIterator last,
                        input_iterator_tag) {
    start = iterator();
    finish = iterator();
    end_of_storage = 0;
    for ( ; first != last; ++first) 
      push_back(*first);
  }

  template <class ForwardIterator>
  void initialize_range(ForwardIterator first, ForwardIterator last,
                        forward_iterator_tag) {
    size_type n = 0;
    distance(first, last, n);
    initialize(n);
    copy(first, last, start);
  }

  template <class InputIterator>
  void insert_range(iterator pos,
                    InputIterator first, InputIterator last,
                    input_iterator_tag) {
    for ( ; first != last; ++first) {
      pos = insert(pos, *first);
      ++pos;
    }
  }

//将【first,last)插入到position的位置。
  template <class ForwardIterator>
  void insert_range(iterator position,
                    ForwardIterator first, ForwardIterator last,
                    forward_iterator_tag) {
    if (first != last) {
      size_type n = 0;
      distance(first, last, n);//首先获取到first和last之间的元素的个数n
      if (capacity() - size() >= n) {//如果当前的剩余的存储空间>=n
        copy_backward(position, end(), finish + difference_type(n));//就将position开始的数据向后赋值n个位置。
        copy(first, last, position);//然后将【first,last)间的数据拷贝到空出来的位置。
        finish += difference_type(n);
      }
      else {//如果当前剩余的存储空间比n小。
      	//就先申请一个更大的存储空间。
        size_type len = size() + max(size(), n);
        unsigned int* q = bit_alloc(len);
        //将原来的值拷贝到新的空间中,先拷贝(begin,position)。
        iterator i = copy(begin(), position, iterator(q, 0));
				//然后继续拷贝,将【First,last)间的数据拷贝过去。
        i = copy(first, last, i);
        //最后拷贝(position,end)间的数据拷贝过去。
        finish = copy(position, end(), i);
        deallocate();//删掉老的存储空间。
        //更新指针,指向新的存储空间。        
        end_of_storage = q + (len + __WORD_BIT - 1)/__WORD_BIT;
        start = iterator(q, 0);
      }
    }
  }      

#endif /* __STL_MEMBER_TEMPLATES */

public:
  iterator begin() { return start; }
  const_iterator begin() const { return start; }
  iterator end() { return finish; }
  const_iterator end() const { return finish; }

  reverse_iterator rbegin() { return reverse_iterator(end()); }
  const_reverse_iterator rbegin() const { 
    return const_reverse_iterator(end()); 
  }
  reverse_iterator rend() { return reverse_iterator(begin()); }
  const_reverse_iterator rend() const { 
    return const_reverse_iterator(begin()); 
  }

//返回当前的存储的数目。
  size_type size() const { return size_type(end() - begin()); }
//返回最大的容量, 由于容量与内存有关,因此这里返回最大值。
  size_type max_size() const { return size_type(-1); }
//返回当前的容量。
  size_type capacity() const {
    return size_type(const_iterator(end_of_storage, 0) - begin());
  }
//返回是否为空。
  bool empty() const { return begin() == end(); }
//【】运算符。
  reference operator[](size_type n) {
    return *(begin() + difference_type(n));
  }
  const_reference operator[](size_type n) const {
    return *(begin() + difference_type(n));
  }
  __BVECTOR() : start(iterator()), finish(iterator()), end_of_storage(0) {}
  __BVECTOR(size_type n, bool value) {
    initialize(n);
    fill(start.p, end_of_storage, value ? ~0 : 0);
  }
  __BVECTOR(int n, bool value) {
    initialize(n);
    fill(start.p, end_of_storage, value ? ~0 : 0);
  }
  __BVECTOR(long n, bool value) {
    initialize(n);
    fill(start.p, end_of_storage, value ? ~0 : 0);
  }
  explicit __BVECTOR(size_type n) {
    initialize(n);
    fill(start.p, end_of_storage, 0);
  }
  __BVECTOR(const __BVECTOR& x) {
    initialize(x.size());
    copy(x.begin(), x.end(), start);
  }

#ifdef __STL_MEMBER_TEMPLATES
  template <class InputIterator>
  __BVECTOR(InputIterator first, InputIterator last) {
    initialize_range(first, last, iterator_category(first));
  }
#else /* __STL_MEMBER_TEMPLATES */
  __BVECTOR(const_iterator first, const_iterator last) {
    size_type n = 0;
    distance(first, last, n);
    initialize(n);
    copy(first, last, start);
  }
  __BVECTOR(const bool* first, const bool* last) {
    size_type n = 0;
    distance(first, last, n);
    initialize(n);
    copy(first, last, start);
  }
#endif /* __STL_MEMBER_TEMPLATES */

  ~__BVECTOR() { deallocate(); }
  //赋值构造函数。
  __BVECTOR& operator=(const __BVECTOR& x) {
    if (&x == this) return *this;
    if (x.size() > capacity()) {//如果当前容量小于x的容量,就把本地容量扩容。
      deallocate();//先释放当前空间。
      initialize(x.size());//再用x的容量为基础申请新的空间
    }
    //将x的数据拷贝到当前的空间即可。 
    copy(x.begin(), x.end(), begin());
    finish = begin() + difference_type(x.size());
    return *this;
  }
  //将vector的容量扩充至n,如果当前容量大于n了,什么也不做。
  void reserve(size_type n) {
    if (capacity() < n) {//如果当前容量小于n,就申请个更大的内存。
      unsigned int* q = bit_alloc(n);
      finish = copy(begin(), end(), iterator(q, 0));//然后将原有的数据拷贝过来。
      deallocate();//释放掉老的内存。
      start = iterator(q, 0);//更新指针。
      end_of_storage = q + (n + __WORD_BIT - 1)/__WORD_BIT;
    }
  }
  //返回第一个和最后一个元素。
  reference front() { return *begin(); }
  const_reference front() const { return *begin(); }
  reference back() { return *(end() - 1); }
  const_reference back() const { return *(end() - 1); }
  //将x插入到vector的尾部。  
  void push_back(bool x) {
    if (finish.p != end_of_storage)
      *finish++ = x;
    else
      insert_aux(end(), x);
  }
  //交换
  void swap(__BVECTOR& x) {
    __STD::swap(start, x.start);
    __STD::swap(finish, x.finish);
    __STD::swap(end_of_storage, x.end_of_storage);
  }
  //插入元素x到位置posi处。
  iterator insert(iterator position, bool x = bool()) {
    difference_type n = position - begin();
    if (finish.p != end_of_storage && position == end())
      *finish++ = x;//如果插入的位置是最后而且还有空位,直接更新即可。
    else
      insert_aux(position, x);//否则调用插入方法。
    return begin() + n;
  }

#ifdef __STL_MEMBER_TEMPLATES
  template <class InputIterator> void insert(iterator position,
                                             InputIterator first,
                                             InputIterator last) {
    insert_range(position, first, last, iterator_category(first));
  }
#else /* __STL_MEMBER_TEMPLATES */
  void insert(iterator position, const_iterator first, 
              const_iterator last) {
    if (first == last) return;
    size_type n = 0;
    distance(first, last, n);
    if (capacity() - size() >= n) {
      copy_backward(position, end(), finish + n);
      copy(first, last, position);
      finish += n;
    }
    else {
      size_type len = size() + max(size(), n);
      unsigned int* q = bit_alloc(len);
      iterator i = copy(begin(), position, iterator(q, 0));
      i = copy(first, last, i);
      finish = copy(position, end(), i);
      deallocate();
      end_of_storage = q + (len + __WORD_BIT - 1)/__WORD_BIT;
      start = iterator(q, 0);
    }
  }

//插入元素【first,last)到position。
  void insert(iterator position, const bool* first, const bool* last) {
    if (first == last) return;
    size_type n = 0;
    distance(first, last, n);
    if (capacity() - size() >= n) {
      copy_backward(position, end(), finish + n);
      copy(first, last, position);
      finish += n;
    }
    else {
      size_type len = size() + max(size(), n);
      unsigned int* q = bit_alloc(len);
      iterator i = copy(begin(), position, iterator(q, 0));
      i = copy(first, last, i);
      finish = copy(position, end(), i);
      deallocate();
      end_of_storage = q + (len + __WORD_BIT - 1)/__WORD_BIT;
      start = iterator(q, 0);
    }
  }
#endif /* __STL_MEMBER_TEMPLATES */
  
  //插入n个元素x。
  void insert(iterator position, size_type n, bool x) {
    if (n == 0) return;//如果要插入的数目为0,直接返回。
    if (capacity() - size() >= n) {//如果剩余的位置大于n,
    	//就将现有的数据向后拷贝,空出位置来。
      copy_backward(position, end(), finish + difference_type(n));
			//将x复制到空出的位置上。
      fill(position, position + difference_type(n), x);
      finish += difference_type(n);
    }
    else {//如果剩余的位置不够了。
    	//申请一块更大的空间
      size_type len = size() + max(size(), n);
      unsigned int* q = bit_alloc(len);
      //将【begin,position)的数据拷贝到新的空间中
      iterator i = copy(begin(), position, iterator(q, 0));
      fill_n(i, n, x);	//然后将x赋值n个,放到新的空间中
      //最后将【position,end)的数据拷贝到新的空间中。
      finish = copy(position, end(), i + difference_type(n));
      deallocate();//删除老的空间。
      //更新指针,指向新的空间。
      end_of_storage = q + (len + __WORD_BIT - 1)/__WORD_BIT;
      start = iterator(q, 0);
    }
  }

//插入方法。
  void insert(iterator pos, int n, bool x)  { insert(pos, (size_type)n, x); }
  void insert(iterator pos, long n, bool x) { insert(pos, (size_type)n, x); }

	//弹出一个数据,这里直接让finish指针递减即可。
  void pop_back() { --finish; }
	
	//删除position的位置。采取的方法是向前拷贝的方法。
  iterator erase(iterator position) {
    if (position + 1 != end())
      copy(position + 1, end(), position);
    --finish;
    return position;
  }
  //删除【first,last)间的数据,这里采用的是拷贝方法,将【last,end)间的数据向前拷贝。
  //个人感觉这里少了一些步骤。至少finish指向没有处理。
  iterator erase(iterator first, iterator last) {
    finish = copy(last, end(), first);
    return first;
  }
  //重新设置大小。
  void resize(size_type new_size, bool x = bool()) {
    if (new_size < size())  //如果新的大小小于当前大小,那么就从后面开始删除元素
      erase(begin() + difference_type(new_size), end());
    else
      insert(end(), new_size - size(), x);//如果新的大小大于当前大小,就在后面插入元素,补全个数。
  }
  //清除所有的元素。
  void clear() { erase(begin(), end()); }
};

#ifdef __SGI_STL_VECBOOL_TEMPLATE

typedef vector<bool, alloc> bit_vector;

#else /* __SGI_STL_VECBOOL_TEMPLATE */

//判断两个bvector是否相等,先判断数目,然后判断每个元素
inline bool operator==(const bit_vector& x, const bit_vector& y) {
  return x.size() == y.size() && equal(x.begin(), x.end(), y.begin());
}

inline bool operator<(const bit_vector& x, const bit_vector& y) {
  return lexicographical_compare(x.begin(), x.end(), y.begin(), y.end());
}

#endif /* __SGI_STL_VECBOOL_TEMPLATE */

 

发表评论

14 + 8 =

此站点使用Akismet来减少垃圾评论。了解我们如何处理您的评论数据