williamr@2: // Copyright 2002 The Trustees of Indiana University.
williamr@2: 
williamr@2: // Use, modification and distribution is subject to the Boost Software 
williamr@2: // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
williamr@2: // http://www.boost.org/LICENSE_1_0.txt)
williamr@2: 
williamr@2: //  Boost.MultiArray Library
williamr@2: //  Authors: Ronald Garcia
williamr@2: //           Jeremy Siek
williamr@2: //           Andrew Lumsdaine
williamr@2: //  See http://www.boost.org/libs/multi_array for documentation.
williamr@2: 
williamr@2: #ifndef SUBARRAY_RG071801_HPP
williamr@2: #define SUBARRAY_RG071801_HPP
williamr@2: 
williamr@2: //
williamr@2: // subarray.hpp - used to implement standard operator[] on
williamr@2: // multi_arrays
williamr@2: //
williamr@2: 
williamr@2: #include "boost/multi_array/base.hpp"
williamr@2: #include "boost/multi_array/concept_checks.hpp"
williamr@2: #include "boost/limits.hpp"
williamr@2: #include "boost/type.hpp"
williamr@2: #include <algorithm>
williamr@2: #include <cstddef>
williamr@2: #include <functional>
williamr@2: 
williamr@2: namespace boost {
williamr@2: namespace detail {
williamr@2: namespace multi_array {
williamr@2: 
williamr@2: //
williamr@2: // const_sub_array
williamr@2: //    multi_array's proxy class to allow multiple overloads of
williamr@2: //    operator[] in order to provide a clean multi-dimensional array 
williamr@2: //    interface.
williamr@2: template <typename T, std::size_t NumDims, typename TPtr>
williamr@2: class const_sub_array :
williamr@2:   public boost::detail::multi_array::multi_array_impl_base<T,NumDims>
williamr@2: {
williamr@2:   typedef boost::detail::multi_array::multi_array_impl_base<T,NumDims> super_type;
williamr@2: public: 
williamr@2:   typedef typename super_type::value_type value_type;
williamr@2:   typedef typename super_type::const_reference const_reference;
williamr@2:   typedef typename super_type::const_iterator const_iterator;
williamr@2:   typedef typename super_type::const_reverse_iterator const_reverse_iterator;
williamr@2:   typedef typename super_type::element element;
williamr@2:   typedef typename super_type::size_type size_type;
williamr@2:   typedef typename super_type::difference_type difference_type;
williamr@2:   typedef typename super_type::index index;
williamr@2:   typedef typename super_type::extent_range extent_range;
williamr@2: 
williamr@2:   // template typedefs
williamr@2:   template <std::size_t NDims>
williamr@2:   struct const_array_view {
williamr@2:     typedef boost::detail::multi_array::const_multi_array_view<T,NDims> type;
williamr@2:   };
williamr@2: 
williamr@2:   template <std::size_t NDims>
williamr@2:   struct array_view {
williamr@2:     typedef boost::detail::multi_array::multi_array_view<T,NDims> type;
williamr@2:   };
williamr@2: 
williamr@2:   // Allow default copy constructor as well.
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   const_sub_array (const const_sub_array<T,NumDims,OPtr>& rhs) :
williamr@2:     base_(rhs.base_), extents_(rhs.extents_), strides_(rhs.strides_),
williamr@2:     index_base_(rhs.index_base_) {
williamr@2:   }
williamr@2: 
williamr@2:   // const_sub_array always returns const types, regardless of its own
williamr@2:   // constness.
williamr@2:   const_reference operator[](index idx) const {
williamr@2:     return super_type::access(boost::type<const_reference>(),
williamr@2:                               idx,base_,shape(),strides(),index_bases());
williamr@2:   }
williamr@2:   
williamr@2:   template <typename IndexList>
williamr@2:   const element& operator()(const IndexList& indices) const {
williamr@2:     boost::function_requires<
williamr@2:       detail::multi_array::CollectionConcept<IndexList> >();
williamr@2:     return super_type::access_element(boost::type<const element&>(),
williamr@2:                                       indices,origin(),
williamr@2:                                       shape(),strides(),index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   // see generate_array_view in base.hpp
williamr@2: #if !defined(BOOST_MSVC) || BOOST_MSVC > 1300
williamr@2:   template <int NDims>
williamr@2: #else
williamr@2:   template <int NumDims, int NDims> // else ICE
williamr@2: #endif // BOOST_MSVC
williamr@2:   typename const_array_view<NDims>::type 
williamr@2:   operator[](const boost::detail::multi_array::
williamr@2:              index_gen<NumDims,NDims>& indices)
williamr@2:     const {
williamr@2:     typedef typename const_array_view<NDims>::type return_type;
williamr@2:     return
williamr@2:       super_type::generate_array_view(boost::type<return_type>(),
williamr@2:                                       indices,
williamr@2:                                       shape(),
williamr@2:                                       strides(),
williamr@2:                                       index_bases(),
williamr@2:                                       base_);
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator<(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     return std::lexicographical_compare(begin(),end(),rhs.begin(),rhs.end());
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator==(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     if(std::equal(shape(),shape()+num_dimensions(),rhs.shape()))
williamr@2:       return std::equal(begin(),end(),rhs.begin());
williamr@2:     else return false;
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator!=(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     return !(*this == rhs);
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator>(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     return rhs < *this;
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator<=(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     return !(*this > rhs);
williamr@2:   }
williamr@2: 
williamr@2:   template <typename OPtr>
williamr@2:   bool operator>=(const const_sub_array<T,NumDims,OPtr>& rhs) const {
williamr@2:     return !(*this < rhs);
williamr@2:   }
williamr@2: 
williamr@2:   const_iterator begin() const {
williamr@2:     return const_iterator(*index_bases(),origin(),
williamr@2:                           shape(),strides(),index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   const_iterator end() const {
williamr@2:     return const_iterator(*index_bases()+(index)*shape(),origin(),
williamr@2:                           shape(),strides(),index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   const_reverse_iterator rbegin() const {
williamr@2:     return const_reverse_iterator(end());
williamr@2:   }
williamr@2: 
williamr@2:   const_reverse_iterator rend() const {
williamr@2:     return const_reverse_iterator(begin());
williamr@2:   }
williamr@2: 
williamr@2:   TPtr origin() const { return base_; }
williamr@2:   size_type size() const { return extents_[0]; }
williamr@2:   size_type max_size() const { return num_elements(); }
williamr@2:   bool empty() const { return size() == 0; }
williamr@2:   size_type num_dimensions() const { return NumDims; }
williamr@2:   const size_type*  shape() const { return extents_; }
williamr@2:   const index* strides() const { return strides_; }
williamr@2:   const index* index_bases() const { return index_base_; }
williamr@2: 
williamr@2:   size_type num_elements() const { 
williamr@2:     return std::accumulate(shape(),shape() + num_dimensions(),
williamr@2:                            size_type(1), std::multiplies<size_type>());
williamr@2:   }
williamr@2: 
williamr@2: 
williamr@2: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
williamr@2: protected:
williamr@2:   template <typename,std::size_t> friend class value_accessor_n;  
williamr@2:   template <typename,std::size_t,typename> friend class const_sub_array;
williamr@2: #else    
williamr@2: public:  // Should be protected
williamr@2: #endif
williamr@2: 
williamr@2:   const_sub_array (TPtr base,
williamr@2:                  const size_type* extents,
williamr@2:                  const index* strides,
williamr@2:                  const index* index_base) :
williamr@2:     base_(base), extents_(extents), strides_(strides),
williamr@2:     index_base_(index_base) {
williamr@2:   }
williamr@2: 
williamr@2:   TPtr base_;
williamr@2:   const size_type* extents_;
williamr@2:   const index* strides_;
williamr@2:   const index* index_base_;
williamr@2: private:
williamr@2:   // const_sub_array cannot be assigned to (no deep copies!)
williamr@2:   const_sub_array& operator=(const const_sub_array&);
williamr@2: };
williamr@2: 
williamr@2: 
williamr@2: //
williamr@2: // sub_array
williamr@2: //    multi_array's proxy class to allow multiple overloads of
williamr@2: //    operator[] in order to provide a clean multi-dimensional array 
williamr@2: //    interface.
williamr@2: template <typename T, std::size_t NumDims>
williamr@2: class sub_array : public const_sub_array<T,NumDims,T*>
williamr@2: {
williamr@2:   typedef const_sub_array<T,NumDims,T*> super_type;
williamr@2: public: 
williamr@2:   typedef typename super_type::element element;
williamr@2:   typedef typename super_type::reference reference;
williamr@2:   typedef typename super_type::index index;
williamr@2:   typedef typename super_type::size_type size_type;
williamr@2:   typedef typename super_type::iterator iterator;
williamr@2:   typedef typename super_type::reverse_iterator reverse_iterator;
williamr@2:   typedef typename super_type::const_reference const_reference;
williamr@2:   typedef typename super_type::const_iterator const_iterator;
williamr@2:   typedef typename super_type::const_reverse_iterator const_reverse_iterator;
williamr@2: 
williamr@2:   // template typedefs
williamr@2:   template <std::size_t NDims>
williamr@2:   struct const_array_view {
williamr@2:     typedef boost::detail::multi_array::const_multi_array_view<T,NDims> type;
williamr@2:   };
williamr@2: 
williamr@2:   template <std::size_t NDims>
williamr@2:   struct array_view {
williamr@2:     typedef boost::detail::multi_array::multi_array_view<T,NDims> type;
williamr@2:   };
williamr@2: 
williamr@2:   // Assignment from other ConstMultiArray types.
williamr@2:   template <typename ConstMultiArray>
williamr@2:   sub_array& operator=(const ConstMultiArray& other) {
williamr@2:     function_requires< boost::detail::multi_array::ConstMultiArrayConcept< 
williamr@2:         ConstMultiArray, NumDims> >();
williamr@2: 
williamr@2:     // make sure the dimensions agree
williamr@2:     assert(other.num_dimensions() == this->num_dimensions());
williamr@2:     assert(std::equal(other.shape(),other.shape()+this->num_dimensions(),
williamr@2:                       this->shape()));
williamr@2:     // iterator-based copy
williamr@2:     std::copy(other.begin(),other.end(),begin());
williamr@2:     return *this;
williamr@2:   }
williamr@2: 
williamr@2: 
williamr@2:   sub_array& operator=(const sub_array& other) {
williamr@2:     if (&other != this) {
williamr@2:       // make sure the dimensions agree
williamr@2:       assert(other.num_dimensions() == this->num_dimensions());
williamr@2:       assert(std::equal(other.shape(),other.shape()+this->num_dimensions(),
williamr@2:                         this->shape()));
williamr@2:       // iterator-based copy
williamr@2:       std::copy(other.begin(),other.end(),begin());
williamr@2:     }
williamr@2:     return *this;
williamr@2:   }
williamr@2: 
williamr@2:   T* origin() { return this->base_; }
williamr@2:   const T* origin() const { return this->base_; }
williamr@2: 
williamr@2:   reference operator[](index idx) {
williamr@2:     return super_type::access(boost::type<reference>(),
williamr@2:                               idx,this->base_,this->shape(),this->strides(),
williamr@2:                               this->index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   // see generate_array_view in base.hpp
williamr@2: #if !defined(BOOST_MSVC) || BOOST_MSVC > 1300
williamr@2:   template <int NDims>
williamr@2: #else
williamr@2:   template <int NumDims, int NDims> // else ICE
williamr@2: #endif // BOOST_MSVC
williamr@2:   typename array_view<NDims>::type 
williamr@2:   operator[](const boost::detail::multi_array::
williamr@2:              index_gen<NumDims,NDims>& indices) {
williamr@2:     typedef typename array_view<NDims>::type return_type;
williamr@2:     return
williamr@2:       super_type::generate_array_view(boost::type<return_type>(),
williamr@2:                                       indices,
williamr@2:                                       this->shape(),
williamr@2:                                       this->strides(),
williamr@2:                                       this->index_bases(),
williamr@2:                                       origin());
williamr@2:   }
williamr@2: 
williamr@2:   template <class IndexList>
williamr@2:   element& operator()(const IndexList& indices) {
williamr@2:     boost::function_requires<
williamr@2:       detail::multi_array::CollectionConcept<IndexList> >();
williamr@2:     return super_type::access_element(boost::type<element&>(),
williamr@2:                                       indices,origin(),
williamr@2:                                       this->shape(),this->strides(),
williamr@2:                                       this->index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   iterator begin() {
williamr@2:     return iterator(*this->index_bases(),origin(),
williamr@2:                     this->shape(),this->strides(),this->index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   iterator end() {
williamr@2:     return iterator(*this->index_bases()+(index)*this->shape(),origin(),
williamr@2:                     this->shape(),this->strides(),this->index_bases());
williamr@2:   }
williamr@2: 
williamr@2:   // RG - rbegin() and rend() written naively to thwart MSVC ICE.
williamr@2:   reverse_iterator rbegin() {
williamr@2:     reverse_iterator ri(end());
williamr@2:     return ri;
williamr@2:   }
williamr@2: 
williamr@2:   reverse_iterator rend() {
williamr@2:     reverse_iterator ri(begin());
williamr@2:     return ri;
williamr@2:   }
williamr@2: 
williamr@2:   //
williamr@2:   // proxies
williamr@2:   //
williamr@2: 
williamr@2:   template <class IndexList>
williamr@2:   const element& operator()(const IndexList& indices) const {
williamr@2:     boost::function_requires<
williamr@2:       detail::multi_array::CollectionConcept<IndexList> >();
williamr@2:     return super_type::operator()(indices);
williamr@2:   }
williamr@2: 
williamr@2:   const_reference operator[](index idx) const {
williamr@2:     return super_type::operator[](idx);
williamr@2:   }
williamr@2: 
williamr@2:   // see generate_array_view in base.hpp
williamr@2: #if !defined(BOOST_MSVC) || BOOST_MSVC > 1300
williamr@2:   template <int NDims>
williamr@2: #else
williamr@2:   template <int NumDims, int NDims> // else ICE
williamr@2: #endif // BOOST_MSVC
williamr@2:   typename const_array_view<NDims>::type 
williamr@2:   operator[](const boost::detail::multi_array::
williamr@2:              index_gen<NumDims,NDims>& indices)
williamr@2:     const {
williamr@2:     return super_type::operator[](indices);
williamr@2:   }
williamr@2: 
williamr@2:   const_iterator begin() const {
williamr@2:     return super_type::begin();
williamr@2:   }
williamr@2:   
williamr@2:   const_iterator end() const {
williamr@2:     return super_type::end();
williamr@2:   }
williamr@2: 
williamr@2:   const_reverse_iterator rbegin() const {
williamr@2:     return super_type::rbegin();
williamr@2:   }
williamr@2: 
williamr@2:   const_reverse_iterator rend() const {
williamr@2:     return super_type::rend();
williamr@2:   }
williamr@2: 
williamr@2: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS
williamr@2: private:
williamr@2:   template <typename,std::size_t> friend class value_accessor_n;
williamr@2: #else
williamr@2: public: // should be private
williamr@2: #endif
williamr@2: 
williamr@2:   sub_array (T* base,
williamr@2:             const size_type* extents,
williamr@2:             const index* strides,
williamr@2:             const index* index_base) :
williamr@2:     super_type(base,extents,strides,index_base) {
williamr@2:   }
williamr@2: 
williamr@2: };
williamr@2: 
williamr@2: } // namespace multi_array
williamr@2: } // namespace detail
williamr@2: //
williamr@2: // traits classes to get sub_array types
williamr@2: //
williamr@2: template <typename Array, int N>
williamr@2: class subarray_gen {
williamr@2:   typedef typename Array::element element;
williamr@2: public:
williamr@2:   typedef boost::detail::multi_array::sub_array<element,N> type;
williamr@2: };
williamr@2: 
williamr@2: template <typename Array, int N>
williamr@2: class const_subarray_gen {
williamr@2:   typedef typename Array::element element;
williamr@2: public:
williamr@2:   typedef boost::detail::multi_array::const_sub_array<element,N> type;  
williamr@2: };
williamr@2: } // namespace boost
williamr@2:   
williamr@2: #endif // SUBARRAY_RG071801_HPP