Create merge base for git.

[SVN r86673]

doc/array.xml

@@ -68,7 +68,12 @@
 
     <para>Note that this class is suggested to be part of the next
     Technical Report, which will extend the C++ Standard (see
-    <ulink url="http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm">http://std.dkuug.dk/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</ulink>).</para>
+    <ulink url="http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2003/n1548.htm">http://www.open-std.org/jtc1/sc22/wg21/docs/papers/2003/n1548.htm</ulink>).</para>
+
+    <para>Update: <code>std::array</code> is (as of C++11) part of the C++ standard.
+    The differences between <code>boost::array</code> and <code>std::array</code> are minimal.
+    If you are using C++11, you should consider using <code>std::array</code> instead of <code>boost::array</code>.
+    </para>
 
     <para>Class <code><classname>array</classname></code> fulfills most
     but not all of the requirements of "reversible containers" (see

include/boost/array.hpp

@@ -13,6 +13,8 @@
  * accompanying file LICENSE_1_0.txt or copy at
  * http://www.boost.org/LICENSE_1_0.txt)
  *
+ * 14 Apr 2012 - (mtc) Added support for boost::hash
+ * 28 Dec 2010 - (mtc) Added cbegin and cend (and crbegin and crend) for C++Ox compatibility.
  * 10 Mar 2010 - (mtc) fill method added, matching resolution of the standard library working group.
  *      See <http://www.open-std.org/jtc1/sc22/wg21/docs/lwg-defects.html#776> or Trac issue #3168
  *      Eventually, we should remove "assign" which is now a synonym for "fill" (Marshall Clow)
@@ -45,6 +47,7 @@
 // Handles broken standard libraries better than <iterator>
 #include <boost/detail/iterator.hpp>
 #include <boost/throw_exception.hpp>
+#include <boost/functional/hash_fwd.hpp>
 #include <algorithm>
 
 // FIXES for broken compilers
@@ -69,10 +72,13 @@ namespace boost {
         typedef std::ptrdiff_t difference_type;
 
         // iterator support
-        iterator begin() { return elems; }
-        const_iterator begin() const { return elems; }
-        iterator end() { return elems+N; }
-        const_iterator end() const { return elems+N; }
+        iterator        begin()       { return elems; }
+        const_iterator  begin() const { return elems; }
+        const_iterator cbegin() const { return elems; }
+        
+        iterator        end()       { return elems+N; }
+        const_iterator  end() const { return elems+N; }
+        const_iterator cend() const { return elems+N; }
 
         // reverse iterator support
 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
@@ -99,21 +105,28 @@ namespace boost {
         const_reverse_iterator rbegin() const {
             return const_reverse_iterator(end());
         }
+        const_reverse_iterator crbegin() const {
+            return const_reverse_iterator(end());
+        }
+
         reverse_iterator rend() { return reverse_iterator(begin()); }
         const_reverse_iterator rend() const {
             return const_reverse_iterator(begin());
         }
+        const_reverse_iterator crend() const {
+            return const_reverse_iterator(begin());
+        }
 
         // operator[]
         reference operator[](size_type i) 
         { 
-            BOOST_ASSERT( i < N && "out of range" ); 
+            BOOST_ASSERT_MSG( i < N, "out of range" );
             return elems[i];
         }
         
         const_reference operator[](size_type i) const 
         {     
-            BOOST_ASSERT( i < N && "out of range" ); 
+            BOOST_ASSERT_MSG( i < N, "out of range" );
             return elems[i]; 
         }
 
@@ -200,10 +213,13 @@ namespace boost {
         typedef std::ptrdiff_t difference_type;
 
         // iterator support
-        iterator begin() { return iterator( reinterpret_cast< T * >( this ) ); }
-        const_iterator begin() const { return const_iterator(  reinterpret_cast< const T * >( this ) ); }
-        iterator end() { return begin(); }
-        const_iterator end() const { return begin(); }
+        iterator        begin()       { return       iterator( reinterpret_cast<       T * >( this ) ); }
+        const_iterator  begin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
+        const_iterator cbegin() const { return const_iterator( reinterpret_cast< const T * >( this ) ); }
+
+        iterator        end()       { return  begin(); }
+        const_iterator  end() const { return  begin(); }
+        const_iterator cend() const { return cbegin(); }
 
         // reverse iterator support
 #if !defined(BOOST_NO_TEMPLATE_PARTIAL_SPECIALIZATION) && !defined(BOOST_MSVC_STD_ITERATOR) && !defined(BOOST_NO_STD_ITERATOR_TRAITS)
@@ -230,10 +246,17 @@ namespace boost {
         const_reverse_iterator rbegin() const {
             return const_reverse_iterator(end());
         }
+        const_reverse_iterator crbegin() const {
+            return const_reverse_iterator(end());
+        }
+
         reverse_iterator rend() { return reverse_iterator(begin()); }
         const_reverse_iterator rend() const {
             return const_reverse_iterator(begin());
         }
+        const_reverse_iterator crend() const {
+            return const_reverse_iterator(begin());
+        }
 
         // operator[]
         reference operator[](size_type /*i*/)
@@ -301,7 +324,7 @@ namespace boost {
         static reference failed_rangecheck () {
                 std::out_of_range e("attempt to access element of an empty array");
                 boost::throw_exception(e);
-#if defined(BOOST_NO_EXCEPTIONS) || !defined(BOOST_MSVC)
+#if defined(BOOST_NO_EXCEPTIONS) || (!defined(BOOST_MSVC) && !defined(__PATHSCALE__))
                 //
                 // We need to return something here to keep
                 // some compilers happy: however we will never
@@ -346,37 +369,72 @@ namespace boost {
         x.swap(y);
     }
 
-	// Specific for boost::array: simply returns its elems data member.
-	template <typename T, std::size_t N>
-	T(&get_c_array(boost::array<T,N>& arg))[N]
-	{
-		return arg.elems;
-	}
-	
-	// Const version.
-	template <typename T, std::size_t N>
-	const T(&get_c_array(const boost::array<T,N>& arg))[N]
-	{
-		return arg.elems;
-	}
+#if defined(__SUNPRO_CC)
+//  Trac ticket #4757; the Sun Solaris compiler can't handle
+//  syntax like 'T(&get_c_array(boost::array<T,N>& arg))[N]'
+//  
+//  We can't just use this for all compilers, because the 
+//      borland compilers can't handle this form. 
+    namespace detail {
+       template <typename T, std::size_t N> struct c_array
+       {
+           typedef T type[N];
+       };
+    }
+    
+   // Specific for boost::array: simply returns its elems data member.
+   template <typename T, std::size_t N>
+   typename detail::c_array<T,N>::type& get_c_array(boost::array<T,N>& arg)
+   {
+       return arg.elems;
+   }
 
-#if 0
-	// Overload for std::array, assuming that std::array will have
-	// explicit conversion functions as discussed at the WG21 meeting
-	// in Summit, March 2009.
-	template <typename T, std::size_t N>
-	T(&get_c_array(std::array<T,N>& arg))[N]
-	{
-		return static_cast<T(&)[N]>(arg);
-	}
-	
-	// Const version.
-	template <typename T, std::size_t N>
-	const T(&get_c_array(const std::array<T,N>& arg))[N]
-	{
-		return static_cast<T(&)[N]>(arg);
-	}
+   // Specific for boost::array: simply returns its elems data member.
+   template <typename T, std::size_t N>
+   typename const detail::c_array<T,N>::type& get_c_array(const boost::array<T,N>& arg)
+   {
+       return arg.elems;
+   }
+#else
+// Specific for boost::array: simply returns its elems data member.
+    template <typename T, std::size_t N>
+    T(&get_c_array(boost::array<T,N>& arg))[N]
+    {
+        return arg.elems;
+    }
+    
+    // Const version.
+    template <typename T, std::size_t N>
+    const T(&get_c_array(const boost::array<T,N>& arg))[N]
+    {
+        return arg.elems;
+    }
 #endif
+    
+#if 0
+    // Overload for std::array, assuming that std::array will have
+    // explicit conversion functions as discussed at the WG21 meeting
+    // in Summit, March 2009.
+    template <typename T, std::size_t N>
+    T(&get_c_array(std::array<T,N>& arg))[N]
+    {
+        return static_cast<T(&)[N]>(arg);
+    }
+    
+    // Const version.
+    template <typename T, std::size_t N>
+    const T(&get_c_array(const std::array<T,N>& arg))[N]
+    {
+        return static_cast<T(&)[N]>(arg);
+    }
+#endif
+
+
+    template<class T, std::size_t N>
+    std::size_t hash_value(const array<T,N>& arr)
+    {
+        return boost::hash_range(arr.begin(), arr.end());
+    }
 
 } /* namespace boost */
 

test/Jamfile.v2

@@ -4,11 +4,18 @@
 
 import testing ;
 
+alias unit_test_framework
+    : # sources
+        /boost//unit_test_framework
+    ;        
+
 test-suite array :
-    [ run array0.cpp ]
+    [ run array0.cpp unit_test_framework  : : : : array0 ]
     [ run array1.cpp ]
     [ run array2.cpp ]
     [ run array3.cpp ]
     [ run array4.cpp ]
     [ run array5.cpp ]
+    [ run array6.cpp unit_test_framework  : : : : array6 ]
+    [ run array_hash.cpp unit_test_framework  : : : : array_hash ]
     ;

test/array0.cpp

@@ -9,18 +9,15 @@
 #include <iostream>
 #include <boost/array.hpp>
 
-namespace {
-unsigned int failed_tests = 0;
+#define BOOST_TEST_MAIN
+#include <boost/test/unit_test.hpp>
 
-void    fail_test( const char * reason ) {
-    ++failed_tests;
-    std::cerr << "Test failure " << failed_tests << ": " << reason << std::endl;
-}
+namespace {
 
 template< class T >
 void    BadValue( const T &  )
 {
-    fail_test( "Unexpected value" );
+    BOOST_CHECK ( false );
 }
 
 template< class T >
@@ -36,55 +33,41 @@ void    RunTests()
 
     //  front/back and operator[] must compile, but calling them is undefined
     //  Likewise, all tests below should evaluate to false, avoiding undefined behaviour
-    if( !test_case.empty() ) {
-        BadValue( test_case.front() );
-    }
+    BOOST_CHECK (       test_case.empty());
+    BOOST_CHECK ( const_test_case.empty());
 
-    if( !const_test_case.empty() ) {
-        BadValue( const_test_case.back() );
-    }
-
-    if( test_case.size() > 0 ) {
-        BadValue( test_case[ 0 ] );
-    }
-
-    if( const_test_case.max_size() > 0 ) {
-        BadValue( const_test_case[ 0 ] );
-    }
+    BOOST_CHECK (       test_case.size() == 0 );
+    BOOST_CHECK ( const_test_case.size() == 0 );
 
     //  Assert requirements of TR1 6.2.2.4
-    if( test_case.begin() != test_case.end() ) {
-        fail_test( "Not an empty range" );
-    }
-    if( const_test_case.begin() != const_test_case.end() ) {
-        fail_test( "Not an empty range" );
-    }
-
-    if( test_case.begin() == const_test_case.begin() ) {
-        fail_test( "iterators for different containers are not distinct" );
-    }
+    BOOST_CHECK ( test_case.begin()  == test_case.end());
+    BOOST_CHECK ( test_case.cbegin() == test_case.cend());
+    BOOST_CHECK ( const_test_case.begin() == const_test_case.end());
+    BOOST_CHECK ( const_test_case.cbegin() == const_test_case.cend());
 
+    BOOST_CHECK ( test_case.begin() != const_test_case.begin() );
     if( test_case.data() == const_test_case.data() ) {
     //  Value of data is unspecified in TR1, so no requirement this test pass or fail
     //  However, it must compile!
     }
 
-
     //  Check can safely use all iterator types with std algorithms
     std::for_each( test_case.begin(), test_case.end(), BadValue< T > );
     std::for_each( test_case.rbegin(), test_case.rend(), BadValue< T > );
+    std::for_each( test_case.cbegin(), test_case.cend(), BadValue< T > );
     std::for_each( const_test_case.begin(), const_test_case.end(), BadValue< T > );
     std::for_each( const_test_case.rbegin(), const_test_case.rend(), BadValue< T > );
+    std::for_each( const_test_case.cbegin(), const_test_case.cend(), BadValue< T > );
 
     //  Check swap is well formed
     std::swap( test_case, test_case );
 
-    //  Check assigment operator and overloads are well formed
+    //  Check assignment operator and overloads are well formed
     test_case   =   const_test_case;
 
     //  Confirm at() throws the std lib defined exception
     try {
-        BadValue( test_case.at( 0 ) );
+        BadValue( test_case.at( 0 ));
     } catch ( const std::out_of_range & ) {
     }
 
@@ -96,12 +79,11 @@ void    RunTests()
 
 }
 
-int main()
+BOOST_AUTO_TEST_CASE( test_main )
 {
     RunTests< bool >();
     RunTests< void * >();
     RunTests< long double >();
     RunTests< std::string >();
-    return failed_tests;
 }
 

test/array2.cpp

@@ -15,12 +15,11 @@
 #include <boost/array.hpp>
 #include "print.hpp"
 using namespace std;
-using namespace boost;
 
 int main()
 {
     // create and initialize array
-    array<int,10> a = { { 1, 2, 3, 4, 5 } };
+    boost::array<int,10> a = { { 1, 2, 3, 4, 5 } };
 
     print_elements(a);
 

test/array3.cpp

@@ -39,6 +39,13 @@ int main()
            =seasons.rbegin(); pos<seasons.rend(); ++pos) {
         std::cout << " " << *pos;
     }
+
+    // try constant reverse iterators
+    std::cout << "reverse:   ";
+    for (boost::array<std::string,4>::const_reverse_iterator pos
+           =seasons.crbegin(); pos<seasons.crend(); ++pos) {
+        std::cout << " " << *pos;
+    }
     std::cout << std::endl;
 
     return 0;  // makes Visual-C++ compiler happy

test/array6.cpp

@@ -0,0 +1,40 @@
+/* tests for using class array<> specialization for size 0
+ * (C) Copyright Alisdair Meredith 2006.
+ * Distributed under the Boost Software License, Version 1.0. (See
+ * accompanying file LICENSE_1_0.txt or copy at
+ * http://www.boost.org/LICENSE_1_0.txt)
+ */
+
+#include <string>
+#include <iostream>
+#include <boost/array.hpp>
+#include <algorithm>
+
+#define BOOST_TEST_MAIN
+#include <boost/test/unit_test.hpp>
+
+namespace {
+    template< class T >
+    void    RunTests()
+    {
+        typedef boost::array< T, 5 >    test_type;
+        typedef T arr[5];
+        test_type           test_case; //   =   { 1, 1, 2, 3, 5 };
+    
+        arr &aRef = get_c_array ( test_case );
+        BOOST_CHECK ( &*test_case.begin () == &aRef[0] );
+        
+        const arr &caRef = get_c_array ( test_case );
+        typename test_type::const_iterator iter = test_case.begin ();
+        BOOST_CHECK ( &*iter == &caRef[0] );
+    }
+}
+
+BOOST_AUTO_TEST_CASE( test_main )
+{
+    RunTests< bool >();
+    RunTests< void * >();
+    RunTests< long double >();
+    RunTests< std::string >();
+}
+

test/array_hash.cpp

@@ -0,0 +1,43 @@
+/* tests for using boost::hash with boost::array
+ * (C) Copyright Marshall Clow 2012
+ * Distributed under the Boost Software License, Version 1.0. (See
+ * accompanying file LICENSE_1_0.txt or copy at
+ * http://www.boost.org/LICENSE_1_0.txt)
+ */
+
+#include <string>
+#include <iostream>
+#include <boost/array.hpp>
+#include <algorithm>
+#include <boost/functional/hash.hpp>
+
+#define BOOST_TEST_MAIN
+#include <boost/test/unit_test.hpp>
+
+namespace {
+
+    template< class T >
+    void    RunTests()
+    {
+    //    std::size_t hash0 = boost::hash<boost::array<T,0> > () ( boost::array<T, 0> ());
+    //    std::size_t hash1 = boost::hash<boost::array<T,1> > () ( boost::array<T, 1> ());
+    
+        typedef boost::array< T, 5 >    barr;
+        typedef T arr[5];
+        barr           test_barr =   {{ 1, 1, 2, 3, 5 }};
+        arr            test_arr  =    { 1, 1, 2, 3, 5 };
+    
+        std::size_t bhash = boost::hash<barr> () ( test_barr );
+        std::size_t ahash = boost::hash<arr>  () ( test_arr );
+        BOOST_CHECK ( ahash == bhash );
+    }
+
+}
+
+BOOST_AUTO_TEST_CASE( test_main )
+{
+    RunTests< int >();
+    RunTests< long >();
+    RunTests< long double >();
+}
+