1*e4b17023SJohn Marino // The template and inlines for the -*- C++ -*- slice_array class.
2*e4b17023SJohn Marino
3*e4b17023SJohn Marino // Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005, 2006, 2009,
4*e4b17023SJohn Marino // 2010, 2011 Free Software Foundation, Inc.
5*e4b17023SJohn Marino //
6*e4b17023SJohn Marino // This file is part of the GNU ISO C++ Library. This library is free
7*e4b17023SJohn Marino // software; you can redistribute it and/or modify it under the
8*e4b17023SJohn Marino // terms of the GNU General Public License as published by the
9*e4b17023SJohn Marino // Free Software Foundation; either version 3, or (at your option)
10*e4b17023SJohn Marino // any later version.
11*e4b17023SJohn Marino
12*e4b17023SJohn Marino // This library is distributed in the hope that it will be useful,
13*e4b17023SJohn Marino // but WITHOUT ANY WARRANTY; without even the implied warranty of
14*e4b17023SJohn Marino // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15*e4b17023SJohn Marino // GNU General Public License for more details.
16*e4b17023SJohn Marino
17*e4b17023SJohn Marino // Under Section 7 of GPL version 3, you are granted additional
18*e4b17023SJohn Marino // permissions described in the GCC Runtime Library Exception, version
19*e4b17023SJohn Marino // 3.1, as published by the Free Software Foundation.
20*e4b17023SJohn Marino
21*e4b17023SJohn Marino // You should have received a copy of the GNU General Public License and
22*e4b17023SJohn Marino // a copy of the GCC Runtime Library Exception along with this program;
23*e4b17023SJohn Marino // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
24*e4b17023SJohn Marino // <http://www.gnu.org/licenses/>.
25*e4b17023SJohn Marino
26*e4b17023SJohn Marino /** @file bits/slice_array.h
27*e4b17023SJohn Marino * This is an internal header file, included by other library headers.
28*e4b17023SJohn Marino * Do not attempt to use it directly. @headername{valarray}
29*e4b17023SJohn Marino */
30*e4b17023SJohn Marino
31*e4b17023SJohn Marino // Written by Gabriel Dos Reis <Gabriel.Dos-Reis@DPTMaths.ENS-Cachan.Fr>
32*e4b17023SJohn Marino
33*e4b17023SJohn Marino #ifndef _SLICE_ARRAY_H
34*e4b17023SJohn Marino #define _SLICE_ARRAY_H 1
35*e4b17023SJohn Marino
36*e4b17023SJohn Marino #pragma GCC system_header
37*e4b17023SJohn Marino
_GLIBCXX_VISIBILITY(default)38*e4b17023SJohn Marino namespace std _GLIBCXX_VISIBILITY(default)
39*e4b17023SJohn Marino {
40*e4b17023SJohn Marino _GLIBCXX_BEGIN_NAMESPACE_VERSION
41*e4b17023SJohn Marino
42*e4b17023SJohn Marino /**
43*e4b17023SJohn Marino * @addtogroup numeric_arrays
44*e4b17023SJohn Marino * @{
45*e4b17023SJohn Marino */
46*e4b17023SJohn Marino
47*e4b17023SJohn Marino /**
48*e4b17023SJohn Marino * @brief Class defining one-dimensional subset of an array.
49*e4b17023SJohn Marino *
50*e4b17023SJohn Marino * The slice class represents a one-dimensional subset of an array,
51*e4b17023SJohn Marino * specified by three parameters: start offset, size, and stride. The
52*e4b17023SJohn Marino * start offset is the index of the first element of the array that is part
53*e4b17023SJohn Marino * of the subset. The size is the total number of elements in the subset.
54*e4b17023SJohn Marino * Stride is the distance between each successive array element to include
55*e4b17023SJohn Marino * in the subset.
56*e4b17023SJohn Marino *
57*e4b17023SJohn Marino * For example, with an array of size 10, and a slice with offset 1, size 3
58*e4b17023SJohn Marino * and stride 2, the subset consists of array elements 1, 3, and 5.
59*e4b17023SJohn Marino */
60*e4b17023SJohn Marino class slice
61*e4b17023SJohn Marino {
62*e4b17023SJohn Marino public:
63*e4b17023SJohn Marino /// Construct an empty slice.
64*e4b17023SJohn Marino slice();
65*e4b17023SJohn Marino
66*e4b17023SJohn Marino /**
67*e4b17023SJohn Marino * @brief Construct a slice.
68*e4b17023SJohn Marino *
69*e4b17023SJohn Marino * @param __o Offset in array of first element.
70*e4b17023SJohn Marino * @param __d Number of elements in slice.
71*e4b17023SJohn Marino * @param __s Stride between array elements.
72*e4b17023SJohn Marino */
73*e4b17023SJohn Marino slice(size_t __o, size_t __d, size_t __s);
74*e4b17023SJohn Marino
75*e4b17023SJohn Marino /// Return array offset of first slice element.
76*e4b17023SJohn Marino size_t start() const;
77*e4b17023SJohn Marino /// Return size of slice.
78*e4b17023SJohn Marino size_t size() const;
79*e4b17023SJohn Marino /// Return array stride of slice.
80*e4b17023SJohn Marino size_t stride() const;
81*e4b17023SJohn Marino
82*e4b17023SJohn Marino private:
83*e4b17023SJohn Marino size_t _M_off; // offset
84*e4b17023SJohn Marino size_t _M_sz; // size
85*e4b17023SJohn Marino size_t _M_st; // stride unit
86*e4b17023SJohn Marino };
87*e4b17023SJohn Marino
88*e4b17023SJohn Marino // _GLIBCXX_RESOLVE_LIB_DEFECTS
89*e4b17023SJohn Marino // 543. valarray slice default constructor
90*e4b17023SJohn Marino inline
91*e4b17023SJohn Marino slice::slice()
92*e4b17023SJohn Marino : _M_off(0), _M_sz(0), _M_st(0) {}
93*e4b17023SJohn Marino
94*e4b17023SJohn Marino inline
95*e4b17023SJohn Marino slice::slice(size_t __o, size_t __d, size_t __s)
96*e4b17023SJohn Marino : _M_off(__o), _M_sz(__d), _M_st(__s) {}
97*e4b17023SJohn Marino
98*e4b17023SJohn Marino inline size_t
99*e4b17023SJohn Marino slice::start() const
100*e4b17023SJohn Marino { return _M_off; }
101*e4b17023SJohn Marino
102*e4b17023SJohn Marino inline size_t
103*e4b17023SJohn Marino slice::size() const
104*e4b17023SJohn Marino { return _M_sz; }
105*e4b17023SJohn Marino
106*e4b17023SJohn Marino inline size_t
107*e4b17023SJohn Marino slice::stride() const
108*e4b17023SJohn Marino { return _M_st; }
109*e4b17023SJohn Marino
110*e4b17023SJohn Marino /**
111*e4b17023SJohn Marino * @brief Reference to one-dimensional subset of an array.
112*e4b17023SJohn Marino *
113*e4b17023SJohn Marino * A slice_array is a reference to the actual elements of an array
114*e4b17023SJohn Marino * specified by a slice. The way to get a slice_array is to call
115*e4b17023SJohn Marino * operator[](slice) on a valarray. The returned slice_array then permits
116*e4b17023SJohn Marino * carrying operations out on the referenced subset of elements in the
117*e4b17023SJohn Marino * original valarray. For example, operator+=(valarray) will add values
118*e4b17023SJohn Marino * to the subset of elements in the underlying valarray this slice_array
119*e4b17023SJohn Marino * refers to.
120*e4b17023SJohn Marino *
121*e4b17023SJohn Marino * @param Tp Element type.
122*e4b17023SJohn Marino */
123*e4b17023SJohn Marino template<typename _Tp>
124*e4b17023SJohn Marino class slice_array
125*e4b17023SJohn Marino {
126*e4b17023SJohn Marino public:
127*e4b17023SJohn Marino typedef _Tp value_type;
128*e4b17023SJohn Marino
129*e4b17023SJohn Marino // _GLIBCXX_RESOLVE_LIB_DEFECTS
130*e4b17023SJohn Marino // 253. valarray helper functions are almost entirely useless
131*e4b17023SJohn Marino
132*e4b17023SJohn Marino /// Copy constructor. Both slices refer to the same underlying array.
133*e4b17023SJohn Marino slice_array(const slice_array&);
134*e4b17023SJohn Marino
135*e4b17023SJohn Marino /// Assignment operator. Assigns slice elements to corresponding
136*e4b17023SJohn Marino /// elements of @a a.
137*e4b17023SJohn Marino slice_array& operator=(const slice_array&);
138*e4b17023SJohn Marino
139*e4b17023SJohn Marino /// Assign slice elements to corresponding elements of @a v.
140*e4b17023SJohn Marino void operator=(const valarray<_Tp>&) const;
141*e4b17023SJohn Marino /// Multiply slice elements by corresponding elements of @a v.
142*e4b17023SJohn Marino void operator*=(const valarray<_Tp>&) const;
143*e4b17023SJohn Marino /// Divide slice elements by corresponding elements of @a v.
144*e4b17023SJohn Marino void operator/=(const valarray<_Tp>&) const;
145*e4b17023SJohn Marino /// Modulo slice elements by corresponding elements of @a v.
146*e4b17023SJohn Marino void operator%=(const valarray<_Tp>&) const;
147*e4b17023SJohn Marino /// Add corresponding elements of @a v to slice elements.
148*e4b17023SJohn Marino void operator+=(const valarray<_Tp>&) const;
149*e4b17023SJohn Marino /// Subtract corresponding elements of @a v from slice elements.
150*e4b17023SJohn Marino void operator-=(const valarray<_Tp>&) const;
151*e4b17023SJohn Marino /// Logical xor slice elements with corresponding elements of @a v.
152*e4b17023SJohn Marino void operator^=(const valarray<_Tp>&) const;
153*e4b17023SJohn Marino /// Logical and slice elements with corresponding elements of @a v.
154*e4b17023SJohn Marino void operator&=(const valarray<_Tp>&) const;
155*e4b17023SJohn Marino /// Logical or slice elements with corresponding elements of @a v.
156*e4b17023SJohn Marino void operator|=(const valarray<_Tp>&) const;
157*e4b17023SJohn Marino /// Left shift slice elements by corresponding elements of @a v.
158*e4b17023SJohn Marino void operator<<=(const valarray<_Tp>&) const;
159*e4b17023SJohn Marino /// Right shift slice elements by corresponding elements of @a v.
160*e4b17023SJohn Marino void operator>>=(const valarray<_Tp>&) const;
161*e4b17023SJohn Marino /// Assign all slice elements to @a t.
162*e4b17023SJohn Marino void operator=(const _Tp &) const;
163*e4b17023SJohn Marino // ~slice_array ();
164*e4b17023SJohn Marino
165*e4b17023SJohn Marino template<class _Dom>
166*e4b17023SJohn Marino void operator=(const _Expr<_Dom, _Tp>&) const;
167*e4b17023SJohn Marino template<class _Dom>
168*e4b17023SJohn Marino void operator*=(const _Expr<_Dom, _Tp>&) const;
169*e4b17023SJohn Marino template<class _Dom>
170*e4b17023SJohn Marino void operator/=(const _Expr<_Dom, _Tp>&) const;
171*e4b17023SJohn Marino template<class _Dom>
172*e4b17023SJohn Marino void operator%=(const _Expr<_Dom, _Tp>&) const;
173*e4b17023SJohn Marino template<class _Dom>
174*e4b17023SJohn Marino void operator+=(const _Expr<_Dom, _Tp>&) const;
175*e4b17023SJohn Marino template<class _Dom>
176*e4b17023SJohn Marino void operator-=(const _Expr<_Dom, _Tp>&) const;
177*e4b17023SJohn Marino template<class _Dom>
178*e4b17023SJohn Marino void operator^=(const _Expr<_Dom, _Tp>&) const;
179*e4b17023SJohn Marino template<class _Dom>
180*e4b17023SJohn Marino void operator&=(const _Expr<_Dom, _Tp>&) const;
181*e4b17023SJohn Marino template<class _Dom>
182*e4b17023SJohn Marino void operator|=(const _Expr<_Dom, _Tp>&) const;
183*e4b17023SJohn Marino template<class _Dom>
184*e4b17023SJohn Marino void operator<<=(const _Expr<_Dom, _Tp>&) const;
185*e4b17023SJohn Marino template<class _Dom>
186*e4b17023SJohn Marino void operator>>=(const _Expr<_Dom, _Tp>&) const;
187*e4b17023SJohn Marino
188*e4b17023SJohn Marino private:
189*e4b17023SJohn Marino friend class valarray<_Tp>;
190*e4b17023SJohn Marino slice_array(_Array<_Tp>, const slice&);
191*e4b17023SJohn Marino
192*e4b17023SJohn Marino const size_t _M_sz;
193*e4b17023SJohn Marino const size_t _M_stride;
194*e4b17023SJohn Marino const _Array<_Tp> _M_array;
195*e4b17023SJohn Marino
196*e4b17023SJohn Marino // not implemented
197*e4b17023SJohn Marino slice_array();
198*e4b17023SJohn Marino };
199*e4b17023SJohn Marino
200*e4b17023SJohn Marino template<typename _Tp>
201*e4b17023SJohn Marino inline
202*e4b17023SJohn Marino slice_array<_Tp>::slice_array(_Array<_Tp> __a, const slice& __s)
203*e4b17023SJohn Marino : _M_sz(__s.size()), _M_stride(__s.stride()),
204*e4b17023SJohn Marino _M_array(__a.begin() + __s.start()) {}
205*e4b17023SJohn Marino
206*e4b17023SJohn Marino template<typename _Tp>
207*e4b17023SJohn Marino inline
208*e4b17023SJohn Marino slice_array<_Tp>::slice_array(const slice_array<_Tp>& a)
209*e4b17023SJohn Marino : _M_sz(a._M_sz), _M_stride(a._M_stride), _M_array(a._M_array) {}
210*e4b17023SJohn Marino
211*e4b17023SJohn Marino // template<typename _Tp>
212*e4b17023SJohn Marino // inline slice_array<_Tp>::~slice_array () {}
213*e4b17023SJohn Marino
214*e4b17023SJohn Marino template<typename _Tp>
215*e4b17023SJohn Marino inline slice_array<_Tp>&
216*e4b17023SJohn Marino slice_array<_Tp>::operator=(const slice_array<_Tp>& __a)
217*e4b17023SJohn Marino {
218*e4b17023SJohn Marino std::__valarray_copy(__a._M_array, __a._M_sz, __a._M_stride,
219*e4b17023SJohn Marino _M_array, _M_stride);
220*e4b17023SJohn Marino return *this;
221*e4b17023SJohn Marino }
222*e4b17023SJohn Marino
223*e4b17023SJohn Marino template<typename _Tp>
224*e4b17023SJohn Marino inline void
225*e4b17023SJohn Marino slice_array<_Tp>::operator=(const _Tp& __t) const
226*e4b17023SJohn Marino { std::__valarray_fill(_M_array, _M_sz, _M_stride, __t); }
227*e4b17023SJohn Marino
228*e4b17023SJohn Marino template<typename _Tp>
229*e4b17023SJohn Marino inline void
230*e4b17023SJohn Marino slice_array<_Tp>::operator=(const valarray<_Tp>& __v) const
231*e4b17023SJohn Marino { std::__valarray_copy(_Array<_Tp>(__v), _M_array, _M_sz, _M_stride); }
232*e4b17023SJohn Marino
233*e4b17023SJohn Marino template<typename _Tp>
234*e4b17023SJohn Marino template<class _Dom>
235*e4b17023SJohn Marino inline void
236*e4b17023SJohn Marino slice_array<_Tp>::operator=(const _Expr<_Dom,_Tp>& __e) const
237*e4b17023SJohn Marino { std::__valarray_copy(__e, _M_sz, _M_array, _M_stride); }
238*e4b17023SJohn Marino
239*e4b17023SJohn Marino #undef _DEFINE_VALARRAY_OPERATOR
240*e4b17023SJohn Marino #define _DEFINE_VALARRAY_OPERATOR(_Op,_Name) \
241*e4b17023SJohn Marino template<typename _Tp> \
242*e4b17023SJohn Marino inline void \
243*e4b17023SJohn Marino slice_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const \
244*e4b17023SJohn Marino { \
245*e4b17023SJohn Marino _Array_augmented_##_Name(_M_array, _M_sz, _M_stride, _Array<_Tp>(__v));\
246*e4b17023SJohn Marino } \
247*e4b17023SJohn Marino \
248*e4b17023SJohn Marino template<typename _Tp> \
249*e4b17023SJohn Marino template<class _Dom> \
250*e4b17023SJohn Marino inline void \
251*e4b17023SJohn Marino slice_array<_Tp>::operator _Op##=(const _Expr<_Dom,_Tp>& __e) const\
252*e4b17023SJohn Marino { \
253*e4b17023SJohn Marino _Array_augmented_##_Name(_M_array, _M_stride, __e, _M_sz); \
254*e4b17023SJohn Marino }
255*e4b17023SJohn Marino
256*e4b17023SJohn Marino
257*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(*, __multiplies)
258*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(/, __divides)
259*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(%, __modulus)
260*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(+, __plus)
261*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(-, __minus)
262*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor)
263*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(&, __bitwise_and)
264*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(|, __bitwise_or)
265*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(<<, __shift_left)
266*e4b17023SJohn Marino _DEFINE_VALARRAY_OPERATOR(>>, __shift_right)
267*e4b17023SJohn Marino
268*e4b17023SJohn Marino #undef _DEFINE_VALARRAY_OPERATOR
269*e4b17023SJohn Marino
270*e4b17023SJohn Marino // @} group numeric_arrays
271*e4b17023SJohn Marino
272*e4b17023SJohn Marino _GLIBCXX_END_NAMESPACE_VERSION
273*e4b17023SJohn Marino } // namespace
274*e4b17023SJohn Marino
275*e4b17023SJohn Marino #endif /* _SLICE_ARRAY_H */
276