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 BOOST_MULTI_ARRAY_REF_RG071801_HPP williamr@2: #define BOOST_MULTI_ARRAY_REF_RG071801_HPP williamr@2: williamr@2: // williamr@2: // multi_array_ref.hpp - code for creating "views" of array data. williamr@2: // williamr@2: williamr@2: #include "boost/multi_array/base.hpp" williamr@2: #include "boost/multi_array/collection_concept.hpp" williamr@2: #include "boost/multi_array/concept_checks.hpp" williamr@2: #include "boost/multi_array/iterator.hpp" williamr@2: #include "boost/multi_array/storage_order.hpp" williamr@2: #include "boost/multi_array/subarray.hpp" williamr@2: #include "boost/multi_array/view.hpp" williamr@2: #include "boost/multi_array/algorithm.hpp" williamr@2: #include "boost/type_traits/is_integral.hpp" williamr@2: #include "boost/array.hpp" williamr@2: #include "boost/concept_check.hpp" williamr@2: #include "boost/functional.hpp" williamr@2: #include "boost/limits.hpp" williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: #include williamr@2: williamr@2: namespace boost { williamr@2: williamr@2: template williamr@2: class const_multi_array_ref : williamr@2: public detail::multi_array::multi_array_impl_base williamr@2: { williamr@2: typedef detail::multi_array::multi_array_impl_base 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: typedef general_storage_order storage_order_type; williamr@2: williamr@2: // template typedefs williamr@2: template williamr@2: struct const_array_view { williamr@2: typedef boost::detail::multi_array::const_multi_array_view type; williamr@2: }; williamr@2: williamr@2: template williamr@2: struct array_view { williamr@2: typedef boost::detail::multi_array::multi_array_view type; williamr@2: }; williamr@2: williamr@2: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS williamr@2: // make const_multi_array_ref a friend of itself williamr@2: template williamr@2: friend class const_multi_array_ref; williamr@2: #endif williamr@2: williamr@2: // This ensures that const_multi_array_ref types with different TPtr williamr@2: // types can convert to each other williamr@2: template williamr@2: const_multi_array_ref(const const_multi_array_ref& other) williamr@2: : base_(other.base_), storage_(other.storage_), williamr@2: extent_list_(other.extent_list_), williamr@2: stride_list_(other.stride_list_), williamr@2: index_base_list_(other.index_base_list_), williamr@2: origin_offset_(other.origin_offset_), williamr@2: directional_offset_(other.directional_offset_), williamr@2: num_elements_(other.num_elements_) { } williamr@2: williamr@2: template williamr@2: explicit const_multi_array_ref(TPtr base, const ExtentList& extents) : williamr@2: base_(base), storage_(c_storage_order()) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: williamr@2: index_base_list_.assign(0); williamr@2: init_multi_array_ref(extents.begin()); williamr@2: } williamr@2: williamr@2: template williamr@2: explicit const_multi_array_ref(TPtr base, const ExtentList& extents, williamr@2: const general_storage_order& so) : williamr@2: base_(base), storage_(so) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: williamr@2: index_base_list_.assign(0); williamr@2: init_multi_array_ref(extents.begin()); williamr@2: } williamr@2: williamr@2: explicit const_multi_array_ref(TPtr base, williamr@2: const detail::multi_array:: williamr@2: extent_gen& ranges) : williamr@2: base_(base), storage_(c_storage_order()) { williamr@2: williamr@2: init_from_extent_gen(ranges); williamr@2: } williamr@2: williamr@2: explicit const_multi_array_ref(TPtr base, williamr@2: const detail::multi_array:: williamr@2: extent_gen& ranges, williamr@2: const general_storage_order& so) : williamr@2: base_(base), storage_(so) { williamr@2: williamr@2: init_from_extent_gen(ranges); williamr@2: } williamr@2: williamr@2: template williamr@2: void assign(InputIterator begin, InputIterator end) { williamr@2: boost::function_requires >(); williamr@2: williamr@2: InputIterator in_iter = begin; williamr@2: T* out_iter = base_; williamr@2: std::size_t copy_count=0; williamr@2: while (in_iter != end && copy_count < num_elements_) { williamr@2: *out_iter++ = *in_iter++; williamr@2: copy_count++; williamr@2: } williamr@2: } williamr@2: williamr@2: template williamr@2: #ifdef BOOST_NO_SFINAE williamr@2: void williamr@2: #else williamr@2: typename williamr@2: disable_if::type,void >::type williamr@2: #endif // BOOST_NO_SFINAE williamr@2: reindex(const BaseList& values) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: boost::detail::multi_array:: williamr@2: copy_n(values.begin(),num_dimensions(),index_base_list_.begin()); williamr@2: origin_offset_ = williamr@2: this->calculate_origin_offset(stride_list_,extent_list_, williamr@2: storage_,index_base_list_); williamr@2: } williamr@2: williamr@2: void reindex(index value) { williamr@2: index_base_list_.assign(value); williamr@2: origin_offset_ = williamr@2: this->calculate_origin_offset(stride_list_,extent_list_, williamr@2: storage_,index_base_list_); williamr@2: } williamr@2: williamr@2: template williamr@2: void reshape(const SizeList& extents) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: assert(num_elements_ == williamr@2: std::accumulate(extents.begin(),extents.end(), williamr@2: size_type(1),std::multiplies())); williamr@2: williamr@2: std::copy(extents.begin(),extents.end(),extent_list_.begin()); williamr@2: this->compute_strides(stride_list_,extent_list_,storage_); williamr@2: williamr@2: origin_offset_ = williamr@2: this->calculate_origin_offset(stride_list_,extent_list_, williamr@2: storage_,index_base_list_); williamr@2: } williamr@2: williamr@2: size_type num_dimensions() const { return NumDims; } williamr@2: williamr@2: size_type size() const { return extent_list_.front(); } williamr@2: williamr@2: // given reshaping functionality, this is the max possible size. williamr@2: size_type max_size() const { return num_elements(); } williamr@2: williamr@2: bool empty() const { return size() == 0; } williamr@2: williamr@2: const size_type* shape() const { williamr@2: return extent_list_.data(); williamr@2: } williamr@2: williamr@2: const index* strides() const { williamr@2: return stride_list_.data(); williamr@2: } williamr@2: williamr@2: const element* origin() const { return base_+origin_offset_; } williamr@2: const element* data() const { return base_; } williamr@2: williamr@2: size_type num_elements() const { return num_elements_; } williamr@2: williamr@2: const index* index_bases() const { williamr@2: return index_base_list_.data(); williamr@2: } williamr@2: williamr@2: williamr@2: const storage_order_type& storage_order() const { williamr@2: return storage_; williamr@2: } williamr@2: williamr@2: template williamr@2: const element& operator()(IndexList indices) const { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: return super_type::access_element(boost::type(), williamr@2: indices,origin(), williamr@2: shape(),strides(),index_bases()); williamr@2: } williamr@2: williamr@2: // Only allow const element access williamr@2: const_reference operator[](index idx) const { williamr@2: return super_type::access(boost::type(), williamr@2: idx,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 williamr@2: #else williamr@2: template // else ICE williamr@2: #endif // BOOST_MSVC williamr@2: typename const_array_view::type williamr@2: operator[](const detail::multi_array:: williamr@2: index_gen& indices) williamr@2: const { williamr@2: typedef typename const_array_view::type return_type; williamr@2: return williamr@2: super_type::generate_array_view(boost::type(), williamr@2: indices, williamr@2: shape(), williamr@2: strides(), williamr@2: index_bases(), williamr@2: origin()); 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: williamr@2: template williamr@2: bool operator==(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: if(std::equal(extent_list_.begin(), williamr@2: extent_list_.end(), williamr@2: rhs.extent_list_.begin())) williamr@2: return std::equal(begin(),end(),rhs.begin()); williamr@2: else return false; williamr@2: } williamr@2: williamr@2: template williamr@2: bool operator<(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: return std::lexicographical_compare(begin(),end(),rhs.begin(),rhs.end()); williamr@2: } williamr@2: williamr@2: template williamr@2: bool operator!=(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: return !(*this == rhs); williamr@2: } williamr@2: williamr@2: template williamr@2: bool operator>(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: return rhs < *this; williamr@2: } williamr@2: williamr@2: template williamr@2: bool operator<=(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: return !(*this > rhs); williamr@2: } williamr@2: williamr@2: template williamr@2: bool operator>=(const williamr@2: const_multi_array_ref& rhs) williamr@2: const { williamr@2: return !(*this < rhs); williamr@2: } williamr@2: williamr@2: williamr@2: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS williamr@2: protected: williamr@2: #else williamr@2: public: williamr@2: #endif williamr@2: williamr@2: typedef boost::array size_list; williamr@2: typedef boost::array index_list; williamr@2: williamr@2: // This is used by multi_array, which is a subclass of this williamr@2: void set_base_ptr(TPtr new_base) { base_ = new_base; } williamr@2: williamr@2: williamr@2: // This constructor supports multi_array's default constructor williamr@2: // and constructors from multi_array_ref, subarray, and array_view williamr@2: explicit williamr@2: const_multi_array_ref(TPtr base, williamr@2: const storage_order_type& so, williamr@2: const index * index_bases, williamr@2: const size_type* extents) : williamr@2: base_(base), storage_(so), origin_offset_(0), directional_offset_(0) williamr@2: { williamr@2: // If index_bases or extents is null, then initialize the corresponding williamr@2: // private data to zeroed lists. williamr@2: if(index_bases) { williamr@2: boost::detail::multi_array:: williamr@2: copy_n(index_bases,NumDims,index_base_list_.begin()); williamr@2: } else { williamr@2: std::fill_n(index_base_list_.begin(),NumDims,0); williamr@2: } williamr@2: if(extents) { williamr@2: init_multi_array_ref(extents); williamr@2: } else { williamr@2: boost::array extent_list; williamr@2: extent_list.assign(0); williamr@2: init_multi_array_ref(extent_list.begin()); williamr@2: } williamr@2: } williamr@2: williamr@2: williamr@2: TPtr base_; williamr@2: storage_order_type storage_; williamr@2: size_list extent_list_; williamr@2: index_list stride_list_; williamr@2: index_list index_base_list_; williamr@2: index origin_offset_; williamr@2: index directional_offset_; williamr@2: size_type num_elements_; williamr@2: williamr@2: private: williamr@2: // const_multi_array_ref cannot be assigned to (no deep copies!) williamr@2: const_multi_array_ref& operator=(const const_multi_array_ref& other); williamr@2: williamr@2: void init_from_extent_gen(const williamr@2: detail::multi_array:: williamr@2: extent_gen& ranges) { williamr@2: williamr@2: typedef boost::array extent_list; williamr@2: williamr@2: // get the index_base values williamr@2: std::transform(ranges.ranges_.begin(),ranges.ranges_.end(), williamr@2: index_base_list_.begin(), williamr@2: boost::mem_fun_ref(&extent_range::start)); williamr@2: williamr@2: // calculate the extents williamr@2: extent_list extents; williamr@2: std::transform(ranges.ranges_.begin(),ranges.ranges_.end(), williamr@2: extents.begin(), williamr@2: boost::mem_fun_ref(&extent_range::size)); williamr@2: williamr@2: init_multi_array_ref(extents.begin()); williamr@2: } williamr@2: williamr@2: williamr@2: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS williamr@2: protected: williamr@2: #else williamr@2: public: williamr@2: #endif williamr@2: // RG - move me! williamr@2: template williamr@2: void init_multi_array_ref(InputIterator extents_iter) { williamr@2: boost::function_requires >(); williamr@2: williamr@2: boost::detail::multi_array:: williamr@2: copy_n(extents_iter,num_dimensions(),extent_list_.begin()); williamr@2: williamr@2: // Calculate the array size williamr@2: num_elements_ = std::accumulate(extent_list_.begin(),extent_list_.end(), williamr@2: size_type(1),std::multiplies()); williamr@2: williamr@2: this->compute_strides(stride_list_,extent_list_,storage_); williamr@2: williamr@2: origin_offset_ = williamr@2: this->calculate_origin_offset(stride_list_,extent_list_, williamr@2: storage_,index_base_list_); williamr@2: directional_offset_ = williamr@2: this->calculate_descending_dimension_offset(stride_list_,extent_list_, williamr@2: storage_); williamr@2: } williamr@2: }; williamr@2: williamr@2: template williamr@2: class multi_array_ref : williamr@2: public const_multi_array_ref williamr@2: { williamr@2: typedef const_multi_array_ref super_type; williamr@2: public: williamr@2: typedef typename super_type::value_type value_type; williamr@2: typedef typename super_type::reference reference; 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: 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: typedef typename super_type::storage_order_type storage_order_type; williamr@2: typedef typename super_type::index_list index_list; williamr@2: typedef typename super_type::size_list size_list; williamr@2: williamr@2: template williamr@2: struct const_array_view { williamr@2: typedef boost::detail::multi_array::const_multi_array_view type; williamr@2: }; williamr@2: williamr@2: template williamr@2: struct array_view { williamr@2: typedef boost::detail::multi_array::multi_array_view type; williamr@2: }; williamr@2: williamr@2: template williamr@2: explicit multi_array_ref(T* base, const ExtentList& extents) : williamr@2: super_type(base,extents) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: } williamr@2: williamr@2: template williamr@2: explicit multi_array_ref(T* base, const ExtentList& extents, williamr@2: const general_storage_order& so) : williamr@2: super_type(base,extents,so) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: } williamr@2: williamr@2: williamr@2: explicit multi_array_ref(T* base, williamr@2: const detail::multi_array:: williamr@2: extent_gen& ranges) : williamr@2: super_type(base,ranges) { } williamr@2: williamr@2: williamr@2: explicit multi_array_ref(T* base, williamr@2: const detail::multi_array:: williamr@2: extent_gen& williamr@2: ranges, williamr@2: const general_storage_order& so) : williamr@2: super_type(base,ranges,so) { } williamr@2: williamr@2: williamr@2: // Assignment from other ConstMultiArray types. williamr@2: template williamr@2: multi_array_ref& operator=(const ConstMultiArray& other) { williamr@2: function_requires< williamr@2: detail::multi_array:: williamr@2: ConstMultiArrayConcept >(); 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(),this->begin()); williamr@2: return *this; williamr@2: } williamr@2: williamr@2: multi_array_ref& operator=(const multi_array_ref& other) { williamr@2: if (&other != this) { williamr@2: // make sure the dimensions agree williamr@2: 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(),this->begin()); williamr@2: } williamr@2: return *this; williamr@2: } williamr@2: williamr@2: element* origin() { return super_type::base_+super_type::origin_offset_; } williamr@2: williamr@2: element* data() { return super_type::base_; } williamr@2: williamr@2: template williamr@2: element& operator()(const IndexList& indices) { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: return super_type::access_element(boost::type(), williamr@2: indices,origin(), williamr@2: this->shape(),this->strides(), williamr@2: this->index_bases()); williamr@2: } williamr@2: williamr@2: williamr@2: reference operator[](index idx) { williamr@2: return super_type::access(boost::type(), williamr@2: idx,origin(), williamr@2: this->shape(),this->strides(), williamr@2: this->index_bases()); williamr@2: } williamr@2: williamr@2: williamr@2: // See note attached to generate_array_view in base.hpp williamr@2: #if !defined(BOOST_MSVC) || BOOST_MSVC > 1300 williamr@2: template williamr@2: #else williamr@2: template // else ICE williamr@2: #endif // BOOST_MSVC williamr@2: typename array_view::type williamr@2: operator[](const detail::multi_array:: williamr@2: index_gen& indices) { williamr@2: typedef typename array_view::type return_type; williamr@2: return williamr@2: super_type::generate_array_view(boost::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: williamr@2: iterator begin() { williamr@2: return iterator(*this->index_bases(),origin(),this->shape(), williamr@2: 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(), williamr@2: this->index_bases()); williamr@2: } williamr@2: williamr@2: // 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: // Using declarations don't seem to work for g++ williamr@2: // These are the proxies to work around this. williamr@2: williamr@2: const element* origin() const { return super_type::origin(); } williamr@2: const element* data() const { return super_type::data(); } williamr@2: williamr@2: template williamr@2: const element& operator()(const IndexList& indices) const { williamr@2: boost::function_requires< williamr@2: detail::multi_array::CollectionConcept >(); williamr@2: return super_type::operator()(indices); williamr@2: } williamr@2: williamr@2: const_reference operator[](index idx) const { williamr@2: return super_type::access(boost::type(), williamr@2: idx,origin(), williamr@2: this->shape(),this->strides(), williamr@2: this->index_bases()); williamr@2: } williamr@2: williamr@2: // See note attached to generate_array_view in base.hpp williamr@2: #if !defined(BOOST_MSVC) || BOOST_MSVC > 1300 williamr@2: template williamr@2: #else williamr@2: template // else ICE williamr@2: #endif // BOOST_MSVC williamr@2: typename const_array_view::type williamr@2: operator[](const detail::multi_array:: williamr@2: index_gen& 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: protected: williamr@2: // This is only supplied to support multi_array's default constructor williamr@2: explicit multi_array_ref(T* base, williamr@2: const storage_order_type& so, williamr@2: const index* index_bases, williamr@2: const size_type* extents) : williamr@2: super_type(base,so,index_bases,extents) { } williamr@2: williamr@2: }; williamr@2: williamr@2: } // namespace boost williamr@2: williamr@2: #endif // BOOST_MULTI_ARRAY_REF_RG071801_HPP