sl@0: // Copyright 2002 The Trustees of Indiana University.
sl@0: 
sl@0: // Use, modification and distribution is subject to the Boost Software 
sl@0: // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
sl@0: // http://www.boost.org/LICENSE_1_0.txt)
sl@0: 
sl@0: //  Boost.MultiArray Library
sl@0: //  Authors: Ronald Garcia
sl@0: //           Jeremy Siek
sl@0: //           Andrew Lumsdaine
sl@0: //  See http://www.boost.org/libs/multi_array for documentation.
sl@0: 
sl@0: #ifndef BOOST_MULTI_ARRAY_RG071801_HPP
sl@0: #define BOOST_MULTI_ARRAY_RG071801_HPP
sl@0: 
sl@0: //
sl@0: // multi_array.hpp - contains the multi_array class template
sl@0: // declaration and definition
sl@0: //
sl@0: 
sl@0: #include "boost/multi_array/base.hpp"
sl@0: #include "boost/multi_array/collection_concept.hpp"
sl@0: #include "boost/multi_array/copy_array.hpp"
sl@0: #include "boost/multi_array/iterator.hpp"
sl@0: #include "boost/multi_array/subarray.hpp"
sl@0: #include "boost/multi_array/multi_array_ref.hpp"
sl@0: #include "boost/multi_array/algorithm.hpp"
sl@0: #include "boost/array.hpp"
sl@0: #include "boost/mpl/if.hpp"
sl@0: #include "boost/type_traits.hpp"
sl@0: #include <algorithm>
sl@0: #include <cstddef>
sl@0: #include <functional>
sl@0: #include <numeric>
sl@0: #include <vector>
sl@0: 
sl@0: 
sl@0: 
sl@0: namespace boost {
sl@0:   namespace detail {
sl@0:     namespace multi_array {
sl@0: 
sl@0:       struct populate_index_ranges {
sl@0:         multi_array_types::index_range
sl@0:         // RG: underscore on extent_ to stifle strange MSVC warning.
sl@0:         operator()(multi_array_types::index base,
sl@0:                    multi_array_types::size_type extent_) {
sl@0:           return multi_array_types::index_range(base,base+extent_);
sl@0:         }
sl@0:       };
sl@0: 
sl@0: #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
sl@0: //
sl@0: // Compilers that don't support partial ordering may need help to
sl@0: // disambiguate multi_array's templated constructors.  Even vc6/7 are
sl@0: // capable of some limited SFINAE, so we take the most-general version
sl@0: // out of the overload set with disable_multi_array_impl.
sl@0: //
sl@0: template <typename T, std::size_t NumDims, typename TPtr>
sl@0: char is_multi_array_impl_help(const_multi_array_view<T,NumDims,TPtr>&);
sl@0: template <typename T, std::size_t NumDims, typename TPtr>
sl@0: char is_multi_array_impl_help(const_sub_array<T,NumDims,TPtr>&);
sl@0: template <typename T, std::size_t NumDims, typename TPtr>
sl@0: char is_multi_array_impl_help(const_multi_array_ref<T,NumDims,TPtr>&);
sl@0: 
sl@0: char ( &is_multi_array_impl_help(...) )[2];
sl@0: 
sl@0: template <class T>
sl@0: struct is_multi_array_impl
sl@0: {
sl@0:     static T x;
sl@0:     BOOST_STATIC_CONSTANT(bool, value = sizeof((is_multi_array_impl_help)(x)) == 1);
sl@0: 
sl@0:   typedef mpl::bool_<value> type;
sl@0: };
sl@0: 
sl@0: template <bool multi_array = false>
sl@0: struct disable_multi_array_impl_impl
sl@0: {
sl@0:     typedef int type;
sl@0: };
sl@0: 
sl@0: template <>
sl@0: struct disable_multi_array_impl_impl<true>
sl@0: {
sl@0:     // forming a pointer to a reference triggers SFINAE
sl@0:     typedef int& type; 
sl@0: };
sl@0: 
sl@0: 
sl@0: template <class T>
sl@0: struct disable_multi_array_impl :
sl@0:   disable_multi_array_impl_impl<is_multi_array_impl<T>::value>
sl@0: { };
sl@0: 
sl@0: 
sl@0: template <>
sl@0: struct disable_multi_array_impl<int>
sl@0: {
sl@0:   typedef int type;
sl@0: };
sl@0: 
sl@0: 
sl@0: #endif
sl@0: 
sl@0:     } //namespace multi_array
sl@0:   } // namespace detail
sl@0: 
sl@0: template<typename T, std::size_t NumDims,
sl@0:   typename Allocator>
sl@0: class multi_array :
sl@0:   public multi_array_ref<T,NumDims>
sl@0: {
sl@0:   typedef multi_array_ref<T,NumDims> super_type;
sl@0: public:
sl@0:   typedef typename super_type::value_type value_type;
sl@0:   typedef typename super_type::reference reference;
sl@0:   typedef typename super_type::const_reference const_reference;
sl@0:   typedef typename super_type::iterator iterator;
sl@0:   typedef typename super_type::const_iterator const_iterator;
sl@0:   typedef typename super_type::reverse_iterator reverse_iterator;
sl@0:   typedef typename super_type::const_reverse_iterator const_reverse_iterator;
sl@0:   typedef typename super_type::element element;
sl@0:   typedef typename super_type::size_type size_type;
sl@0:   typedef typename super_type::difference_type difference_type;
sl@0:   typedef typename super_type::index index;
sl@0:   typedef typename super_type::extent_range extent_range;
sl@0: 
sl@0: 
sl@0:   template <std::size_t NDims>
sl@0:   struct const_array_view {
sl@0:     typedef boost::detail::multi_array::const_multi_array_view<T,NDims> type;
sl@0:   };
sl@0: 
sl@0:   template <std::size_t NDims>
sl@0:   struct array_view {
sl@0:     typedef boost::detail::multi_array::multi_array_view<T,NDims> type;
sl@0:   };
sl@0: 
sl@0:   explicit multi_array() :
sl@0:     super_type((T*)initial_base_,c_storage_order(),
sl@0:                /*index_bases=*/0, /*extents=*/0) {
sl@0:     allocate_space(); 
sl@0:   }
sl@0: 
sl@0:   template <class ExtentList>
sl@0:   explicit multi_array(
sl@0:       ExtentList const& extents
sl@0: #ifdef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
sl@0:       , typename mpl::if_<
sl@0:       detail::multi_array::is_multi_array_impl<ExtentList>,
sl@0:       int&,int>::type* = 0
sl@0: #endif
sl@0:       ) :
sl@0:     super_type((T*)initial_base_,extents) {
sl@0:     boost::function_requires<
sl@0:       detail::multi_array::CollectionConcept<ExtentList> >();
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0:     
sl@0:   template <class ExtentList>
sl@0:   explicit multi_array(ExtentList const& extents,
sl@0:                        const general_storage_order<NumDims>& so) :
sl@0:     super_type((T*)initial_base_,extents,so) {
sl@0:     boost::function_requires<
sl@0:       detail::multi_array::CollectionConcept<ExtentList> >();
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0:   template <class ExtentList>
sl@0:   explicit multi_array(ExtentList const& extents,
sl@0:                        const general_storage_order<NumDims>& so,
sl@0:                        Allocator const& alloc) :
sl@0:     super_type((T*)initial_base_,extents,so), allocator_(alloc) {
sl@0:     boost::function_requires<
sl@0:       detail::multi_array::CollectionConcept<ExtentList> >();
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0: 
sl@0:   explicit multi_array(const detail::multi_array
sl@0:                        ::extent_gen<NumDims>& ranges) :
sl@0:     super_type((T*)initial_base_,ranges) {
sl@0: 
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0: 
sl@0:   explicit multi_array(const detail::multi_array
sl@0:                        ::extent_gen<NumDims>& ranges,
sl@0:                        const general_storage_order<NumDims>& so) :
sl@0:     super_type((T*)initial_base_,ranges,so) {
sl@0: 
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0: 
sl@0:   explicit multi_array(const detail::multi_array
sl@0:                        ::extent_gen<NumDims>& ranges,
sl@0:                        const general_storage_order<NumDims>& so,
sl@0:                        Allocator const& alloc) :
sl@0:     super_type((T*)initial_base_,ranges,so), allocator_(alloc) {
sl@0: 
sl@0:     allocate_space();
sl@0:   }
sl@0: 
sl@0:   multi_array(const multi_array& rhs) :
sl@0:   super_type(rhs), allocator_(rhs.allocator_) {
sl@0:     allocate_space();
sl@0:     boost::detail::multi_array::copy_n(rhs.base_,rhs.num_elements(),base_);
sl@0:   }
sl@0: 
sl@0: 
sl@0:   //
sl@0:   // A multi_array is constructible from any multi_array_ref, subarray, or
sl@0:   // array_view object.  The following constructors ensure that.
sl@0:   //
sl@0: 
sl@0:   // Due to limited support for partial template ordering, 
sl@0:   // MSVC 6&7 confuse the following with the most basic ExtentList 
sl@0:   // constructor.
sl@0: #ifndef BOOST_NO_FUNCTION_TEMPLATE_ORDERING
sl@0:   template <typename OPtr>
sl@0:   multi_array(const const_multi_array_ref<T,NumDims,OPtr>& rhs,
sl@0:               const general_storage_order<NumDims>& so = c_storage_order())
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     // Warning! storage order may change, hence the following copy technique.
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   template <typename OPtr>
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_sub_array<T,NumDims,OPtr>& rhs,
sl@0:               const general_storage_order<NumDims>& so = c_storage_order())
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: 
sl@0:   template <typename OPtr>
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_multi_array_view<T,NumDims,OPtr>& rhs,
sl@0:               const general_storage_order<NumDims>& so = c_storage_order())
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: #else // BOOST_NO_FUNCTION_TEMPLATE_ORDERING
sl@0:   // More limited support for MSVC
sl@0: 
sl@0: 
sl@0:   multi_array(const const_multi_array_ref<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     // Warning! storage order may change, hence the following copy technique.
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const const_multi_array_ref<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     // Warning! storage order may change, hence the following copy technique.
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_sub_array<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_sub_array<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_multi_array_view<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               const_multi_array_view<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: #endif // !BOOST_NO_FUNCTION_TEMPLATE_ORDERING
sl@0: 
sl@0:   // Thes constructors are necessary because of more exact template matches.
sl@0:   multi_array(const multi_array_ref<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     // Warning! storage order may change, hence the following copy technique.
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const multi_array_ref<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     // Warning! storage order may change, hence the following copy technique.
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               sub_array<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               sub_array<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0: 
sl@0: 
sl@0:   multi_array(const detail::multi_array::
sl@0:               multi_array_view<T,NumDims>& rhs)
sl@0:     : super_type(0,c_storage_order(),rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0:     
sl@0:   multi_array(const detail::multi_array::
sl@0:               multi_array_view<T,NumDims>& rhs,
sl@0:               const general_storage_order<NumDims>& so)
sl@0:     : super_type(0,so,rhs.index_bases(),rhs.shape()) 
sl@0:   {
sl@0:     allocate_space();
sl@0:     std::copy(rhs.begin(),rhs.end(),this->begin());
sl@0:   }
sl@0:     
sl@0:   // Since assignment is a deep copy, multi_array_ref
sl@0:   // contains all the necessary code.
sl@0:   template <typename ConstMultiArray>
sl@0:   multi_array& operator=(const ConstMultiArray& other) {
sl@0:     super_type::operator=(other);
sl@0:     return *this;
sl@0:   }
sl@0: 
sl@0:   multi_array& operator=(const multi_array& other) {
sl@0:     if (&other != this) {
sl@0:       super_type::operator=(other);
sl@0:     }
sl@0:     return *this;
sl@0:   }
sl@0: 
sl@0: 
sl@0:   template <typename ExtentList>
sl@0:   multi_array& resize(const ExtentList& extents) {
sl@0:     boost::function_requires<
sl@0:       detail::multi_array::CollectionConcept<ExtentList> >();
sl@0: 
sl@0:     typedef detail::multi_array::extent_gen<NumDims> gen_type;
sl@0:     gen_type ranges;
sl@0: 
sl@0:     for (int i=0; i != NumDims; ++i) {
sl@0:       typedef typename gen_type::range range_type;
sl@0:       ranges.ranges_[i] = range_type(0,extents[i]);
sl@0:     }
sl@0:     
sl@0:     return this->resize(ranges);
sl@0:   }
sl@0: 
sl@0: 
sl@0: 
sl@0:   multi_array& resize(const detail::multi_array
sl@0:                       ::extent_gen<NumDims>& ranges) {
sl@0: 
sl@0: 
sl@0:     // build a multi_array with the specs given
sl@0:     multi_array new_array(ranges,this->storage_order());
sl@0: 
sl@0: 
sl@0:     // build a view of tmp with the minimum extents
sl@0: 
sl@0:     // Get the minimum extents of the arrays.
sl@0:     boost::array<size_type,NumDims> min_extents;
sl@0: 
sl@0:     const size_type& (*min)(const size_type&, const size_type&) =
sl@0:       std::min;
sl@0:     std::transform(new_array.extent_list_.begin(),new_array.extent_list_.end(),
sl@0:                    this->extent_list_.begin(),
sl@0:                    min_extents.begin(),
sl@0:                    min);
sl@0: 
sl@0: 
sl@0:     // typedef boost::array<index,NumDims> index_list;
sl@0:     // Build index_gen objects to create views with the same shape
sl@0: 
sl@0:     // these need to be separate to handle non-zero index bases
sl@0:     typedef detail::multi_array::index_gen<NumDims,NumDims> index_gen;
sl@0:     index_gen old_idxes;
sl@0:     index_gen new_idxes;
sl@0: 
sl@0:     std::transform(new_array.index_base_list_.begin(),
sl@0:                    new_array.index_base_list_.end(),
sl@0:                    min_extents.begin(),old_idxes.ranges_.begin(),
sl@0:                    detail::multi_array::populate_index_ranges());
sl@0: 
sl@0:     std::transform(this->index_base_list_.begin(),
sl@0:                    this->index_base_list_.end(),
sl@0:                    min_extents.begin(),new_idxes.ranges_.begin(),
sl@0:                    detail::multi_array::populate_index_ranges());
sl@0: 
sl@0:     // Build same-shape views of the two arrays
sl@0:     typename
sl@0:       multi_array::BOOST_NESTED_TEMPLATE array_view<NumDims>::type view_old = (*this)[old_idxes];
sl@0:     typename
sl@0:       multi_array::BOOST_NESTED_TEMPLATE array_view<NumDims>::type view_new = new_array[new_idxes];
sl@0: 
sl@0:     // Set the right portion of the new array
sl@0:     view_new = view_old;
sl@0: 
sl@0:     using std::swap;
sl@0:     // Swap the internals of these arrays.
sl@0:     swap(this->super_type::base_,new_array.super_type::base_);
sl@0:     swap(this->storage_,new_array.storage_);
sl@0:     swap(this->extent_list_,new_array.extent_list_);
sl@0:     swap(this->stride_list_,new_array.stride_list_);
sl@0:     swap(this->index_base_list_,new_array.index_base_list_);
sl@0:     swap(this->origin_offset_,new_array.origin_offset_);
sl@0:     swap(this->directional_offset_,new_array.directional_offset_);
sl@0:     swap(this->num_elements_,new_array.num_elements_);
sl@0:     swap(this->allocator_,new_array.allocator_);
sl@0:     swap(this->base_,new_array.base_);
sl@0:     swap(this->allocated_elements_,new_array.allocated_elements_);
sl@0: 
sl@0:     return *this;
sl@0:   }
sl@0: 
sl@0: 
sl@0:   ~multi_array() {
sl@0:     deallocate_space();
sl@0:   }
sl@0: 
sl@0: private:
sl@0:   void allocate_space() {
sl@0:     typename Allocator::const_pointer no_hint=0;
sl@0:     base_ = allocator_.allocate(this->num_elements(),no_hint);
sl@0:     this->set_base_ptr(base_);
sl@0:     allocated_elements_ = this->num_elements();
sl@0:     std::uninitialized_fill_n(base_,allocated_elements_,T());
sl@0:   }
sl@0: 
sl@0:   void deallocate_space() {
sl@0:     if(base_) {
sl@0:       for(T* i = base_; i != base_+allocated_elements_; ++i)
sl@0:         allocator_.destroy(i);
sl@0:       allocator_.deallocate(base_,allocated_elements_);
sl@0:     }
sl@0:   }
sl@0: 
sl@0:   typedef boost::array<size_type,NumDims> size_list;
sl@0:   typedef boost::array<index,NumDims> index_list;
sl@0: 
sl@0:   Allocator allocator_;
sl@0:   T* base_;
sl@0:   size_type allocated_elements_;
sl@0:   enum {initial_base_ = 0};
sl@0: };
sl@0: 
sl@0: } // namespace boost
sl@0: 
sl@0: #endif // BOOST_MULTI_ARRAY_RG071801_HPP