C++ - 重载迭代器所需的运算符

Question

我正在尝试在允许读取特定文件格式的库上创建迭代器。

从文档中，要读取文件内容，您需要执行以下操作：

CKMCFile database;

if (!database.OpenForListing(path)) {
  std::cerr << "ERROR: unable to open " << path << std::endl;
}

CKMCFileInfo info;
database.Info(info);

CKmerAPI kmer(info.kmer_length);

uint32 cnt;
std::vector<uint64_t> data;
std::vector<uint64> ulong_kmer;
data.reserve(info.total_kmers);

while (database.ReadNextKmer(kmer, cnt)) {
  kmer.to_long(ulong_kmer);
  data.push_back(ulong_kmer[0]);
}

现在，我从这门课开始wrapper：

class FileWrapper {
  CKMCFile database;
  CKMCFileInfo info;
  Iterator _end;

  public:
    explicit FileWrapper(const std::string &path) {
      if (!database.OpenForListing(path)) {
        std::cout << "ERROR: unable to open " << path << std::endl;
      }

      database.Info(info);
    }

    Iterator begin() {
      Iterator it;
      it.database = &database;
      it.total = 0;

      uint32_t cnt;
      std::vector<uint64_t> ulong_kmer;

      CKmerAPI tmp(info.kmer_length);
      database.ReadNextKmer(tmp, cnt);
      tmp.to_long(ulong_kmer);

      return it;
    }
    
    Iterator end() const { return _end; }
    uint64_t size() { return info.total_kmers; }
};

然后，这是Iterator 类：

class Iterator {
    friend class FileWrapper;

    CKMCFileInfo info;
    CKMCFile *database;
    uint64_t kmer, total;
    
    public:
      Iterator &operator++() {
        ++total;

        uint32_t cnt;
        std::vector<uint64_t> ulong_kmer;

        CKmerAPI tmp(info.kmer_length);
        database->ReadNextKmer(tmp, cnt);
        tmp.to_long(ulong_kmer);

        return *this;
      }

      bool operator<(const Iterator &rhs) const { return total < rhs.total; }
      uint64_t operator*() const { return kmer; }
  };

但是，在某些测试中，我不能将for loop 用于for (auto it = begin(); it != end(); ++i) { ... } 或begin() + size() 之类的东西。我怎样才能正确地超载这两个操作员？ opeartor!= 和 operato+

Answer 1

在此之前你必须考虑两件主要的事情：

1. 所有权。目前，您必须确保您的FileWrapper 至少与通过调用begin() 从它返回的任何Iterator 一样长（因为您的Iterators 存储指向FileWrapper 对象拥有的数据的指针）。如果不能保证，不妨考虑使用unique_ptrs 或shared_ptrs
2. 迭代器类别。正如 cmets 中所讨论的，您的数据库似乎要求您使用“input iterators”。它们只能加一（不提供operator+(int)）并取消引用。事实上，迭代器begin() + 10 会是什么样子？如果这应该推进您的文件指针，那么您不能将结尾定义为 begin() + size()，因为那样只会跳过文件。
3. 表示。终结迭代器应该是什么样的？一个简单的选择可能是用database == nullptr 表示结尾。在这种情况下，operator!= 可能如下所示：

bool is_end() const { return database == nullptr; }

bool operator==(const Iterator& other) const {
  if(is_end()) return other.is_end();
  if(other.is_end()) return false;
  return (database == other.database) && (total == other.total);
}

bool operator!=(const Iterator& other) const { return !operator==(other); }

现在，您需要确保所有终端迭代器都具有database == nullptr 的代码，并且每当非终端迭代器通过应用operator++() 变为终端迭代器时，您需要设置database = nullptr和total = 0（或其他东西）。

最后的注释：您的Iterators 在构造之后和分配database 成员之前可能处于不一致的状态。为 Iterator 声明一个适当的构造函数来初始化其成员是谨慎的。

编辑：here 的集成建议