iterator_range.h

Go to the documentation of this file.

/** @file
 *  @author Bram de Greve (bramz@users.sourceforge.net)
 *  @author Tom De Muer (tomdemuer@users.sourceforge.net)
 *
 *  *** BEGIN LICENSE INFORMATION ***
 *  
 *  The contents of this file are subject to the Common Public Attribution License 
 *  Version 1.0 (the "License"); you may not use this file except in compliance with 
 *  the License. You may obtain a copy of the License at 
 *  http://lass.sourceforge.net/cpal-license. The License is based on the 
 *  Mozilla Public License Version 1.1 but Sections 14 and 15 have been added to cover 
 *  use of software over a computer network and provide for limited attribution for 
 *  the Original Developer. In addition, Exhibit A has been modified to be consistent 
 *  with Exhibit B.
 *  
 *  Software distributed under the License is distributed on an "AS IS" basis, WITHOUT 
 *  WARRANTY OF ANY KIND, either express or implied. See the License for the specific 
 *  language governing rights and limitations under the License.
 *  
 *  The Original Code is LASS - Library of Assembled Shared Sources.
 *  
 *  The Initial Developer of the Original Code is Bram de Greve and Tom De Muer.
 *  The Original Developer is the Initial Developer.
 *  
 *  All portions of the code written by the Initial Developer are:
 *  Copyright (C) 2004-2007 the Initial Developer.
 *  All Rights Reserved.
 *  
 *  Contributor(s):
 *
 *  Alternatively, the contents of this file may be used under the terms of the 
 *  GNU General Public License Version 2 or later (the GPL), in which case the 
 *  provisions of GPL are applicable instead of those above.  If you wish to allow use
 *  of your version of this file only under the terms of the GPL and not to allow 
 *  others to use your version of this file under the CPAL, indicate your decision by 
 *  deleting the provisions above and replace them with the notice and other 
 *  provisions required by the GPL License. If you do not delete the provisions above,
 *  a recipient may use your version of this file under either the CPAL or the GPL.
 *  
 *  *** END LICENSE INFORMATION ***
 */

/** @class lass::stde::iterator_range
 *  @brief iterator range.
 *  @author Bram de Greve [Bramz]
 */

#ifndef LASS_GUARDIAN_OF_INCLUSION_STDE_ITERATOR_RANGE_H
#define LASS_GUARDIAN_OF_INCLUSION_STDE_ITERATOR_RANGE_H

#include "stde_common.h"
#include "../num/safe_bool.h"

namespace lass
{
namespace stde
{

template <typename iterator_type>
class iterator_range
{
public:

    typedef iterator_type iterator;
    typedef typename std::iterator_traits<iterator_type>::pointer pointer;
    typedef typename std::iterator_traits<iterator_type>::reference reference;
    typedef typename std::iterator_traits<iterator_type>::difference_type difference_type;
    typedef typename std::iterator_traits<iterator_type>::iterator_category iterator_category;

    iterator_range();
    iterator_range(iterator first, iterator last);

    iterator begin() const;
    iterator end() const;

    iterator operator->() const;
    reference operator*() const;
    reference operator[](difference_type index) const;

    iterator_range& operator++();
    iterator_range operator++(int);

    const difference_type size() const;
    const bool empty() const;
    const bool operator!() const;
    operator const num::SafeBool() const;

    void swap(iterator_range& other);

private:

    iterator first_;
    iterator last_;
};

template <typename I> iterator_range<I> range(const I& a, const I& b);

template <typename I> const bool operator==(const iterator_range<I>& a, const iterator_range<I>& b);
template <typename I> const bool operator!=(const iterator_range<I>& a, const iterator_range<I>& b);

}

}

#include "iterator_range.inl"

#endif

// EOF