Chris@16: /* The following code declares class array,
Chris@16:  * an STL container (as wrapper) for arrays of constant size.
Chris@16:  *
Chris@16:  * See
Chris@16:  *      http://www.boost.org/libs/array/
Chris@16:  * for documentation.
Chris@16:  *
Chris@16:  * The original author site is at: http://www.josuttis.com/
Chris@16:  *
Chris@16:  * (C) Copyright Nicolai M. Josuttis 2001.
Chris@16:  *
Chris@16:  * Distributed under the Boost Software License, Version 1.0. (See
Chris@16:  * accompanying file LICENSE_1_0.txt or copy at
Chris@16:  * http://www.boost.org/LICENSE_1_0.txt)
Chris@16:  *
Chris@16:  * 14 Apr 2012 - (mtc) Added support for boost::hash
Chris@16:  * 28 Dec 2010 - (mtc) Added cbegin and cend (and crbegin and crend) for C++Ox compatibility.
Chris@16:  * 10 Mar 2010 - (mtc) fill method added, matching resolution of the standard library working group.
Chris@16:  *      See <http://www.open-std.org/jtc1/sc22/wg21/docs/lwg-defects.html#776> or Trac issue #3168
Chris@16:  *      Eventually, we should remove "assign" which is now a synonym for "fill" (Marshall Clow)
Chris@16:  * 10 Mar 2010 - added workaround for SUNCC and !STLPort [trac #3893] (Marshall Clow)
Chris@16:  * 29 Jan 2004 - c_array() added, BOOST_NO_PRIVATE_IN_AGGREGATE removed (Nico Josuttis)
Chris@16:  * 23 Aug 2002 - fix for Non-MSVC compilers combined with MSVC libraries.
Chris@16:  * 05 Aug 2001 - minor update (Nico Josuttis)
Chris@16:  * 20 Jan 2001 - STLport fix (Beman Dawes)
Chris@16:  * 29 Sep 2000 - Initial Revision (Nico Josuttis)
Chris@16:  *
Chris@16:  * Jan 29, 2004
Chris@16:  */
Chris@16: #ifndef BOOST_ARRAY_HPP
Chris@16: #define BOOST_ARRAY_HPP
Chris@16: 
Chris@16: #include <boost/detail/workaround.hpp>
Chris@16: 
Chris@16: #if BOOST_WORKAROUND(BOOST_MSVC, >= 1400)  
Chris@16: # pragma warning(push)  
Chris@16: # pragma warning(disable:4996) // 'std::equal': Function call with parameters that may be unsafe
Chris@16: # pragma warning(disable:4510) // boost::array<T,N>' : default constructor could not be generated 
Chris@16: # pragma warning(disable:4610) // warning C4610: class 'boost::array<T,N>' can never be instantiated - user defined constructor required 
Chris@16: #endif
Chris@16: 
Chris@16: #include <cstddef>
Chris@16: #include <stdexcept>
Chris@16: #include <boost/assert.hpp>
Chris@16: #include <boost/swap.hpp>
Chris@16: 
Chris@16: // Handles broken standard libraries better than <iterator>
Chris@16: #include <boost/detail/iterator.hpp>
Chris@16: #include <boost/throw_exception.hpp>
Chris@16: #include <boost/functional/hash_fwd.hpp>
Chris@16: #include <algorithm>
Chris@16: 
Chris@16: // FIXES for broken compilers
Chris@16: #include <boost/config.hpp>
Chris@16: 
Chris@16: 
Chris@16: namespace boost {
Chris@16: 
Chris@16:     template<class T, std::size_t N>
Chris@16:     class array {
Chris@16:       public:
Chris@16:         T elems[N];    // fixed-size array of elements of type T
Chris@16: 
Chris@16:       public:
Chris@16:         // type definitions
Chris@16:         typedef T              value_type;
Chris@16:         typedef T*             iterator;
Chris@16:         typedef const T*       const_iterator;
Chris@16:         typedef T&             reference;
Chris@16:         typedef const T&       const_reference;
Chris@16:         typedef std::size_t    size_type;
Chris@16:         typedef std::ptrdiff_t difference_type;
Chris@16: 
Chris@16:         // iterator support
Chris@16:         iterator        begin()       { return elems; }
Chris@16:         const_iterator  begin() const { return elems; }
Chris@16:         const_iterator cbegin() const { return elems; }
Chris@16:         
Chris@16:         iterator        end()       { return elems+N; }
Chris@16:         const_iterator  end() const { return elems+N; }
Chris@16:         const_iterator cend() const { return elems+N; }
Chris@16: 
Chris@16:         // reverse iterator support
Chris@16: #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
Chris@16:         typedef std::reverse_iterator<iterator> reverse_iterator;
Chris@16:         typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
Chris@16: #elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
Chris@16:         // workaround for broken reverse_iterator in VC7
Chris@16:         typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
Chris@16:                                       reference, iterator, reference> > reverse_iterator;
Chris@16:         typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
Chris@16:                                       const_reference, iterator, reference> > const_reverse_iterator;
Chris@16: #elif defined(_RWSTD_NO_CLASS_PARTIAL_SPEC) 
Chris@16:         typedef std::reverse_iterator<iterator, std::random_access_iterator_tag, 
Chris@16:               value_type, reference, iterator, difference_type> reverse_iterator; 
Chris@16:         typedef std::reverse_iterator<const_iterator, std::random_access_iterator_tag,
Chris@16:               value_type, const_reference, const_iterator, difference_type> const_reverse_iterator;
Chris@16: #else
Chris@16:         // workaround for broken reverse_iterator implementations
Chris@16:         typedef std::reverse_iterator<iterator,T> reverse_iterator;
Chris@16:         typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
Chris@16: #endif
Chris@16: 
Chris@16:         reverse_iterator rbegin() { return reverse_iterator(end()); }
Chris@16:         const_reverse_iterator rbegin() const {
Chris@16:             return const_reverse_iterator(end());
Chris@16:         }
Chris@16:         const_reverse_iterator crbegin() const {
Chris@16:             return const_reverse_iterator(end());
Chris@16:         }
Chris@16: 
Chris@16:         reverse_iterator rend() { return reverse_iterator(begin()); }
Chris@16:         const_reverse_iterator rend() const {
Chris@16:             return const_reverse_iterator(begin());
Chris@16:         }
Chris@16:         const_reverse_iterator crend() const {
Chris@16:             return const_reverse_iterator(begin());
Chris@16:         }
Chris@16: 
Chris@16:         // operator[]
Chris@16:         reference operator[](size_type i) 
Chris@16:         { 
Chris@16:             BOOST_ASSERT_MSG( i < N, "out of range" );
Chris@16:             return elems[i];
Chris@16:         }
Chris@16:         
Chris@16:         const_reference operator[](size_type i) const 
Chris@16:         {     
Chris@16:             BOOST_ASSERT_MSG( i < N, "out of range" );
Chris@16:             return elems[i]; 
Chris@16:         }
Chris@16: 
Chris@16:         // at() with range check
Chris@16:         reference at(size_type i) { rangecheck(i); return elems[i]; }
Chris@16:         const_reference at(size_type i) const { rangecheck(i); return elems[i]; }
Chris@16:     
Chris@16:         // front() and back()
Chris@16:         reference front() 
Chris@16:         { 
Chris@16:             return elems[0]; 
Chris@16:         }
Chris@16:         
Chris@16:         const_reference front() const 
Chris@16:         {
Chris@16:             return elems[0];
Chris@16:         }
Chris@16:         
Chris@16:         reference back() 
Chris@16:         { 
Chris@16:             return elems[N-1]; 
Chris@16:         }
Chris@16:         
Chris@16:         const_reference back() const 
Chris@16:         { 
Chris@16:             return elems[N-1]; 
Chris@16:         }
Chris@16: 
Chris@16:         // size is constant
Chris@16:         static size_type size() { return N; }
Chris@16:         static bool empty() { return false; }
Chris@16:         static size_type max_size() { return N; }
Chris@16:         enum { static_size = N };
Chris@16: 
Chris@16:         // swap (note: linear complexity)
Chris@16:         void swap (array<T,N>& y) {
Chris@16:             for (size_type i = 0; i < N; ++i)
Chris@16:                 boost::swap(elems[i],y.elems[i]);
Chris@16:         }
Chris@16: 
Chris@16:         // direct access to data (read-only)
Chris@16:         const T* data() const { return elems; }
Chris@16:         T* data() { return elems; }
Chris@16: 
Chris@16:         // use array as C array (direct read/write access to data)
Chris@16:         T* c_array() { return elems; }
Chris@16: 
Chris@16:         // assignment with type conversion
Chris@16:         template <typename T2>
Chris@16:         array<T,N>& operator= (const array<T2,N>& rhs) {
Chris@16:             std::copy(rhs.begin(),rhs.end(), begin());
Chris@16:             return *this;
Chris@16:         }
Chris@16: 
Chris@16:         // assign one value to all elements
Chris@16:         void assign (const T& value) { fill ( value ); }    // A synonym for fill
Chris@16:         void fill   (const T& value)
Chris@16:         {
Chris@16:             std::fill_n(begin(),size(),value);
Chris@16:         }
Chris@16: 
Chris@16:         // check range (may be private because it is static)
Chris@16:         static void rangecheck (size_type i) {
Chris@16:             if (i >= size()) {
Chris@16:                 std::out_of_range e("array<>: index out of range");
Chris@16:                 boost::throw_exception(e);
Chris@16:             }
Chris@16:         }
Chris@16: 
Chris@16:     };
Chris@16: 
Chris@16: #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION)
Chris@16:     template< class T >
Chris@16:     class array< T, 0 > {
Chris@16: 
Chris@16:       public:
Chris@16:         // type definitions
Chris@16:         typedef T              value_type;
Chris@16:         typedef T*             iterator;
Chris@16:         typedef const T*       const_iterator;
Chris@16:         typedef T&             reference;
Chris@16:         typedef const T&       const_reference;
Chris@16:         typedef std::size_t    size_type;
Chris@16:         typedef std::ptrdiff_t difference_type;
Chris@16: 
Chris@16:         // iterator support
Chris@16:         iterator        begin()       { return       iterator( reinterpret_cast<       T * >( this ) ); }
Chris@16:         const_iterator  begin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
Chris@16:         const_iterator cbegin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
Chris@16: 
Chris@16:         iterator        end()       { return  begin(); }
Chris@16:         const_iterator  end() const { return  begin(); }
Chris@16:         const_iterator cend() const { return cbegin(); }
Chris@16: 
Chris@16:         // reverse iterator support
Chris@16: #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
Chris@16:         typedef std::reverse_iterator<iterator> reverse_iterator;
Chris@16:         typedef std::reverse_iterator<const_iterator> const_reverse_iterator;
Chris@16: #elif defined(_MSC_VER) && (_MSC_VER == 1300) && defined(BOOST_DINKUMWARE_STDLIB) && (BOOST_DINKUMWARE_STDLIB == 310)
Chris@16:         // workaround for broken reverse_iterator in VC7
Chris@16:         typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, iterator,
Chris@16:                                       reference, iterator, reference> > reverse_iterator;
Chris@16:         typedef std::reverse_iterator<std::_Ptrit<value_type, difference_type, const_iterator,
Chris@16:                                       const_reference, iterator, reference> > const_reverse_iterator;
Chris@16: #elif defined(_RWSTD_NO_CLASS_PARTIAL_SPEC) 
Chris@16:         typedef std::reverse_iterator<iterator, std::random_access_iterator_tag, 
Chris@16:               value_type, reference, iterator, difference_type> reverse_iterator; 
Chris@16:         typedef std::reverse_iterator<const_iterator, std::random_access_iterator_tag,
Chris@16:               value_type, const_reference, const_iterator, difference_type> const_reverse_iterator;
Chris@16: #else
Chris@16:         // workaround for broken reverse_iterator implementations
Chris@16:         typedef std::reverse_iterator<iterator,T> reverse_iterator;
Chris@16:         typedef std::reverse_iterator<const_iterator,T> const_reverse_iterator;
Chris@16: #endif
Chris@16: 
Chris@16:         reverse_iterator rbegin() { return reverse_iterator(end()); }
Chris@16:         const_reverse_iterator rbegin() const {
Chris@16:             return const_reverse_iterator(end());
Chris@16:         }
Chris@16:         const_reverse_iterator crbegin() const {
Chris@16:             return const_reverse_iterator(end());
Chris@16:         }
Chris@16: 
Chris@16:         reverse_iterator rend() { return reverse_iterator(begin()); }
Chris@16:         const_reverse_iterator rend() const {
Chris@16:             return const_reverse_iterator(begin());
Chris@16:         }
Chris@16:         const_reverse_iterator crend() const {
Chris@16:             return const_reverse_iterator(begin());
Chris@16:         }
Chris@16: 
Chris@16:         // operator[]
Chris@16:         reference operator[](size_type /*i*/)
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         const_reference operator[](size_type /*i*/) const
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         // at() with range check
Chris@16:         reference at(size_type /*i*/)               {   return failed_rangecheck(); }
Chris@16:         const_reference at(size_type /*i*/) const   {   return failed_rangecheck(); }
Chris@16: 
Chris@16:         // front() and back()
Chris@16:         reference front()
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         const_reference front() const
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         reference back()
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         const_reference back() const
Chris@16:         {
Chris@16:             return failed_rangecheck();
Chris@16:         }
Chris@16: 
Chris@16:         // size is constant
Chris@16:         static size_type size() { return 0; }
Chris@16:         static bool empty() { return true; }
Chris@16:         static size_type max_size() { return 0; }
Chris@16:         enum { static_size = 0 };
Chris@16: 
Chris@16:         void swap (array<T,0>& /*y*/) {
Chris@16:         }
Chris@16: 
Chris@16:         // direct access to data (read-only)
Chris@16:         const T* data() const { return 0; }
Chris@16:         T* data() { return 0; }
Chris@16: 
Chris@16:         // use array as C array (direct read/write access to data)
Chris@16:         T* c_array() { return 0; }
Chris@16: 
Chris@16:         // assignment with type conversion
Chris@16:         template <typename T2>
Chris@16:         array<T,0>& operator= (const array<T2,0>& ) {
Chris@16:             return *this;
Chris@16:         }
Chris@16: 
Chris@16:         // assign one value to all elements
Chris@16:         void assign (const T& value) { fill ( value ); }
Chris@16:         void fill   (const T& ) {}
Chris@16:         
Chris@16:         // check range (may be private because it is static)
Chris@16:         static reference failed_rangecheck () {
Chris@16:                 std::out_of_range e("attempt to access element of an empty array");
Chris@16:                 boost::throw_exception(e);
Chris@16: #if defined(BOOST_NO_EXCEPTIONS) || (!defined(BOOST_MSVC) && !defined(__PATHSCALE__))
Chris@16:                 //
Chris@16:                 // We need to return something here to keep
Chris@16:                 // some compilers happy: however we will never
Chris@16:                 // actually get here....
Chris@16:                 //
Chris@16:                 static T placeholder;
Chris@16:                 return placeholder;
Chris@16: #endif
Chris@16:             }
Chris@16:     };
Chris@16: #endif
Chris@16: 
Chris@16:     // comparisons
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator== (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return std::equal(x.begin(), x.end(), y.begin());
Chris@16:     }
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator< (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return std::lexicographical_compare(x.begin(),x.end(),y.begin(),y.end());
Chris@16:     }
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator!= (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return !(x==y);
Chris@16:     }
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator> (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return y<x;
Chris@16:     }
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator<= (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return !(y<x);
Chris@16:     }
Chris@16:     template<class T, std::size_t N>
Chris@16:     bool operator>= (const array<T,N>& x, const array<T,N>& y) {
Chris@16:         return !(x<y);
Chris@16:     }
Chris@16: 
Chris@16:     // global swap()
Chris@16:     template<class T, std::size_t N>
Chris@16:     inline void swap (array<T,N>& x, array<T,N>& y) {
Chris@16:         x.swap(y);
Chris@16:     }
Chris@16: 
Chris@16: #if defined(__SUNPRO_CC)
Chris@16: //  Trac ticket #4757; the Sun Solaris compiler can't handle
Chris@16: //  syntax like 'T(&get_c_array(boost::array<T,N>& arg))[N]'
Chris@16: //  
Chris@16: //  We can't just use this for all compilers, because the 
Chris@16: //      borland compilers can't handle this form. 
Chris@16:     namespace detail {
Chris@16:        template <typename T, std::size_t N> struct c_array
Chris@16:        {
Chris@16:            typedef T type[N];
Chris@16:        };
Chris@16:     }
Chris@16:     
Chris@16:    // Specific for boost::array: simply returns its elems data member.
Chris@16:    template <typename T, std::size_t N>
Chris@16:    typename detail::c_array<T,N>::type& get_c_array(boost::array<T,N>& arg)
Chris@16:    {
Chris@16:        return arg.elems;
Chris@16:    }
Chris@16: 
Chris@16:    // Specific for boost::array: simply returns its elems data member.
Chris@16:    template <typename T, std::size_t N>
Chris@16:    typename const detail::c_array<T,N>::type& get_c_array(const boost::array<T,N>& arg)
Chris@16:    {
Chris@16:        return arg.elems;
Chris@16:    }
Chris@16: #else
Chris@16: // Specific for boost::array: simply returns its elems data member.
Chris@16:     template <typename T, std::size_t N>
Chris@16:     T(&get_c_array(boost::array<T,N>& arg))[N]
Chris@16:     {
Chris@16:         return arg.elems;
Chris@16:     }
Chris@16:     
Chris@16:     // Const version.
Chris@16:     template <typename T, std::size_t N>
Chris@16:     const T(&get_c_array(const boost::array<T,N>& arg))[N]
Chris@16:     {
Chris@16:         return arg.elems;
Chris@16:     }
Chris@16: #endif
Chris@16:     
Chris@16: #if 0
Chris@16:     // Overload for std::array, assuming that std::array will have
Chris@16:     // explicit conversion functions as discussed at the WG21 meeting
Chris@16:     // in Summit, March 2009.
Chris@16:     template <typename T, std::size_t N>
Chris@16:     T(&get_c_array(std::array<T,N>& arg))[N]
Chris@16:     {
Chris@16:         return static_cast<T(&)[N]>(arg);
Chris@16:     }
Chris@16:     
Chris@16:     // Const version.
Chris@16:     template <typename T, std::size_t N>
Chris@16:     const T(&get_c_array(const std::array<T,N>& arg))[N]
Chris@16:     {
Chris@16:         return static_cast<T(&)[N]>(arg);
Chris@16:     }
Chris@16: #endif
Chris@16: 
Chris@16: 
Chris@16:     template<class T, std::size_t N>
Chris@16:     std::size_t hash_value(const array<T,N>& arr)
Chris@16:     {
Chris@16:         return boost::hash_range(arr.begin(), arr.end());
Chris@16:     }
Chris@16: 
Chris@16: } /* namespace boost */
Chris@16: 
Chris@16: 
Chris@16: #if BOOST_WORKAROUND(BOOST_MSVC, >= 1400)  
Chris@16: # pragma warning(pop)  
Chris@16: #endif 
Chris@16: 
Chris@16: #endif /*BOOST_ARRAY_HPP*/