1 // The template and inlines for the -*- C++ -*- slice_array class.
3 // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004
4 // Free Software Foundation, Inc.
6 // This file is part of the GNU ISO C++ Library. This library is free
7 // software; you can redistribute it and/or modify it under the
8 // terms of the GNU General Public License as published by the
9 // Free Software Foundation; either version 2, or (at your option)
12 // This library is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 // GNU General Public License for more details.
17 // You should have received a copy of the GNU General Public License along
18 // with this library; see the file COPYING. If not, write to the Free
19 // Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307,
22 // As a special exception, you may use this file as part of a free software
23 // library without restriction. Specifically, if other files instantiate
24 // templates or use macros or inline functions from this file, or you compile
25 // this file and link it with other files to produce an executable, this
26 // file does not by itself cause the resulting executable to be covered by
27 // the GNU General Public License. This exception does not however
28 // invalidate any other reasons why the executable file might be covered by
29 // the GNU General Public License.
31 // Written by Gabriel Dos Reis <Gabriel.Dos-Reis@DPTMaths.ENS-Cachan.Fr>
33 /** @file slice_array.h
34 * This is an internal header file, included by other library headers.
35 * You should not attempt to use it directly.
38 #ifndef _SLICE_ARRAY_H
39 #define _SLICE_ARRAY_H 1
41 #pragma GCC system_header
46 * @brief Class defining one-dimensional subset of an array.
48 * The slice class represents a one-dimensional subset of an array,
49 * specified by three parameters: start offset, size, and stride. The
50 * start offset is the index of the first element of the array that is part
51 * of the subset. The size is the total number of elements in the subset.
52 * Stride is the distance between each successive array element to include
55 * For example, with an array of size 10, and a slice with offset 1, size 3
56 * and stride 2, the subset consists of array elements 1, 3, and 5.
61 /// Construct an empty slice.
65 * @brief Construct a slice.
67 * @param o Offset in array of first element.
68 * @param d Number of elements in slice.
69 * @param s Stride between array elements.
71 slice(size_t, size_t, size_t);
73 /// Return array offset of first slice element.
75 /// Return size of slice.
77 /// Return array stride of slice.
78 size_t stride() const;
81 size_t _M_off; // offset
83 size_t _M_st; // stride unit
86 // The default constructor constructor is not required to initialize
87 // data members with any meaningful values, so we choose to do nothing.
92 slice::slice(size_t __o, size_t __d, size_t __s)
93 : _M_off(__o), _M_sz(__d), _M_st(__s) {}
104 slice::stride() const
108 * @brief Reference to one-dimensional subset of an array.
110 * A slice_array is a reference to the actual elements of an array
111 * specified by a slice. The way to get a slice_array is to call
112 * operator[](slice) on a valarray. The returned slice_array then permits
113 * carrying operations out on the referenced subset of elements in the
114 * original valarray. For example, operator+=(valarray) will add values
115 * to the subset of elements in the underlying valarray this slice_array
118 * @param Tp Element type.
120 template<typename _Tp>
124 typedef _Tp value_type;
126 // This constructor is implemented since we need to return a value.
127 /// Copy constructor. Both slices refer to the same underlying array.
128 slice_array(const slice_array&);
130 // This operator must be public. See DR-253.
131 /// Assignment operator. Assigns slice elements to corresponding
132 /// elements of @a a.
133 slice_array& operator=(const slice_array&);
135 /// Assign slice elements to corresponding elements of @a v.
136 void operator=(const valarray<_Tp>&) const;
137 /// Multiply slice elements by corresponding elements of @a v.
138 void operator*=(const valarray<_Tp>&) const;
139 /// Divide slice elements by corresponding elements of @a v.
140 void operator/=(const valarray<_Tp>&) const;
141 /// Modulo slice elements by corresponding elements of @a v.
142 void operator%=(const valarray<_Tp>&) const;
143 /// Add corresponding elements of @a v to slice elements.
144 void operator+=(const valarray<_Tp>&) const;
145 /// Subtract corresponding elements of @a v from slice elements.
146 void operator-=(const valarray<_Tp>&) const;
147 /// Logical xor slice elements with corresponding elements of @a v.
148 void operator^=(const valarray<_Tp>&) const;
149 /// Logical and slice elements with corresponding elements of @a v.
150 void operator&=(const valarray<_Tp>&) const;
151 /// Logical or slice elements with corresponding elements of @a v.
152 void operator|=(const valarray<_Tp>&) const;
153 /// Left shift slice elements by corresponding elements of @a v.
154 void operator<<=(const valarray<_Tp>&) const;
155 /// Right shift slice elements by corresponding elements of @a v.
156 void operator>>=(const valarray<_Tp>&) const;
157 /// Assign all slice elements to @a t.
158 void operator=(const _Tp &) const;
162 void operator=(const _Expr<_Dom,_Tp>&) const;
164 void operator*=(const _Expr<_Dom,_Tp>&) const;
166 void operator/=(const _Expr<_Dom,_Tp>&) const;
168 void operator%=(const _Expr<_Dom,_Tp>&) const;
170 void operator+=(const _Expr<_Dom,_Tp>&) const;
172 void operator-=(const _Expr<_Dom,_Tp>&) const;
174 void operator^=(const _Expr<_Dom,_Tp>&) const;
176 void operator&=(const _Expr<_Dom,_Tp>&) const;
178 void operator|=(const _Expr<_Dom,_Tp>&) const;
180 void operator<<=(const _Expr<_Dom,_Tp>&) const;
182 void operator>>=(const _Expr<_Dom,_Tp>&) const;
185 friend class valarray<_Tp>;
186 slice_array(_Array<_Tp>, const slice&);
189 const size_t _M_stride;
190 const _Array<_Tp> _M_array;
196 template<typename _Tp>
198 slice_array<_Tp>::slice_array(_Array<_Tp> __a, const slice& __s)
199 : _M_sz(__s.size()), _M_stride(__s.stride()),
200 _M_array(__a.begin() + __s.start()) {}
202 template<typename _Tp>
204 slice_array<_Tp>::slice_array(const slice_array<_Tp>& a)
205 : _M_sz(a._M_sz), _M_stride(a._M_stride), _M_array(a._M_array) {}
207 // template<typename _Tp>
208 // inline slice_array<_Tp>::~slice_array () {}
210 template<typename _Tp>
211 inline slice_array<_Tp>&
212 slice_array<_Tp>::operator=(const slice_array<_Tp>& __a)
214 std::__valarray_copy(__a._M_array, __a._M_sz, __a._M_stride,
215 _M_array, _M_stride);
219 template<typename _Tp>
221 slice_array<_Tp>::operator=(const _Tp& __t) const
222 { std::__valarray_fill(_M_array, _M_sz, _M_stride, __t); }
224 template<typename _Tp>
226 slice_array<_Tp>::operator=(const valarray<_Tp>& __v) const
227 { std::__valarray_copy(_Array<_Tp>(__v), _M_array, _M_sz, _M_stride); }
229 template<typename _Tp>
232 slice_array<_Tp>::operator=(const _Expr<_Dom,_Tp>& __e) const
233 { std::__valarray_copy(__e, _M_sz, _M_array, _M_stride); }
235 #undef _DEFINE_VALARRAY_OPERATOR
236 #define _DEFINE_VALARRAY_OPERATOR(_Op,_Name) \
237 template<typename _Tp> \
239 slice_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const \
241 _Array_augmented_##_Name(_M_array, _M_sz, _M_stride, _Array<_Tp>(__v));\
244 template<typename _Tp> \
245 template<class _Dom> \
247 slice_array<_Tp>::operator _Op##=(const _Expr<_Dom,_Tp>& __e) const\
249 _Array_augmented_##_Name(_M_array, _M_stride, __e, _M_sz); \
253 _DEFINE_VALARRAY_OPERATOR(*, __multiplies)
254 _DEFINE_VALARRAY_OPERATOR(/, __divides)
255 _DEFINE_VALARRAY_OPERATOR(%, __modulus)
256 _DEFINE_VALARRAY_OPERATOR(+, __plus)
257 _DEFINE_VALARRAY_OPERATOR(-, __minus)
258 _DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor)
259 _DEFINE_VALARRAY_OPERATOR(&, __bitwise_and)
260 _DEFINE_VALARRAY_OPERATOR(|, __bitwise_or)
261 _DEFINE_VALARRAY_OPERATOR(<<, __shift_left)
262 _DEFINE_VALARRAY_OPERATOR(>>, __shift_right)
264 #undef _DEFINE_VALARRAY_OPERATOR
268 #endif /* _SLICE_ARRAY_H */