From 87d82527b169c15ad2cfcee89488ce96693daa90 Mon Sep 17 00:00:00 2001 From: Edward Diener Date: Mon, 24 Aug 2015 07:18:03 -0400 Subject: [PATCH] Updated zip iterator abstract adds information about the iterator 'tuple'. --- doc/zip_iterator_abstract.rst | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/doc/zip_iterator_abstract.rst b/doc/zip_iterator_abstract.rst index 2f4aecf..524c2b1 100644 --- a/doc/zip_iterator_abstract.rst +++ b/doc/zip_iterator_abstract.rst @@ -8,3 +8,13 @@ iterator is constructed from a tuple of iterators. Moving the zip iterator moves all the iterators in parallel. Dereferencing the zip iterator returns a tuple that contains the results of dereferencing the individual iterators. + +The tuple of iterators is now implemented in terms of a Boost fusion sequence. +Because of this the 'tuple' may be any Boost fusion sequence and, for backwards +compatibility through a Boost fusion sequence adapter, a Boost tuple. Because the +'tuple' may be any boost::fusion sequence the 'tuple' may also be any type for which a +Boost fusion adapter exists. This includes, among others, a std::tuple and a std::pair. +Just remember to include the appropriate Boost fusion adapter header files for these +other Boost fusion adapters. The zip_iterator header file already includes the +Boost fusion adapter header file for Boost tuple, so you need not include it yourself +to use a Boost tuple as your 'tuple'.