Utopia::Itertools::zip< Containers > Class Template Reference

A range defined by instances of ZipIterator. More...

#include <zip.hh>

Public Member Functions
auto	begin ()
	make Zipiterator containing the begin iterators of the containers 'zip' refers to
auto	end ()
	make Zipiterator containing the end iterators of the containers 'zip' refers to
auto	cbegin ()
	make Zipiterator containing the const begin iterators of the containers 'zip' refers to
auto	cend ()
	make Zipiterator containing the const end iterators of the containers 'zip' refers to
auto	rbegin ()
	make Zipiterator containing the reverse begin iterators of the containers 'zip' refers to
auto	rend ()
	make Zipiterator containing the reverse end iterators of the containers 'zip' refers to
	zip (const zip &other)=delete
	Construct a new zip object.
zip &	operator= (const zip &other)=delete
	deleted copy assignment
zip &	operator= (zip &&other)=default
	assign zip object
	zip (zip &&other)=default
	Construct a new zip object.
	~zip ()=default
	Destroy the range.
	zip (Containers &... conts)
	Instantiate a new zip range.

Protected Types
using	Tuple = std::tuple< std::reference_wrapper< Containers >... >

Protected Attributes
Tuple	_containers

Detailed Description

template<typename... Containers>
class Utopia::Itertools::zip< Containers >

A range defined by instances of ZipIterator.

The range itself only references the containers it is constructed from. The containers must exist throughout the life time of this range.

Template Parameters

Containers

Types of containers iterated over by ZipIterator

Member Typedef Documentation

Tuple

template<typename... Containers>

using Utopia::Itertools::zip< Containers >::Tuple = std::tuple<std::reference_wrapper<Containers>...>

protected

Constructor & Destructor Documentation

zip() [1/3]

template<typename... Containers>

Utopia::Itertools::zip< Containers >::zip ( const zip< Containers > &  other )

delete

Construct a new zip object.

Parameters

other

zip() [2/3]

template<typename... Containers>

Utopia::Itertools::zip< Containers >::zip ( zip< Containers > &&  other )

default

Construct a new zip object.

Parameters

other

~zip()

template<typename... Containers>

Utopia::Itertools::zip< Containers >::~zip ( )

default

Destroy the range.

zip() [3/3]

template<typename... Containers>

Utopia::Itertools::zip< Containers >::zip ( Containers &...  conts )

inline

Instantiate a new zip range.

Parameters

conts

The pack of containers to create the range from

                              : _containers(conts...)
    {
    }

Member Function Documentation

begin()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::begin ( )

inline

make Zipiterator containing the begin iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().begin(); }));
    }

cbegin()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::cbegin ( )

inline

make Zipiterator containing the const begin iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().cbegin(); }));
    }

cend()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::cend ( )

inline

make Zipiterator containing the const end iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().cend(); }));
    }

end()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::end ( )

inline

make Zipiterator containing the end iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().end(); }));
    }

operator=() [1/2]

template<typename... Containers>

zip & Utopia::Itertools::zip< Containers >::operator= ( const zip< Containers > &  other )

delete

deleted copy assignment

Parameters

other

Returns

zip&

operator=() [2/2]

template<typename... Containers>

zip & Utopia::Itertools::zip< Containers >::operator= ( zip< Containers > &&  other )

default

assign zip object

Parameters

other

Returns

zip&

rbegin()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::rbegin ( )

inline

make Zipiterator containing the reverse begin iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().rbegin(); }));
    }

rend()

template<typename... Containers>

auto Utopia::Itertools::zip< Containers >::rend ( )

inline

make Zipiterator containing the reverse end iterators of the containers 'zip' refers to

Returns

auto

    {
        return ZipIterator(boost::hana::transform(
            _containers, [](auto& cont) { return cont.get().rend(); }));
    }

Member Data Documentation

_containers

template<typename... Containers>

Tuple Utopia::Itertools::zip< Containers >::_containers

protected

---

The documentation for this class was generated from the following file:

• include/utopia/core/zip.hh