mrw-cxx/mrw/deque.hpp

/** @file

    $Id$

    $Date$
    $Author$

    @copy © Marc Wäckerlin
    @license LGPL, see file <a href="license.html">COPYING</a>

    $Log$
    Revision 1.2  2004/12/20 07:40:35  marc
    documentation improved, new grouping

    Revision 1.1  2004/10/07 09:31:30  marc
    new feature


*/
#ifndef __MRW__DEQUE__HPP__
#define __MRW__DEQUE__HPP__

#include <deque>
#include <mrw/exception.hpp>
#include <mrw/string.hpp>

/** @addtogroup StdExt
 */
//@{
/** @addtogroup StdExtSTL
 */
//@{
/** @defgroup StdExtdeque deque
 */
//@{

/** @brief push a value to a deque

    @code
    std::deque<int> test;
    test<<1<<2<<3<<4<<5<<6<<7<<8;
    @endcode

    @param l a deque of values
    @param o a value to be inserted into deque @c l
    @pre #include <mrw/deque.hpp>
*/
template <typename T, typename A>
std::deque<T, A>& operator<<(std::deque<T, A>& l, const T& o) throw(std::bad_exception) {
  l.push_back(o);
  return l;
}

/** @brief extract the first value of a deque

    @code
    std::deque<int> test;
    test<<1<<2<<3<<4<<5<<6<<7<<8;
    int i1(0), i2(0), i3(0), i4(0);
    test>>i1>>i2>>i3>>i4;
    // now: i1==1 i2==2 i3==3 i4==4 test=={5, 6, 7, 8}
    @endcode

    @param l a deque of values
    @param o a value to be extracted from deque @c l
    @throw mrw::length_error, if deque was empty on entry
    @note when something is extracted from a deque, it is removed
    from the deque, that means after every shift the deque is
    shortened by the shifted element
    @pre #include <mrw/deque.hpp>
*/
template <typename T, typename A>
std::deque<T, A>& operator>>(std::deque<T, A>& l, T& o) throw(std::exception) {
  typename std::deque<T, A>::iterator it(l.begin());
  if (it==l.end())
    throw mrw::length_error(std::string(__FILE__ ":")+__LINE__+
                            ": std::deque<>& operator>>(std::deque<>&, T&),"
                            " deque is empty");
  o = *it;
  l.erase(it);
  return l;
}

//@}
//@}
//@}

#endif