C++ of the Day #26 - Boost::Iterator 라이브러리 사용하기 #2

자. 그럼 지난 번 글에 이어 boost::iterator 라이브러리를 사용하여 sorted_view의 iterator를 구현해 보겠습니다.

먼저 sorted_view의 내부 구현에는 vector가 사용되었으므로 sorted_view의 iterator도 random access traversal iterator로 구현하겠습니다. 한가지 주의할 점은 sorted_view는 const_iterator만 제공하고 iterator는 제공하지 않는다는 점입니다. 이유는 sorting된 컨테이너의 iterator를 가지고 값을 변경하면 그 컨테이너는 더이상 sorting되지 않은 상태가 될 수 있기 때문입니다. ((std::set이나 std::map의 키가 const 타입인 이유와 같습니다.))

이 두 가지를 염두에 두고 우리가 사용할 boost::iterator_facade에 대해서 살펴보죠. 먼저 이름에서 Facade design pattern을 사용했다는 것을 알 수 있습니다. 즉, 여러 subsystem들의 복잡성을 좀 더 사용하기 쉬운 하나의 인터페이스로 감추어 주는 역할이라는 것이죠.

iterator_facade 클래스의 선언을 보면 다음과 같습니다.

template <
  class Derived
  , class Value
  , class CategoryOrTraversal
  , class Reference  = Value&
  , class Difference = ptrdiff_t
>
class iterator_facade {
...

여기서 Derived는 iterator_facade를 상속받는 iterator 클래스 자신입니다. ((즉, iterator_facade는 CRTP를 사용합니다.)) Value는 iterator가 사용할 value_type이고 CategoryOrTraversal은 이름 그대로 iterator가 지원하기를 원하는 category를 지정합니다. 나머지 Reference와 Difference는 이름에서 그 용도를 알 수 있으며 대개의 경우 default 값인 Value&와 ptrdiff_t를 그대로 사용할 수 있습니다.

따라서 우리가 만들 sorted_view의 iterator는 다음과 같이 시작하며 sorted_view 클래스의 nested class로 만들어 집니다.

class sv_iterator
  : public boost::iterator_facade<
    sv_iterator,
    C_value_type const,
    boost::random_access_traversal_tag
    >
{
  typedef typename std::vector<c_iter>::const_iterator S_const_iter;
public:
  explicit sv_iterator(S_const_iter p)
    : curr_(p) {}
private:
  S_const_iter curr_;
};

먼저 sv_iterator가 내부적으로 사용할 iterator 타입을 S_const_iter라는 이름으로 typedef 하였습니다. 여기서 C_iter나 C_value_type과 같은 타입은 sorted_view 클래스에 있는 typedef들입니다. 여기서 눈여겨 볼 부분은 Value 인자로 C_value_type **const**가 사용되었다는 점입니다. 따라서 이 iterator는 value를 변경할 수 없는 const_iterator가 됩니다.

sv_iterator은 S_const_iter 타입으로 curr_라는 멤버 변수를 가지고 있으며 생성자는 단순히 이 값을 받아 채워주는 역할을 합니다.

그럼 이제 중요한 iterator들의 여러 기능들을 구현할 차례입니다. 우리가 구현하고자 하는 random access traversal iterator는 많은 요구 사항들이 있습니다. 그 중 몇 가지만 예로 들면 다음과 같습니다.

• *i
• (*i).m
• i->m
• i == j
• ++i
• i + n
• i < j


• ...

이렇게 많은 원래의 요구 사항들을 다 구현하는 대신 boost::facade는 다음 중 해당하는 iterator의 category에 꼭 필요한 함수만을 구현할 것을 요구합니다. facade라는이름이 붙은 이유입니다.

• dereference
• equal
• increment
• decrement
• advance
• distance_to

이름만 봐도 대충 어떤 일을 하는 함수인지 알 수 있죠? 우리의 sv_iterator는 random access traversal iterator이기 때문에 이 함수들을 모두 구현해햐 하지만 만약 구현하는 iterator가 forward traversal iterator라면 이 중 1, 2, 3번만 구현하면 됩니다. 하지만 이 함수들을 구현하려고 하면 한가지 문제가 생깁니다. 만약 이 함수들을 모두 public으로 선언한다면 iterator의 사용자들이 이 함수들을 직접 부르는 것이 가능해진다는 점이죠. 그렇다고 private으로 하자니 이번엔 iterator_facade에서 이 함수들을 사용할 수 없게 됩니다. 따라서 이 두마리 토끼를 모두 잡기 위해 다음과 같은 back door를 설치합니다.

private:
  friend class boost::iterator_core_access;

잠시 생각해 보시면 이 하나의 클래스에 권한을 주어 어떻게 여러개의 함수를 사용할 수 있게 하는지 알 수 있습니다. ((iterator_core_access 클래스는 대략 다음과 같은 구조를 가집니다.

class iterator_core_access
{
public:
  template <class Facade>
  static typename Facade::reference dereference(Facade const& f)
  {
    return f.dereference();
  }
};

간단히 설명하자면 iterator_core_access는 sv_iterator의 friend이므로 f.dereference()와 같이 sv_iterator의 private 함수를 호출할 수 있게 되며 iterator_core_access의 dereference는 public 함수이므로 iterator_facade에서도 호출할 수 있게 되어 결국 iterator_facade에서 원하는 sv_iterator의 private 함수를 호출할 수 있게 되는 것입니다. 실제 코드에선 이 iterator_core_access의 생성자는 private으로 되어 있고 iterator_facade를 friend로 지정해 iterator_facade에서만 이 클래스를 생성할 수 있도록 추가 안전 장치를 가지고 있습니다.)) 그럼 이제 위의 함수들을 하나씩 구현해 볼까요? 우린 이미 vector의 iterator 타입을 가지고 있기 때문에 모든 함수를 다음과 같이 쉽게 vector의 iterator에게 작업을 forwarding하여 구현할 수 있습니다.

void increment() { ++curr_; }
void decrement() { --curr_; }

void advance(typename sv_iterator::difference_type n) {
  std::advance(curr_, n);
}

typename sv_iterator::difference_type distance_to(sv_iterator const& to) const {
  return std::distance(curr_, to.curr_);
}

bool equal(sv_iterator const& other) const
{
  return curr_ == other.curr_;
}

C_value_type const& dereference() const {
  return **curr_;
}

여기서 vector의 iterator로 그냥 forwarding하여 구현하지 않은 함수는 deference함수 하나입니다. 왜냐하면 우리는 sv_iterator를 가지고 바로 실제 컨테이너의 element를 dereference하기를 원하기 때문입니다. 따라서 첫번째로 C_iter를 얻고 이를 가지고 다시 C_value_type을 얻기 위해 **과 같이 dereference operator를 두 번 사용하였습니다. 그럼 이 sv_iterator 클래스를 사용하여 sorted_view에 begin(), end()함수를 만들어 보겠습니다.

typedef sv_iterator const_iterator;

const_iterator begin() const {
  return sv_iterator(data_.begin());
}
const_iterator end() const {
  return sv_iterator(data_.end());
}

간단하죠? :-) 전체 소스 코드는 Downloads 부분에 있습니다. 다음 시간에는 이러한 iterator 구현을 좀 더 간단히 할 수 있는 방법에 대해 알아봅니다. 지금도 충분히 간단한 것 같은데 말이죠. ;-)

Downloads

iterator_ex.zip