Chris@16: // Copyright 2002 The Trustees of Indiana University. Chris@16: Chris@16: // Use, modification and distribution is subject to the Boost Software Chris@16: // License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at Chris@16: // http://www.boost.org/LICENSE_1_0.txt) Chris@16: Chris@16: // Boost.MultiArray Library Chris@16: // Authors: Ronald Garcia Chris@16: // Jeremy Siek Chris@16: // Andrew Lumsdaine Chris@16: // See http://www.boost.org/libs/multi_array for documentation. Chris@16: Chris@16: #ifndef BOOST_MULTI_ARRAY_REF_RG071801_HPP Chris@16: #define BOOST_MULTI_ARRAY_REF_RG071801_HPP Chris@16: Chris@16: // Chris@16: // multi_array_ref.hpp - code for creating "views" of array data. Chris@16: // Chris@16: Chris@16: #include "boost/multi_array/base.hpp" Chris@16: #include "boost/multi_array/collection_concept.hpp" Chris@16: #include "boost/multi_array/concept_checks.hpp" Chris@16: #include "boost/multi_array/iterator.hpp" Chris@16: #include "boost/multi_array/storage_order.hpp" Chris@16: #include "boost/multi_array/subarray.hpp" Chris@16: #include "boost/multi_array/view.hpp" Chris@16: #include "boost/multi_array/algorithm.hpp" Chris@16: #include "boost/type_traits/is_integral.hpp" Chris@16: #include "boost/utility/enable_if.hpp" Chris@16: #include "boost/array.hpp" Chris@16: #include "boost/concept_check.hpp" Chris@16: #include "boost/functional.hpp" Chris@16: #include "boost/limits.hpp" Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: #include Chris@16: Chris@16: namespace boost { Chris@16: Chris@16: template Chris@16: class const_multi_array_ref : Chris@16: public detail::multi_array::multi_array_impl_base Chris@16: { Chris@16: typedef detail::multi_array::multi_array_impl_base super_type; Chris@16: public: Chris@16: typedef typename super_type::value_type value_type; Chris@16: typedef typename super_type::const_reference const_reference; Chris@16: typedef typename super_type::const_iterator const_iterator; Chris@16: typedef typename super_type::const_reverse_iterator const_reverse_iterator; Chris@16: typedef typename super_type::element element; Chris@16: typedef typename super_type::size_type size_type; Chris@16: typedef typename super_type::difference_type difference_type; Chris@16: typedef typename super_type::index index; Chris@16: typedef typename super_type::extent_range extent_range; Chris@16: typedef general_storage_order storage_order_type; Chris@16: Chris@16: // template typedefs Chris@16: template Chris@16: struct const_array_view { Chris@16: typedef boost::detail::multi_array::const_multi_array_view type; Chris@16: }; Chris@16: Chris@16: template Chris@16: struct array_view { Chris@16: typedef boost::detail::multi_array::multi_array_view type; Chris@16: }; Chris@16: Chris@16: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS Chris@16: // make const_multi_array_ref a friend of itself Chris@16: template Chris@16: friend class const_multi_array_ref; Chris@16: #endif Chris@16: Chris@16: // This ensures that const_multi_array_ref types with different TPtr Chris@16: // types can convert to each other Chris@16: template Chris@16: const_multi_array_ref(const const_multi_array_ref& other) Chris@16: : base_(other.base_), storage_(other.storage_), Chris@16: extent_list_(other.extent_list_), Chris@16: stride_list_(other.stride_list_), Chris@16: index_base_list_(other.index_base_list_), Chris@16: origin_offset_(other.origin_offset_), Chris@16: directional_offset_(other.directional_offset_), Chris@16: num_elements_(other.num_elements_) { } Chris@16: Chris@16: template Chris@16: explicit const_multi_array_ref(TPtr base, const ExtentList& extents) : Chris@16: base_(base), storage_(c_storage_order()) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: Chris@16: index_base_list_.assign(0); Chris@16: init_multi_array_ref(extents.begin()); Chris@16: } Chris@16: Chris@16: template Chris@16: explicit const_multi_array_ref(TPtr base, const ExtentList& extents, Chris@16: const general_storage_order& so) : Chris@16: base_(base), storage_(so) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: Chris@16: index_base_list_.assign(0); Chris@16: init_multi_array_ref(extents.begin()); Chris@16: } Chris@16: Chris@16: explicit const_multi_array_ref(TPtr base, Chris@16: const detail::multi_array:: Chris@16: extent_gen& ranges) : Chris@16: base_(base), storage_(c_storage_order()) { Chris@16: Chris@16: init_from_extent_gen(ranges); Chris@16: } Chris@16: Chris@16: explicit const_multi_array_ref(TPtr base, Chris@16: const detail::multi_array:: Chris@16: extent_gen& ranges, Chris@16: const general_storage_order& so) : Chris@16: base_(base), storage_(so) { Chris@16: Chris@16: init_from_extent_gen(ranges); Chris@16: } Chris@16: Chris@16: template Chris@16: void assign(InputIterator begin, InputIterator end) { Chris@16: boost::function_requires >(); Chris@16: Chris@16: InputIterator in_iter = begin; Chris@16: T* out_iter = base_; Chris@16: std::size_t copy_count=0; Chris@16: while (in_iter != end && copy_count < num_elements_) { Chris@16: *out_iter++ = *in_iter++; Chris@16: copy_count++; Chris@16: } Chris@16: } Chris@16: Chris@16: template Chris@16: #ifdef BOOST_NO_SFINAE Chris@16: void Chris@16: #else Chris@16: typename Chris@16: disable_if::type,void >::type Chris@16: #endif // BOOST_NO_SFINAE Chris@16: reindex(const BaseList& values) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: boost::detail::multi_array:: Chris@16: copy_n(values.begin(),num_dimensions(),index_base_list_.begin()); Chris@16: origin_offset_ = Chris@16: this->calculate_origin_offset(stride_list_,extent_list_, Chris@16: storage_,index_base_list_); Chris@16: } Chris@16: Chris@16: void reindex(index value) { Chris@16: index_base_list_.assign(value); Chris@16: origin_offset_ = Chris@16: this->calculate_origin_offset(stride_list_,extent_list_, Chris@16: storage_,index_base_list_); Chris@16: } Chris@16: Chris@16: template Chris@16: void reshape(const SizeList& extents) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: BOOST_ASSERT(num_elements_ == Chris@16: std::accumulate(extents.begin(),extents.end(), Chris@16: size_type(1),std::multiplies())); Chris@16: Chris@16: std::copy(extents.begin(),extents.end(),extent_list_.begin()); Chris@16: this->compute_strides(stride_list_,extent_list_,storage_); Chris@16: Chris@16: origin_offset_ = Chris@16: this->calculate_origin_offset(stride_list_,extent_list_, Chris@16: storage_,index_base_list_); Chris@16: } Chris@16: Chris@16: size_type num_dimensions() const { return NumDims; } Chris@16: Chris@16: size_type size() const { return extent_list_.front(); } Chris@16: Chris@16: // given reshaping functionality, this is the max possible size. Chris@16: size_type max_size() const { return num_elements(); } Chris@16: Chris@16: bool empty() const { return size() == 0; } Chris@16: Chris@16: const size_type* shape() const { Chris@16: return extent_list_.data(); Chris@16: } Chris@16: Chris@16: const index* strides() const { Chris@16: return stride_list_.data(); Chris@16: } Chris@16: Chris@16: const element* origin() const { return base_+origin_offset_; } Chris@16: const element* data() const { return base_; } Chris@16: Chris@16: size_type num_elements() const { return num_elements_; } Chris@16: Chris@16: const index* index_bases() const { Chris@16: return index_base_list_.data(); Chris@16: } Chris@16: Chris@16: Chris@16: const storage_order_type& storage_order() const { Chris@16: return storage_; Chris@16: } Chris@16: Chris@16: template Chris@16: const element& operator()(IndexList indices) const { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: return super_type::access_element(boost::type(), Chris@16: indices,origin(), Chris@16: shape(),strides(),index_bases()); Chris@16: } Chris@16: Chris@16: // Only allow const element access Chris@16: const_reference operator[](index idx) const { Chris@16: return super_type::access(boost::type(), Chris@16: idx,origin(), Chris@16: shape(),strides(),index_bases()); Chris@16: } Chris@16: Chris@16: // see generate_array_view in base.hpp Chris@16: template Chris@16: typename const_array_view::type Chris@16: operator[](const detail::multi_array:: Chris@16: index_gen& indices) Chris@16: const { Chris@16: typedef typename const_array_view::type return_type; Chris@16: return Chris@16: super_type::generate_array_view(boost::type(), Chris@16: indices, Chris@16: shape(), Chris@16: strides(), Chris@16: index_bases(), Chris@16: origin()); Chris@16: } Chris@16: Chris@16: const_iterator begin() const { Chris@16: return const_iterator(*index_bases(),origin(), Chris@16: shape(),strides(),index_bases()); Chris@16: } Chris@16: Chris@16: const_iterator end() const { Chris@16: return const_iterator(*index_bases()+(index)*shape(),origin(), Chris@16: shape(),strides(),index_bases()); Chris@16: } Chris@16: Chris@16: const_reverse_iterator rbegin() const { Chris@16: return const_reverse_iterator(end()); Chris@16: } Chris@16: Chris@16: const_reverse_iterator rend() const { Chris@16: return const_reverse_iterator(begin()); Chris@16: } Chris@16: Chris@16: Chris@16: template Chris@16: bool operator==(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: if(std::equal(extent_list_.begin(), Chris@16: extent_list_.end(), Chris@16: rhs.extent_list_.begin())) Chris@16: return std::equal(begin(),end(),rhs.begin()); Chris@16: else return false; Chris@16: } Chris@16: Chris@16: template Chris@16: bool operator<(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: return std::lexicographical_compare(begin(),end(),rhs.begin(),rhs.end()); Chris@16: } Chris@16: Chris@16: template Chris@16: bool operator!=(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: return !(*this == rhs); Chris@16: } Chris@16: Chris@16: template Chris@16: bool operator>(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: return rhs < *this; Chris@16: } Chris@16: Chris@16: template Chris@16: bool operator<=(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: return !(*this > rhs); Chris@16: } Chris@16: Chris@16: template Chris@16: bool operator>=(const Chris@16: const_multi_array_ref& rhs) Chris@16: const { Chris@16: return !(*this < rhs); Chris@16: } Chris@16: Chris@16: Chris@16: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS Chris@16: protected: Chris@16: #else Chris@16: public: Chris@16: #endif Chris@16: Chris@16: typedef boost::array size_list; Chris@16: typedef boost::array index_list; Chris@16: Chris@16: // This is used by multi_array, which is a subclass of this Chris@16: void set_base_ptr(TPtr new_base) { base_ = new_base; } Chris@16: Chris@16: Chris@16: // This constructor supports multi_array's default constructor Chris@16: // and constructors from multi_array_ref, subarray, and array_view Chris@16: explicit Chris@16: const_multi_array_ref(TPtr base, Chris@16: const storage_order_type& so, Chris@16: const index * index_bases, Chris@16: const size_type* extents) : Chris@16: base_(base), storage_(so), origin_offset_(0), directional_offset_(0) Chris@16: { Chris@16: // If index_bases or extents is null, then initialize the corresponding Chris@16: // private data to zeroed lists. Chris@16: if(index_bases) { Chris@16: boost::detail::multi_array:: Chris@16: copy_n(index_bases,NumDims,index_base_list_.begin()); Chris@16: } else { Chris@16: std::fill_n(index_base_list_.begin(),NumDims,0); Chris@16: } Chris@16: if(extents) { Chris@16: init_multi_array_ref(extents); Chris@16: } else { Chris@16: boost::array extent_list; Chris@16: extent_list.assign(0); Chris@16: init_multi_array_ref(extent_list.begin()); Chris@16: } Chris@16: } Chris@16: Chris@16: Chris@16: TPtr base_; Chris@16: storage_order_type storage_; Chris@16: size_list extent_list_; Chris@16: index_list stride_list_; Chris@16: index_list index_base_list_; Chris@16: index origin_offset_; Chris@16: index directional_offset_; Chris@16: size_type num_elements_; Chris@16: Chris@16: private: Chris@16: // const_multi_array_ref cannot be assigned to (no deep copies!) Chris@16: const_multi_array_ref& operator=(const const_multi_array_ref& other); Chris@16: Chris@16: void init_from_extent_gen(const Chris@16: detail::multi_array:: Chris@16: extent_gen& ranges) { Chris@16: Chris@16: typedef boost::array extent_list; Chris@16: Chris@16: // get the index_base values Chris@16: std::transform(ranges.ranges_.begin(),ranges.ranges_.end(), Chris@16: index_base_list_.begin(), Chris@16: boost::mem_fun_ref(&extent_range::start)); Chris@16: Chris@16: // calculate the extents Chris@16: extent_list extents; Chris@16: std::transform(ranges.ranges_.begin(),ranges.ranges_.end(), Chris@16: extents.begin(), Chris@16: boost::mem_fun_ref(&extent_range::size)); Chris@16: Chris@16: init_multi_array_ref(extents.begin()); Chris@16: } Chris@16: Chris@16: Chris@16: #ifndef BOOST_NO_MEMBER_TEMPLATE_FRIENDS Chris@16: protected: Chris@16: #else Chris@16: public: Chris@16: #endif Chris@16: // RG - move me! Chris@16: template Chris@16: void init_multi_array_ref(InputIterator extents_iter) { Chris@16: boost::function_requires >(); Chris@16: Chris@16: boost::detail::multi_array:: Chris@16: copy_n(extents_iter,num_dimensions(),extent_list_.begin()); Chris@16: Chris@16: // Calculate the array size Chris@16: num_elements_ = std::accumulate(extent_list_.begin(),extent_list_.end(), Chris@16: size_type(1),std::multiplies()); Chris@16: Chris@16: this->compute_strides(stride_list_,extent_list_,storage_); Chris@16: Chris@16: origin_offset_ = Chris@16: this->calculate_origin_offset(stride_list_,extent_list_, Chris@16: storage_,index_base_list_); Chris@16: directional_offset_ = Chris@16: this->calculate_descending_dimension_offset(stride_list_,extent_list_, Chris@16: storage_); Chris@16: } Chris@16: }; Chris@16: Chris@16: template Chris@16: class multi_array_ref : Chris@16: public const_multi_array_ref Chris@16: { Chris@16: typedef const_multi_array_ref super_type; Chris@16: public: Chris@16: typedef typename super_type::value_type value_type; Chris@16: typedef typename super_type::reference reference; Chris@16: typedef typename super_type::iterator iterator; Chris@16: typedef typename super_type::reverse_iterator reverse_iterator; Chris@16: typedef typename super_type::const_reference const_reference; Chris@16: typedef typename super_type::const_iterator const_iterator; Chris@16: typedef typename super_type::const_reverse_iterator const_reverse_iterator; Chris@16: typedef typename super_type::element element; Chris@16: typedef typename super_type::size_type size_type; Chris@16: typedef typename super_type::difference_type difference_type; Chris@16: typedef typename super_type::index index; Chris@16: typedef typename super_type::extent_range extent_range; Chris@16: Chris@16: typedef typename super_type::storage_order_type storage_order_type; Chris@16: typedef typename super_type::index_list index_list; Chris@16: typedef typename super_type::size_list size_list; Chris@16: Chris@16: template Chris@16: struct const_array_view { Chris@16: typedef boost::detail::multi_array::const_multi_array_view type; Chris@16: }; Chris@16: Chris@16: template Chris@16: struct array_view { Chris@16: typedef boost::detail::multi_array::multi_array_view type; Chris@16: }; Chris@16: Chris@16: template Chris@16: explicit multi_array_ref(T* base, const ExtentList& extents) : Chris@16: super_type(base,extents) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: } Chris@16: Chris@16: template Chris@16: explicit multi_array_ref(T* base, const ExtentList& extents, Chris@16: const general_storage_order& so) : Chris@16: super_type(base,extents,so) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: } Chris@16: Chris@16: Chris@16: explicit multi_array_ref(T* base, Chris@16: const detail::multi_array:: Chris@16: extent_gen& ranges) : Chris@16: super_type(base,ranges) { } Chris@16: Chris@16: Chris@16: explicit multi_array_ref(T* base, Chris@16: const detail::multi_array:: Chris@16: extent_gen& Chris@16: ranges, Chris@16: const general_storage_order& so) : Chris@16: super_type(base,ranges,so) { } Chris@16: Chris@16: Chris@16: // Assignment from other ConstMultiArray types. Chris@16: template Chris@16: multi_array_ref& operator=(const ConstMultiArray& other) { Chris@16: function_requires< Chris@16: multi_array_concepts:: Chris@16: ConstMultiArrayConcept >(); Chris@16: Chris@16: // make sure the dimensions agree Chris@16: BOOST_ASSERT(other.num_dimensions() == this->num_dimensions()); Chris@16: BOOST_ASSERT(std::equal(other.shape(),other.shape()+this->num_dimensions(), Chris@16: this->shape())); Chris@16: // iterator-based copy Chris@16: std::copy(other.begin(),other.end(),this->begin()); Chris@16: return *this; Chris@16: } Chris@16: Chris@16: multi_array_ref& operator=(const multi_array_ref& other) { Chris@16: if (&other != this) { Chris@16: // make sure the dimensions agree Chris@16: Chris@16: BOOST_ASSERT(other.num_dimensions() == this->num_dimensions()); Chris@16: BOOST_ASSERT(std::equal(other.shape(), Chris@16: other.shape()+this->num_dimensions(), Chris@16: this->shape())); Chris@16: // iterator-based copy Chris@16: std::copy(other.begin(),other.end(),this->begin()); Chris@16: } Chris@16: return *this; Chris@16: } Chris@16: Chris@16: element* origin() { return super_type::base_+super_type::origin_offset_; } Chris@16: Chris@16: element* data() { return super_type::base_; } Chris@16: Chris@16: template Chris@16: element& operator()(const IndexList& indices) { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: return super_type::access_element(boost::type(), Chris@16: indices,origin(), Chris@16: this->shape(),this->strides(), Chris@16: this->index_bases()); Chris@16: } Chris@16: Chris@16: Chris@16: reference operator[](index idx) { Chris@16: return super_type::access(boost::type(), Chris@16: idx,origin(), Chris@16: this->shape(),this->strides(), Chris@16: this->index_bases()); Chris@16: } Chris@16: Chris@16: Chris@16: // See note attached to generate_array_view in base.hpp Chris@16: template Chris@16: typename array_view::type Chris@16: operator[](const detail::multi_array:: Chris@16: index_gen& indices) { Chris@16: typedef typename array_view::type return_type; Chris@16: return Chris@16: super_type::generate_array_view(boost::type(), Chris@16: indices, Chris@16: this->shape(), Chris@16: this->strides(), Chris@16: this->index_bases(), Chris@16: origin()); Chris@16: } Chris@16: Chris@16: Chris@16: iterator begin() { Chris@16: return iterator(*this->index_bases(),origin(),this->shape(), Chris@16: this->strides(),this->index_bases()); Chris@16: } Chris@16: Chris@16: iterator end() { Chris@16: return iterator(*this->index_bases()+(index)*this->shape(),origin(), Chris@16: this->shape(),this->strides(), Chris@16: this->index_bases()); Chris@16: } Chris@16: Chris@16: // rbegin() and rend() written naively to thwart MSVC ICE. Chris@16: reverse_iterator rbegin() { Chris@16: reverse_iterator ri(end()); Chris@16: return ri; Chris@16: } Chris@16: Chris@16: reverse_iterator rend() { Chris@16: reverse_iterator ri(begin()); Chris@16: return ri; Chris@16: } Chris@16: Chris@16: // Using declarations don't seem to work for g++ Chris@16: // These are the proxies to work around this. Chris@16: Chris@16: const element* origin() const { return super_type::origin(); } Chris@16: const element* data() const { return super_type::data(); } Chris@16: Chris@16: template Chris@16: const element& operator()(const IndexList& indices) const { Chris@16: boost::function_requires< Chris@16: CollectionConcept >(); Chris@16: return super_type::operator()(indices); Chris@16: } Chris@16: Chris@16: const_reference operator[](index idx) const { Chris@16: return super_type::access(boost::type(), Chris@16: idx,origin(), Chris@16: this->shape(),this->strides(), Chris@16: this->index_bases()); Chris@16: } Chris@16: Chris@16: // See note attached to generate_array_view in base.hpp Chris@16: template Chris@16: typename const_array_view::type Chris@16: operator[](const detail::multi_array:: Chris@16: index_gen& indices) Chris@16: const { Chris@16: return super_type::operator[](indices); Chris@16: } Chris@16: Chris@16: const_iterator begin() const { Chris@16: return super_type::begin(); Chris@16: } Chris@16: Chris@16: const_iterator end() const { Chris@16: return super_type::end(); Chris@16: } Chris@16: Chris@16: const_reverse_iterator rbegin() const { Chris@16: return super_type::rbegin(); Chris@16: } Chris@16: Chris@16: const_reverse_iterator rend() const { Chris@16: return super_type::rend(); Chris@16: } Chris@16: Chris@16: protected: Chris@16: // This is only supplied to support multi_array's default constructor Chris@16: explicit multi_array_ref(T* base, Chris@16: const storage_order_type& so, Chris@16: const index* index_bases, Chris@16: const size_type* extents) : Chris@16: super_type(base,so,index_bases,extents) { } Chris@16: Chris@16: }; Chris@16: Chris@16: } // namespace boost Chris@16: Chris@16: #endif // BOOST_MULTI_ARRAY_REF_RG071801_HPP