C++ of the Day #28 - random_number_iterator 구현

원래는 지난번 글로 Boost::Iterator 라이브러리 얘기를 마치려고 했는데 읽던 책에 random number generator에 관한 내용이 나오네요. ((The C++ Standard Library Extensions: A Tutorial and Reference, Pete Becker, Addison-Wesley Professional, 2006))

이 내용을 이용하여 random_number_iterator를 만들어 보았습니다. random number generator는 tr1에 있으나 같은 내용이 boost에도 있으므로 boost 라이브러리를 사용하였습니다.

먼저 random number generator는 여러가지 random number 생성을 해주는 engine들과 이들 engine을 결합하여 다른 엔진을 만들어 주는 compound engine, 그리고 이를 사용하는 각종 distribution 및 engine과 distribution을 결합해 주는 variate_generator등으로 구성되어 있습니다. 또한 기본 engine들에 적당한 default 값을 사용한 predefine된 타입도 제공합니다.

boost::mt19937 rng;
boost::uniform_int<> six(1,6);
boost::variate_generator<boost::mt19937&, boost::uniform_int<> > die(rng, six);

int x = die();

예를 들어 위의 코드에서 mt19937은 mersenne_twister라는 engine을 사용하여 predefined된 타입입니다. ((Boost Random Number Library 문서에서 가져왔습니다.)) 그리고 uniform_int는 어떤 random number의 sequence를 특정 범위안의 uniformly distributed random sequence로 변경해 주는 클래스이고 마지막으로 variate_generator는 engine과 distribution을 결합시키기 위해 사용되었습니다.

이렇게 해서 생성된 die 객체는 function call operator를 가지고 있어 마지막 라인과 같이 호출할 때마다 새로운 1~6의 범위안에서 uniformly distributed된 random number를 리턴합니다. 즉, 정육면체 주사위를 simulate할 수 있는 객체죠.

이 function call operator를 사용하여 특정 container의 값을 채우기 위한 방법에는 다음과 같은 것들이 있습니다.

for (int i = 0; i < vi.size(); ++i) vi[i] = die();

std::generate(vi.begin(), vi.end(), die);

std::generate_n(vi.begin(), vi.size(), die);

하지만 이번 글에서 만들어 볼 iterator 클래스를 사용하면 다음과 같이 사용이 가능합니다.

random_number_iterator<??> first(die, N);
random_number_iterator<??> last(die);
copy(first, last, vi.begin());

여기서 N은 이 iterator가 만들어 낼 random number의 갯수입니다. 그리고 ?? 부분에 대해서는 뒤에서 알아 보겠습니다.

그럼 Boost::Iterator에 대한 설명을 생략하고 바로 코드를 보겠습니다.

template <class Gen>
class random_number_iterator
  : public boost::iterator_facade<
      random_number_iterator<gen>,
      typename Gen::result_type const,
      forward_traversal_tag
    >
{
  typedef typename Gen::result_type result_type;
public:
  explicit random_number_iterator(Gen& gen, int cnt = 0)
      : gen_(gen), cnt_(cnt) {
    if (cnt != 0) val_ = gen_();
  }

private:
  friend class boost::iterator_core_access;

  void increment() { --cnt_; val_ = gen_(); }

  bool equal(random_number_iterator const& other) const
  {
    return cnt_ == other.cnt_;
  }

  result_type const& dereference() const { return val_; }

private:
  Gen& gen_;
  int cnt_;
  result_type val_;
};

cnt_ 멤버는 default로 0으로 셋팅되어 iterator의 end()를 나타내게 됩니다. 0이 아닌 값은 end()가 아니며 increment() 호출시마다 1씩 감소하여 결국 end()가 되도록 만들었습니다. 그리고 이 increment()시에 gen_()을 호출하여 random number를 val_에다 저장하도록 하였습니다.

여기서 만약 val_ 멤버 변수를 없애기 위해 dereference()마다 gen_()을 호출하였다면 아래와 같은 코드에서 i와 j는 서로 다른 값을 가지는 문제가 생기게 됩니다.

i = *iter;
j = *iter;

다음으로 주의할 점은 생성자에서 cnt_가 0이면 val_의 초기값을 셋팅하지 않는다는 것입니다. 물론 end()를 dereference하는 것은 금지되어 있어 사용자가 호출하진 않겠지만 만약 여기서 gen_()을 호출한다면 reference로 가지고 있는 gen_의 상태가 변하게 되고 역시 이 reference를 가지고 있을 다른 iterator의 상태에 영향을 주기 때문입니다.

그럼 이제 이 iterator를 사용하여 앞에서 살펴본 ?? 를 가지고 있던 코드를 다시 작성해 보겠습니다.

random_number_iterator<variate_generator<boost::mt19937&, boost::uniform_int<> > > first(die, N);
random_number_iterator<variate_generator<boost::mt19937&, boost::uniform_int<> > > last(die);
copy(first, last, vi.begin());

너무 길군요. :-| 그럼 이를 좀 간단히 해줄 helper function을 만들어 보겠습니다.

template <class Gen>
random_number_iterator<gen> make_random_number_iterator(Gen& gen, int cnt = 0)
{
return random_number_iterator<gen>(gen, cnt);
}

이제 이 function을 사용하여 다음과 같이 코드를 작성할 수 있습니다.

copy(
make_random_number_iterator(die, N),
make_random_number_iterator(die),
vi.begin());

이제 실제 타입이 아무리 길어도 위의 함수를 사용하여 비교적 간단히 algorithm들을 사용할 수 있게 되었습니다.

참고로 C++에 auto 키워드가 추가되고 나면 다음과 같이 작성할 수 있게 됩니다.

auto first = make_random_number_iterator(die, N),
auto last = make_random_number_iterator(die),
copy(first, last, vi.begin());

이번 글에서는 Boost::Iterator 시리즈의 복습 삼아 random_number_iterator를 작성해 보았습니다. 해보면서 느끼는 건데 iterator 만들기 정말 쉬워졌군요. :-)