迭代器实战——数组分块工具

迭代器简介

c++中经常会用到这样的写法:

std::vector<int> vec; // 假设其中已经有数据
for (auto it = vec.begin(); it != vec.end(); ++it) {
  cout << "value is:" << *it << endl;
}

上面代码中,it即是迭代器,通过迭代器自增可以遍历vector容器,而通过解引用(*)可以访问当前迭代器指向的数据。这样看,迭代器有点类似于数组的指针。

而range-based循环实际上也是依赖迭代器:

for (auto value : vec) {
  // ...
}

这种写法实际上等同于上面的显示使用迭代器。

那么,如何实现自己的迭代器呢?下面通过一个真实的例子一步步实现。

案例描述

假设我们有一个批量接口,每次只能处理100个id。函数签名如下:

void HandleIds(const vector<int> &ids);

现在我们有1万条id需要查询,就要分100次进行查询。那么我们首先要将其分成100组。当然这并不困难,但作为一名优秀的程序员,绝不能容忍每次都这样的重复性工作。于是我们希望做一个足够好用的工具,它可以这样使用:

std::vector<int> all_ids; // 假设其中已经有数据
for (const auto &chunk : ChunkSpliter(all_ids, 100)) {
    HandleIds(chunk); // chunk中包含100个id
}

需求分析

分析一下上述效果,我们发现:

  1. ChunkSpliter是一个类,构造函数包含两个参数
  2. ChunkSpliter的实例是可迭代对象
  3. 对迭代器解引用,可以得到std::vector<int>对象

对于第1点,只需定义一个ChunkSpliter类,并显示声明构造函数即可。

对于第2点,如何写一个可迭代对象?其实只要包含begin()和end()方法,返回迭代器即可。但这里要返回什么迭代器呢?能否使用vector本身的迭代器?

看到第3点,我们就知道,必须自定义迭代器,并重载解引用运算符 operator*(),这样才能实现迭代器解引用后得到我们希望的std::vector<int>对象,即一个包含100个id的分片。

开始开发

ChunkSpliter类与构造函数

首先我们声明ChunkSpliter类,并声明构造函数:

class ChunkSpliter {
public:
    explicit ChunkSpliter(const std::vector<int> &container, const uint32_t &chunk_size = 100)
        : container_(container), chunk_size_(chunk_size) {}
private:
    const std::vector<int>& container_;
    int chunk_size_;
};

在构造函数中,我们将传入的container和chunk_size存储到了类的成员变量中,以便后续在迭代器中使用。

开发迭代器

如果将一个类作为迭代器,需要重载下面这些运算符

  • 自增 ++
  • 等于/不等 == !=
  • 解引用 *

对于我们这个需求,自增需要每次跳过100个数据,解引用需要生成一个std::vector<int>对象。

另外,我们也需要保存原始的数组,以便解引用时生成它的一个切片。

于是我们声明如下:

class ChunkIterator {
public:
    explicit ChunkIterator(const std::vector<int> &container, int index, int chunk_size) 
      : container_(container), index_(index), chunk_size_(chunk_size) {}
      
    bool operator==(const ChunkIterator& other) const { return index_ == other.index_;}
    bool operator!=(const ChunkIterator& other) const { return index_ != other.index_;}
    ChunkIterator& operator++();
    std::vector<int> operator*();
    
private:
    const std::vector<int>& container_;
    int index_;
    int chunk_size_;
};

其中,++ 和 * 运算符和没有定义,我们在类外定义:

// 重载自增运算符 ++
ChunkIterator& ChunkIterator::operator++() {
  index_ += chunk_size_;
  if (index_ > container_.size()) {
    index_ = container_.size();
  }
  return *this;
}

// 重载解引用运算符 *
std::vector<int> ChunkIterator::operator*() {
  std::vector<int> chunk;
  for (int i=index_; i<index_+100 && i <container_.size(); i++) {
    chunk.push_back(container_[i]);
  }
  return chunk;
}

最后,为了上ChunkSpliter实例能成为可迭代对象,我们需要声明begin() 和 end()方法,返回ChunkIterator类型的迭代器:

class ChunkIterator {
// ...
public:
    ChunkIterator begin() {return ChunkIterator(container_, 0, chunk_size_);}
  ChunkIterator end() {return ChunkIterator(container_, container_.size(), chunk_size_);}
};

使用

好了,我们的代码已经完成了,让我们试试效果吧:

int main() {
  std::vector<int> ids;
  for (int i = 0; i<1000; i++) {
    ids.push_back(i);
  }
  for (auto chunk : ChunkSpliter(ids, 100)) {
    for (auto v : chunk) {
      cout << v << " ";
    }
    cout << endl;
  }
}

进阶

为了进一步提高我们工具的泛用性,让它不局限于std::vector<int>这一种类型,我们可以使用模板。聪明的读者,试一下如何做到吧。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 194,242评论 5 459
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 81,769评论 2 371
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 141,484评论 0 319
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,133评论 1 263
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,007评论 4 355
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,080评论 1 272
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,496评论 3 381
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,190评论 0 253
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,464评论 1 290
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,549评论 2 309
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,330评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,205评论 3 312
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,567评论 3 298
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 28,889评论 0 17
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,160评论 1 250
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,475评论 2 341
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,650评论 2 335

推荐阅读更多精彩内容