1 // The template and inlines for the -*- C++ -*- valarray class.
3 // Copyright (C) 1997-2023 Free Software Foundation, Inc.
5 // This file is part of the GNU ISO C++ Library. This library is free
6 // software; you can redistribute it and/or modify it under the
7 // terms of the GNU General Public License as published by the
8 // Free Software Foundation; either version 3, or (at your option)
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
16 // Under Section 7 of GPL version 3, you are granted additional
17 // permissions described in the GCC Runtime Library Exception, version
18 // 3.1, as published by the Free Software Foundation.
20 // You should have received a copy of the GNU General Public License and
21 // a copy of the GCC Runtime Library Exception along with this program;
22 // see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23 // <http://www.gnu.org/licenses/>.
25 /** @file include/valarray
26 * This is a Standard C++ Library header.
29 // Written by Gabriel Dos Reis <Gabriel.Dos-Reis@DPTMaths.ENS-Cachan.Fr>
31 #ifndef _GLIBCXX_VALARRAY
32 #define _GLIBCXX_VALARRAY 1
34 #pragma GCC system_header
36 #include <bits/requires_hosted.h> // <cmath> dependant
38 #include <bits/c++config.h>
41 #include <debug/debug.h>
42 #if __cplusplus >= 201103L
43 #include <initializer_list>
46 namespace std _GLIBCXX_VISIBILITY(default)
48 _GLIBCXX_BEGIN_NAMESPACE_VERSION
50 template<class _Clos, typename _Tp>
53 template<typename _Tp1, typename _Tp2>
58 template<class _Oper, template<class, class> class _Meta, class _Dom>
62 template<class, class> class _Meta1,
63 template<class, class> class _Meta2,
64 class _Dom1, class _Dom2>
67 template<template<class, class> class _Meta, class _Dom>
70 template<template<class, class> class _Meta, class _Dom>
73 template<template<class, class> class _Meta, class _Dom>
76 template<template<class, class> class _Meta, class _Dom>
79 template<template<class, class> class _Meta, class _Dom>
81 } // namespace __detail
83 using __detail::_UnClos;
84 using __detail::_BinClos;
85 using __detail::_SClos;
86 using __detail::_GClos;
87 using __detail::_IClos;
88 using __detail::_ValFunClos;
89 using __detail::_RefFunClos;
91 template<class _Tp> class valarray; // An array of type _Tp
92 class slice; // BLAS-like slice out of an array
93 template<class _Tp> class slice_array;
94 class gslice; // generalized slice out of an array
95 template<class _Tp> class gslice_array;
96 template<class _Tp> class mask_array; // masked array
97 template<class _Tp> class indirect_array; // indirected array
99 _GLIBCXX_END_NAMESPACE_VERSION
102 #include <bits/valarray_array.h>
103 #include <bits/valarray_before.h>
105 namespace std _GLIBCXX_VISIBILITY(default)
107 _GLIBCXX_BEGIN_NAMESPACE_VERSION
110 * @defgroup numeric_arrays Numeric Arrays
113 * Classes and functions for representing and manipulating arrays of elements.
118 * @brief Smart array designed to support numeric processing.
120 * A valarray is an array that provides constraints intended to allow for
121 * effective optimization of numeric array processing by reducing the
122 * aliasing that can result from pointer representations. It represents a
123 * one-dimensional array from which different multidimensional subsets can
124 * be accessed and modified.
126 * @tparam _Tp Type of object in the array.
134 typedef typename __fun<_Op, _Tp>::result_type __rt;
135 typedef _Expr<_UnClos<_Op, _ValArray, _Tp>, __rt> _Rt;
138 typedef _Tp value_type;
140 // _lib.valarray.cons_ construct/destroy:
141 /// Construct an empty array.
142 valarray() _GLIBCXX_NOTHROW;
144 /// Construct an array with @a n elements.
145 explicit valarray(size_t);
147 /// Construct an array with @a n elements initialized to @a t.
148 valarray(const _Tp&, size_t);
150 /// Construct an array initialized to the first @a n elements of @a t.
151 valarray(const _Tp* __restrict__, size_t);
153 /// Copy constructor.
154 valarray(const valarray&);
156 #if __cplusplus >= 201103L
157 /// Move constructor.
158 valarray(valarray&&) noexcept;
161 /// Construct an array with the same size and values in @a sa.
162 valarray(const slice_array<_Tp>&);
164 /// Construct an array with the same size and values in @a ga.
165 valarray(const gslice_array<_Tp>&);
167 /// Construct an array with the same size and values in @a ma.
168 valarray(const mask_array<_Tp>&);
170 /// Construct an array with the same size and values in @a ia.
171 valarray(const indirect_array<_Tp>&);
173 #if __cplusplus >= 201103L
174 /// Construct an array with an initializer_list of values.
175 valarray(initializer_list<_Tp>);
179 valarray(const _Expr<_Dom, _Tp>& __e);
181 ~valarray() _GLIBCXX_NOEXCEPT;
183 // _lib.valarray.assign_ assignment:
185 * @brief Assign elements to an array.
187 * Assign elements of array to values in @a v.
189 * @param __v Valarray to get values from.
191 valarray<_Tp>& operator=(const valarray<_Tp>& __v);
193 #if __cplusplus >= 201103L
195 * @brief Move assign elements to an array.
197 * Move assign elements of array to values in @a v.
199 * @param __v Valarray to get values from.
201 valarray<_Tp>& operator=(valarray<_Tp>&& __v) noexcept;
205 * @brief Assign elements to a value.
207 * Assign all elements of array to @a t.
209 * @param __t Value for elements.
211 valarray<_Tp>& operator=(const _Tp& __t);
214 * @brief Assign elements to an array subset.
216 * Assign elements of array to values in @a sa. Results are undefined
217 * if @a sa does not have the same size as this array.
219 * @param __sa Array slice to get values from.
221 valarray<_Tp>& operator=(const slice_array<_Tp>& __sa);
224 * @brief Assign elements to an array subset.
226 * Assign elements of array to values in @a ga. Results are undefined
227 * if @a ga does not have the same size as this array.
229 * @param __ga Array slice to get values from.
231 valarray<_Tp>& operator=(const gslice_array<_Tp>& __ga);
234 * @brief Assign elements to an array subset.
236 * Assign elements of array to values in @a ma. Results are undefined
237 * if @a ma does not have the same size as this array.
239 * @param __ma Array slice to get values from.
241 valarray<_Tp>& operator=(const mask_array<_Tp>& __ma);
244 * @brief Assign elements to an array subset.
246 * Assign elements of array to values in @a ia. Results are undefined
247 * if @a ia does not have the same size as this array.
249 * @param __ia Array slice to get values from.
251 valarray<_Tp>& operator=(const indirect_array<_Tp>& __ia);
253 #if __cplusplus >= 201103L
255 * @brief Assign elements to an initializer_list.
257 * Assign elements of array to values in @a __l. Results are undefined
258 * if @a __l does not have the same size as this array.
260 * @param __l initializer_list to get values from.
262 valarray& operator=(initializer_list<_Tp> __l);
265 template<class _Dom> valarray<_Tp>&
266 operator= (const _Expr<_Dom, _Tp>&);
268 // _lib.valarray.access_ element access:
270 * Return a reference to the i'th array element.
272 * @param __i Index of element to return.
273 * @return Reference to the i'th element.
275 _Tp& operator[](size_t __i) _GLIBCXX_NOTHROW;
277 // _GLIBCXX_RESOLVE_LIB_DEFECTS
278 // 389. Const overload of valarray::operator[] returns by value.
279 const _Tp& operator[](size_t) const _GLIBCXX_NOTHROW;
281 // _lib.valarray.sub_ subset operations:
283 * @brief Return an array subset.
285 * Returns a new valarray containing the elements of the array
286 * indicated by the slice argument. The new valarray has the same size
287 * as the input slice. @see slice.
289 * @param __s The source slice.
290 * @return New valarray containing elements in @a __s.
292 _Expr<_SClos<_ValArray, _Tp>, _Tp> operator[](slice __s) const;
295 * @brief Return a reference to an array subset.
297 * Returns a new valarray containing the elements of the array
298 * indicated by the slice argument. The new valarray has the same size
299 * as the input slice. @see slice.
301 * @param __s The source slice.
302 * @return New valarray containing elements in @a __s.
304 slice_array<_Tp> operator[](slice __s);
307 * @brief Return an array subset.
309 * Returns a slice_array referencing the elements of the array
310 * indicated by the slice argument. @see gslice.
312 * @param __s The source slice.
313 * @return Slice_array referencing elements indicated by @a __s.
315 _Expr<_GClos<_ValArray, _Tp>, _Tp> operator[](const gslice& __s) const;
318 * @brief Return a reference to an array subset.
320 * Returns a new valarray containing the elements of the array
321 * indicated by the gslice argument. The new valarray has
322 * the same size as the input gslice. @see gslice.
324 * @param __s The source gslice.
325 * @return New valarray containing elements in @a __s.
327 gslice_array<_Tp> operator[](const gslice& __s);
330 * @brief Return an array subset.
332 * Returns a new valarray containing the elements of the array
333 * indicated by the argument. The input is a valarray of bool which
334 * represents a bitmask indicating which elements should be copied into
335 * the new valarray. Each element of the array is added to the return
336 * valarray if the corresponding element of the argument is true.
338 * @param __m The valarray bitmask.
339 * @return New valarray containing elements indicated by @a __m.
341 valarray<_Tp> operator[](const valarray<bool>& __m) const;
344 * @brief Return a reference to an array subset.
346 * Returns a new mask_array referencing the elements of the array
347 * indicated by the argument. The input is a valarray of bool which
348 * represents a bitmask indicating which elements are part of the
349 * subset. Elements of the array are part of the subset if the
350 * corresponding element of the argument is true.
352 * @param __m The valarray bitmask.
353 * @return New valarray containing elements indicated by @a __m.
355 mask_array<_Tp> operator[](const valarray<bool>& __m);
358 * @brief Return an array subset.
360 * Returns a new valarray containing the elements of the array
361 * indicated by the argument. The elements in the argument are
362 * interpreted as the indices of elements of this valarray to copy to
363 * the return valarray.
365 * @param __i The valarray element index list.
366 * @return New valarray containing elements in @a __s.
368 _Expr<_IClos<_ValArray, _Tp>, _Tp>
369 operator[](const valarray<size_t>& __i) const;
372 * @brief Return a reference to an array subset.
374 * Returns an indirect_array referencing the elements of the array
375 * indicated by the argument. The elements in the argument are
376 * interpreted as the indices of elements of this valarray to include
377 * in the subset. The returned indirect_array refers to these
380 * @param __i The valarray element index list.
381 * @return Indirect_array referencing elements in @a __i.
383 indirect_array<_Tp> operator[](const valarray<size_t>& __i);
385 // _lib.valarray.unary_ unary operators:
386 /// Return a new valarray by applying unary + to each element.
387 typename _UnaryOp<__unary_plus>::_Rt operator+() const;
389 /// Return a new valarray by applying unary - to each element.
390 typename _UnaryOp<__negate>::_Rt operator-() const;
392 /// Return a new valarray by applying unary ~ to each element.
393 typename _UnaryOp<__bitwise_not>::_Rt operator~() const;
395 /// Return a new valarray by applying unary ! to each element.
396 typename _UnaryOp<__logical_not>::_Rt operator!() const;
398 // _lib.valarray.cassign_ computed assignment:
399 /// Multiply each element of array by @a t.
400 valarray<_Tp>& operator*=(const _Tp&);
402 /// Divide each element of array by @a t.
403 valarray<_Tp>& operator/=(const _Tp&);
405 /// Set each element e of array to e % @a t.
406 valarray<_Tp>& operator%=(const _Tp&);
408 /// Add @a t to each element of array.
409 valarray<_Tp>& operator+=(const _Tp&);
411 /// Subtract @a t to each element of array.
412 valarray<_Tp>& operator-=(const _Tp&);
414 /// Set each element e of array to e ^ @a t.
415 valarray<_Tp>& operator^=(const _Tp&);
417 /// Set each element e of array to e & @a t.
418 valarray<_Tp>& operator&=(const _Tp&);
420 /// Set each element e of array to e | @a t.
421 valarray<_Tp>& operator|=(const _Tp&);
423 /// Left shift each element e of array by @a t bits.
424 valarray<_Tp>& operator<<=(const _Tp&);
426 /// Right shift each element e of array by @a t bits.
427 valarray<_Tp>& operator>>=(const _Tp&);
429 /// Multiply elements of array by corresponding elements of @a v.
430 valarray<_Tp>& operator*=(const valarray<_Tp>&);
432 /// Divide elements of array by corresponding elements of @a v.
433 valarray<_Tp>& operator/=(const valarray<_Tp>&);
435 /// Modulo elements of array by corresponding elements of @a v.
436 valarray<_Tp>& operator%=(const valarray<_Tp>&);
438 /// Add corresponding elements of @a v to elements of array.
439 valarray<_Tp>& operator+=(const valarray<_Tp>&);
441 /// Subtract corresponding elements of @a v from elements of array.
442 valarray<_Tp>& operator-=(const valarray<_Tp>&);
444 /// Logical xor corresponding elements of @a v with elements of array.
445 valarray<_Tp>& operator^=(const valarray<_Tp>&);
447 /// Logical or corresponding elements of @a v with elements of array.
448 valarray<_Tp>& operator|=(const valarray<_Tp>&);
450 /// Logical and corresponding elements of @a v with elements of array.
451 valarray<_Tp>& operator&=(const valarray<_Tp>&);
453 /// Left shift elements of array by corresponding elements of @a v.
454 valarray<_Tp>& operator<<=(const valarray<_Tp>&);
456 /// Right shift elements of array by corresponding elements of @a v.
457 valarray<_Tp>& operator>>=(const valarray<_Tp>&);
460 valarray<_Tp>& operator*=(const _Expr<_Dom, _Tp>&);
462 valarray<_Tp>& operator/=(const _Expr<_Dom, _Tp>&);
464 valarray<_Tp>& operator%=(const _Expr<_Dom, _Tp>&);
466 valarray<_Tp>& operator+=(const _Expr<_Dom, _Tp>&);
468 valarray<_Tp>& operator-=(const _Expr<_Dom, _Tp>&);
470 valarray<_Tp>& operator^=(const _Expr<_Dom, _Tp>&);
472 valarray<_Tp>& operator|=(const _Expr<_Dom, _Tp>&);
474 valarray<_Tp>& operator&=(const _Expr<_Dom, _Tp>&);
476 valarray<_Tp>& operator<<=(const _Expr<_Dom, _Tp>&);
478 valarray<_Tp>& operator>>=(const _Expr<_Dom, _Tp>&);
480 // _lib.valarray.members_ member functions:
481 #if __cplusplus >= 201103L
483 void swap(valarray<_Tp>& __v) noexcept;
486 /// Return the number of elements in array.
490 * @brief Return the sum of all elements in the array.
492 * Accumulates the sum of all elements into a Tp using +=. The order
493 * of adding the elements is unspecified.
497 /// Return the minimum element using operator<().
500 /// Return the maximum element using operator<().
504 * @brief Return a shifted array.
506 * A new valarray is constructed as a copy of this array with elements
507 * in shifted positions. For an element with index i, the new position
508 * is i - n. The new valarray has the same size as the current one.
509 * New elements without a value are set to 0. Elements whose new
510 * position is outside the bounds of the array are discarded.
512 * Positive arguments shift toward index 0, discarding elements [0, n).
513 * Negative arguments discard elements from the top of the array.
515 * @param __n Number of element positions to shift.
516 * @return New valarray with elements in shifted positions.
518 valarray<_Tp> shift (int __n) const;
521 * @brief Return a rotated array.
523 * A new valarray is constructed as a copy of this array with elements
524 * in shifted positions. For an element with index i, the new position
525 * is (i - n) % size(). The new valarray has the same size as the
526 * current one. Elements that are shifted beyond the array bounds are
527 * shifted into the other end of the array. No elements are lost.
529 * Positive arguments shift toward index 0, wrapping around the top.
530 * Negative arguments shift towards the top, wrapping around to 0.
532 * @param __n Number of element positions to rotate.
533 * @return New valarray with elements in shifted positions.
535 valarray<_Tp> cshift(int __n) const;
538 * @brief Apply a function to the array.
540 * Returns a new valarray with elements assigned to the result of
541 * applying __func to the corresponding element of this array. The new
542 * array has the same size as this one.
544 * @param __func Function of Tp returning Tp to apply.
545 * @return New valarray with transformed elements.
547 _Expr<_ValFunClos<_ValArray, _Tp>, _Tp> apply(_Tp __func(_Tp)) const;
550 * @brief Apply a function to the array.
552 * Returns a new valarray with elements assigned to the result of
553 * applying __func to the corresponding element of this array. The new
554 * array has the same size as this one.
556 * @param __func Function of const Tp& returning Tp to apply.
557 * @return New valarray with transformed elements.
559 _Expr<_RefFunClos<_ValArray, _Tp>, _Tp> apply(_Tp __func(const _Tp&)) const;
562 * @brief Resize array.
564 * Resize this array to @a size and set all elements to @a c. All
565 * references and iterators are invalidated.
567 * @param __size New array size.
568 * @param __c New value for all elements.
570 void resize(size_t __size, _Tp __c = _Tp());
574 _Tp* __restrict__ _M_data;
576 friend struct _Array<_Tp>;
579 #if __cpp_deduction_guides >= 201606
580 template<typename _Tp, size_t _Nm>
581 valarray(const _Tp(&)[_Nm], size_t) -> valarray<_Tp>;
584 template<typename _Tp>
586 valarray<_Tp>::operator[](size_t __i) const _GLIBCXX_NOTHROW
588 __glibcxx_requires_subscript(__i);
592 template<typename _Tp>
594 valarray<_Tp>::operator[](size_t __i) _GLIBCXX_NOTHROW
596 __glibcxx_requires_subscript(__i);
600 /// @} group numeric_arrays
602 _GLIBCXX_END_NAMESPACE_VERSION
605 #include <bits/valarray_after.h>
606 #include <bits/slice_array.h>
607 #include <bits/gslice.h>
608 #include <bits/gslice_array.h>
609 #include <bits/mask_array.h>
610 #include <bits/indirect_array.h>
612 namespace std _GLIBCXX_VISIBILITY(default)
614 _GLIBCXX_BEGIN_NAMESPACE_VERSION
617 * @addtogroup numeric_arrays
621 template<typename _Tp>
623 valarray<_Tp>::valarray() _GLIBCXX_NOTHROW : _M_size(0), _M_data(0) {}
625 template<typename _Tp>
627 valarray<_Tp>::valarray(size_t __n)
628 : _M_size(__n), _M_data(__valarray_get_storage<_Tp>(__n))
629 { std::__valarray_default_construct(_M_data, _M_data + __n); }
631 template<typename _Tp>
633 valarray<_Tp>::valarray(const _Tp& __t, size_t __n)
634 : _M_size(__n), _M_data(__valarray_get_storage<_Tp>(__n))
635 { std::__valarray_fill_construct(_M_data, _M_data + __n, __t); }
637 template<typename _Tp>
639 valarray<_Tp>::valarray(const _Tp* __restrict__ __p, size_t __n)
640 : _M_size(__n), _M_data(__valarray_get_storage<_Tp>(__n))
642 __glibcxx_assert(__p != 0 || __n == 0);
643 std::__valarray_copy_construct(__p, __p + __n, _M_data);
646 template<typename _Tp>
648 valarray<_Tp>::valarray(const valarray<_Tp>& __v)
649 : _M_size(__v._M_size), _M_data(__valarray_get_storage<_Tp>(__v._M_size))
650 { std::__valarray_copy_construct(__v._M_data, __v._M_data + _M_size,
653 #if __cplusplus >= 201103L
654 template<typename _Tp>
656 valarray<_Tp>::valarray(valarray<_Tp>&& __v) noexcept
657 : _M_size(__v._M_size), _M_data(__v._M_data)
664 template<typename _Tp>
666 valarray<_Tp>::valarray(const slice_array<_Tp>& __sa)
667 : _M_size(__sa._M_sz), _M_data(__valarray_get_storage<_Tp>(__sa._M_sz))
669 std::__valarray_copy_construct
670 (__sa._M_array, __sa._M_sz, __sa._M_stride, _Array<_Tp>(_M_data));
673 template<typename _Tp>
675 valarray<_Tp>::valarray(const gslice_array<_Tp>& __ga)
676 : _M_size(__ga._M_index.size()),
677 _M_data(__valarray_get_storage<_Tp>(_M_size))
679 std::__valarray_copy_construct
680 (__ga._M_array, _Array<size_t>(__ga._M_index),
681 _Array<_Tp>(_M_data), _M_size);
684 template<typename _Tp>
686 valarray<_Tp>::valarray(const mask_array<_Tp>& __ma)
687 : _M_size(__ma._M_sz), _M_data(__valarray_get_storage<_Tp>(__ma._M_sz))
689 std::__valarray_copy_construct
690 (__ma._M_array, __ma._M_mask, _Array<_Tp>(_M_data), _M_size);
693 template<typename _Tp>
695 valarray<_Tp>::valarray(const indirect_array<_Tp>& __ia)
696 : _M_size(__ia._M_sz), _M_data(__valarray_get_storage<_Tp>(__ia._M_sz))
698 std::__valarray_copy_construct
699 (__ia._M_array, __ia._M_index, _Array<_Tp>(_M_data), _M_size);
702 #if __cplusplus >= 201103L
703 template<typename _Tp>
705 valarray<_Tp>::valarray(initializer_list<_Tp> __l)
706 : _M_size(__l.size()), _M_data(__valarray_get_storage<_Tp>(__l.size()))
707 { std::__valarray_copy_construct(__l.begin(), __l.end(), _M_data); }
710 template<typename _Tp> template<class _Dom>
712 valarray<_Tp>::valarray(const _Expr<_Dom, _Tp>& __e)
713 : _M_size(__e.size()), _M_data(__valarray_get_storage<_Tp>(_M_size))
714 { std::__valarray_copy_construct(__e, _M_size, _Array<_Tp>(_M_data)); }
716 template<typename _Tp>
718 valarray<_Tp>::~valarray() _GLIBCXX_NOEXCEPT
720 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
721 std::__valarray_release_memory(_M_data);
724 template<typename _Tp>
725 inline valarray<_Tp>&
726 valarray<_Tp>::operator=(const valarray<_Tp>& __v)
728 // _GLIBCXX_RESOLVE_LIB_DEFECTS
729 // 630. arrays of valarray.
730 if (_M_size == __v._M_size)
731 std::__valarray_copy(__v._M_data, _M_size, _M_data);
736 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
737 std::__valarray_release_memory(_M_data);
739 _M_size = __v._M_size;
740 _M_data = __valarray_get_storage<_Tp>(_M_size);
741 std::__valarray_copy_construct(__v._M_data, __v._M_data + _M_size,
747 #if __cplusplus >= 201103L
748 template<typename _Tp>
749 inline valarray<_Tp>&
750 valarray<_Tp>::operator=(valarray<_Tp>&& __v) noexcept
754 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
755 std::__valarray_release_memory(_M_data);
757 _M_size = __v._M_size;
758 _M_data = __v._M_data;
764 template<typename _Tp>
765 inline valarray<_Tp>&
766 valarray<_Tp>::operator=(initializer_list<_Tp> __l)
768 // _GLIBCXX_RESOLVE_LIB_DEFECTS
769 // 630. arrays of valarray.
770 if (_M_size == __l.size())
771 std::__valarray_copy(__l.begin(), __l.size(), _M_data);
776 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
777 std::__valarray_release_memory(_M_data);
779 _M_size = __l.size();
780 _M_data = __valarray_get_storage<_Tp>(_M_size);
781 std::__valarray_copy_construct(__l.begin(), __l.begin() + _M_size,
788 template<typename _Tp>
789 inline valarray<_Tp>&
790 valarray<_Tp>::operator=(const _Tp& __t)
792 std::__valarray_fill(_M_data, _M_size, __t);
796 template<typename _Tp>
797 inline valarray<_Tp>&
798 valarray<_Tp>::operator=(const slice_array<_Tp>& __sa)
800 __glibcxx_assert(_M_size == __sa._M_sz);
801 std::__valarray_copy(__sa._M_array, __sa._M_sz,
802 __sa._M_stride, _Array<_Tp>(_M_data));
806 template<typename _Tp>
807 inline valarray<_Tp>&
808 valarray<_Tp>::operator=(const gslice_array<_Tp>& __ga)
810 __glibcxx_assert(_M_size == __ga._M_index.size());
811 std::__valarray_copy(__ga._M_array, _Array<size_t>(__ga._M_index),
812 _Array<_Tp>(_M_data), _M_size);
816 template<typename _Tp>
817 inline valarray<_Tp>&
818 valarray<_Tp>::operator=(const mask_array<_Tp>& __ma)
820 __glibcxx_assert(_M_size == __ma._M_sz);
821 std::__valarray_copy(__ma._M_array, __ma._M_mask,
822 _Array<_Tp>(_M_data), _M_size);
826 template<typename _Tp>
827 inline valarray<_Tp>&
828 valarray<_Tp>::operator=(const indirect_array<_Tp>& __ia)
830 __glibcxx_assert(_M_size == __ia._M_sz);
831 std::__valarray_copy(__ia._M_array, __ia._M_index,
832 _Array<_Tp>(_M_data), _M_size);
836 template<typename _Tp> template<class _Dom>
837 inline valarray<_Tp>&
838 valarray<_Tp>::operator=(const _Expr<_Dom, _Tp>& __e)
840 // _GLIBCXX_RESOLVE_LIB_DEFECTS
841 // 630. arrays of valarray.
842 if (_M_size == __e.size())
843 std::__valarray_copy(__e, _M_size, _Array<_Tp>(_M_data));
848 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
849 std::__valarray_release_memory(_M_data);
851 _M_size = __e.size();
852 _M_data = __valarray_get_storage<_Tp>(_M_size);
853 std::__valarray_copy_construct(__e, _M_size, _Array<_Tp>(_M_data));
858 template<typename _Tp>
859 inline _Expr<_SClos<_ValArray,_Tp>, _Tp>
860 valarray<_Tp>::operator[](slice __s) const
862 typedef _SClos<_ValArray,_Tp> _Closure;
863 return _Expr<_Closure, _Tp>(_Closure (_Array<_Tp>(_M_data), __s));
866 template<typename _Tp>
867 inline slice_array<_Tp>
868 valarray<_Tp>::operator[](slice __s)
869 { return slice_array<_Tp>(_Array<_Tp>(_M_data), __s); }
871 template<typename _Tp>
872 inline _Expr<_GClos<_ValArray,_Tp>, _Tp>
873 valarray<_Tp>::operator[](const gslice& __gs) const
875 typedef _GClos<_ValArray,_Tp> _Closure;
876 return _Expr<_Closure, _Tp>
877 (_Closure(_Array<_Tp>(_M_data), __gs._M_index->_M_index));
880 template<typename _Tp>
881 inline gslice_array<_Tp>
882 valarray<_Tp>::operator[](const gslice& __gs)
884 return gslice_array<_Tp>
885 (_Array<_Tp>(_M_data), __gs._M_index->_M_index);
888 template<typename _Tp>
890 valarray<_Tp>::operator[](const valarray<bool>& __m) const
893 size_t __e = __m.size();
894 for (size_t __i=0; __i<__e; ++__i)
896 return valarray<_Tp>(mask_array<_Tp>(_Array<_Tp>(_M_data), __s,
897 _Array<bool> (__m)));
900 template<typename _Tp>
901 inline mask_array<_Tp>
902 valarray<_Tp>::operator[](const valarray<bool>& __m)
905 size_t __e = __m.size();
906 for (size_t __i=0; __i<__e; ++__i)
908 return mask_array<_Tp>(_Array<_Tp>(_M_data), __s, _Array<bool>(__m));
911 template<typename _Tp>
912 inline _Expr<_IClos<_ValArray,_Tp>, _Tp>
913 valarray<_Tp>::operator[](const valarray<size_t>& __i) const
915 typedef _IClos<_ValArray,_Tp> _Closure;
916 return _Expr<_Closure, _Tp>(_Closure(*this, __i));
919 template<typename _Tp>
920 inline indirect_array<_Tp>
921 valarray<_Tp>::operator[](const valarray<size_t>& __i)
923 return indirect_array<_Tp>(_Array<_Tp>(_M_data), __i.size(),
924 _Array<size_t>(__i));
927 #if __cplusplus >= 201103L
930 valarray<_Tp>::swap(valarray<_Tp>& __v) noexcept
932 std::swap(_M_size, __v._M_size);
933 std::swap(_M_data, __v._M_data);
939 valarray<_Tp>::size() const
944 valarray<_Tp>::sum() const
946 __glibcxx_assert(_M_size > 0);
947 return std::__valarray_sum(_M_data, _M_data + _M_size);
952 valarray<_Tp>::shift(int __n) const
959 _Tp* __restrict__ __tmp_M_data =
960 std::__valarray_get_storage<_Tp>(_M_size);
963 std::__valarray_copy_construct(_M_data,
964 _M_data + _M_size, __tmp_M_data);
965 else if (__n > 0) // shift left
967 if (size_t(__n) > _M_size)
970 std::__valarray_copy_construct(_M_data + __n,
971 _M_data + _M_size, __tmp_M_data);
972 std::__valarray_default_construct(__tmp_M_data + _M_size - __n,
973 __tmp_M_data + _M_size);
977 if (-size_t(__n) > _M_size)
980 std::__valarray_copy_construct(_M_data, _M_data + _M_size + __n,
982 std::__valarray_default_construct(__tmp_M_data,
986 __ret._M_size = _M_size;
987 __ret._M_data = __tmp_M_data;
993 valarray<_Tp>::cshift(int __n) const
1000 _Tp* __restrict__ __tmp_M_data =
1001 std::__valarray_get_storage<_Tp>(_M_size);
1004 std::__valarray_copy_construct(_M_data,
1005 _M_data + _M_size, __tmp_M_data);
1006 else if (__n > 0) // cshift left
1008 if (size_t(__n) > _M_size)
1009 __n = int(__n % _M_size);
1011 std::__valarray_copy_construct(_M_data, _M_data + __n,
1012 __tmp_M_data + _M_size - __n);
1013 std::__valarray_copy_construct(_M_data + __n, _M_data + _M_size,
1016 else // cshift right
1018 if (-size_t(__n) > _M_size)
1019 __n = -int(-size_t(__n) % _M_size);
1021 std::__valarray_copy_construct(_M_data + _M_size + __n,
1022 _M_data + _M_size, __tmp_M_data);
1023 std::__valarray_copy_construct(_M_data, _M_data + _M_size + __n,
1024 __tmp_M_data - __n);
1027 __ret._M_size = _M_size;
1028 __ret._M_data = __tmp_M_data;
1034 valarray<_Tp>::resize(size_t __n, _Tp __c)
1036 // This complication is so to make valarray<valarray<T> > work
1037 // even though it is not required by the standard. Nobody should
1038 // be saying valarray<valarray<T> > anyway. See the specs.
1039 std::__valarray_destroy_elements(_M_data, _M_data + _M_size);
1042 std::__valarray_release_memory(_M_data);
1044 _M_data = __valarray_get_storage<_Tp>(__n);
1046 std::__valarray_fill_construct(_M_data, _M_data + __n, __c);
1049 template<typename _Tp>
1051 valarray<_Tp>::min() const
1053 __glibcxx_assert(_M_size > 0);
1054 return *std::min_element(_M_data, _M_data + _M_size);
1057 template<typename _Tp>
1059 valarray<_Tp>::max() const
1061 __glibcxx_assert(_M_size > 0);
1062 return *std::max_element(_M_data, _M_data + _M_size);
1066 inline _Expr<_ValFunClos<_ValArray, _Tp>, _Tp>
1067 valarray<_Tp>::apply(_Tp __func(_Tp)) const
1069 typedef _ValFunClos<_ValArray, _Tp> _Closure;
1070 return _Expr<_Closure, _Tp>(_Closure(*this, __func));
1074 inline _Expr<_RefFunClos<_ValArray, _Tp>, _Tp>
1075 valarray<_Tp>::apply(_Tp __func(const _Tp &)) const
1077 typedef _RefFunClos<_ValArray, _Tp> _Closure;
1078 return _Expr<_Closure, _Tp>(_Closure(*this, __func));
1081 #define _DEFINE_VALARRAY_UNARY_OPERATOR(_Op, _Name) \
1082 template<typename _Tp> \
1083 inline typename valarray<_Tp>::template _UnaryOp<_Name>::_Rt \
1084 valarray<_Tp>::operator _Op() const \
1086 typedef _UnClos<_Name, _ValArray, _Tp> _Closure; \
1087 typedef typename __fun<_Name, _Tp>::result_type _Rt; \
1088 return _Expr<_Closure, _Rt>(_Closure(*this)); \
1091 _DEFINE_VALARRAY_UNARY_OPERATOR(+, __unary_plus)
1092 _DEFINE_VALARRAY_UNARY_OPERATOR(-, __negate)
1093 _DEFINE_VALARRAY_UNARY_OPERATOR(~, __bitwise_not)
1094 _DEFINE_VALARRAY_UNARY_OPERATOR (!, __logical_not)
1096 #undef _DEFINE_VALARRAY_UNARY_OPERATOR
1098 #define _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(_Op, _Name) \
1099 template<class _Tp> \
1100 inline valarray<_Tp>& \
1101 valarray<_Tp>::operator _Op##=(const _Tp &__t) \
1103 _Array_augmented_##_Name(_Array<_Tp>(_M_data), _M_size, __t); \
1107 template<class _Tp> \
1108 inline valarray<_Tp>& \
1109 valarray<_Tp>::operator _Op##=(const valarray<_Tp> &__v) \
1111 __glibcxx_assert(_M_size == __v._M_size); \
1112 _Array_augmented_##_Name(_Array<_Tp>(_M_data), _M_size, \
1113 _Array<_Tp>(__v._M_data)); \
1117 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(+, __plus)
1118 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(-, __minus)
1119 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(*, __multiplies)
1120 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(/, __divides)
1121 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(%, __modulus)
1122 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(^, __bitwise_xor)
1123 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(&, __bitwise_and)
1124 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(|, __bitwise_or)
1125 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(<<, __shift_left)
1126 _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT(>>, __shift_right)
1128 #undef _DEFINE_VALARRAY_AUGMENTED_ASSIGNMENT
1130 #define _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(_Op, _Name) \
1131 template<class _Tp> template<class _Dom> \
1132 inline valarray<_Tp>& \
1133 valarray<_Tp>::operator _Op##=(const _Expr<_Dom, _Tp>& __e) \
1135 _Array_augmented_##_Name(_Array<_Tp>(_M_data), __e, _M_size); \
1139 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(+, __plus)
1140 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(-, __minus)
1141 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(*, __multiplies)
1142 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(/, __divides)
1143 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(%, __modulus)
1144 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(^, __bitwise_xor)
1145 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(&, __bitwise_and)
1146 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(|, __bitwise_or)
1147 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(<<, __shift_left)
1148 _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT(>>, __shift_right)
1150 #undef _DEFINE_VALARRAY_EXPR_AUGMENTED_ASSIGNMENT
1153 #define _DEFINE_BINARY_OPERATOR(_Op, _Name) \
1154 template<typename _Tp> \
1155 inline _Expr<_BinClos<_Name, _ValArray, _ValArray, _Tp, _Tp>, \
1156 typename __fun<_Name, _Tp>::result_type> \
1157 operator _Op(const valarray<_Tp>& __v, const valarray<_Tp>& __w) \
1159 __glibcxx_assert(__v.size() == __w.size()); \
1160 typedef _BinClos<_Name, _ValArray, _ValArray, _Tp, _Tp> _Closure; \
1161 typedef typename __fun<_Name, _Tp>::result_type _Rt; \
1162 return _Expr<_Closure, _Rt>(_Closure(__v, __w)); \
1165 template<typename _Tp> \
1166 inline _Expr<_BinClos<_Name, _ValArray,_Constant, _Tp, _Tp>, \
1167 typename __fun<_Name, _Tp>::result_type> \
1168 operator _Op(const valarray<_Tp>& __v, \
1169 const typename valarray<_Tp>::value_type& __t) \
1171 typedef _BinClos<_Name, _ValArray, _Constant, _Tp, _Tp> _Closure; \
1172 typedef typename __fun<_Name, _Tp>::result_type _Rt; \
1173 return _Expr<_Closure, _Rt>(_Closure(__v, __t)); \
1176 template<typename _Tp> \
1177 inline _Expr<_BinClos<_Name, _Constant, _ValArray, _Tp, _Tp>, \
1178 typename __fun<_Name, _Tp>::result_type> \
1179 operator _Op(const typename valarray<_Tp>::value_type& __t, \
1180 const valarray<_Tp>& __v) \
1182 typedef _BinClos<_Name, _Constant, _ValArray, _Tp, _Tp> _Closure; \
1183 typedef typename __fun<_Name, _Tp>::result_type _Rt; \
1184 return _Expr<_Closure, _Rt>(_Closure(__t, __v)); \
1187 _DEFINE_BINARY_OPERATOR(+, __plus)
1188 _DEFINE_BINARY_OPERATOR(-, __minus)
1189 _DEFINE_BINARY_OPERATOR(*, __multiplies)
1190 _DEFINE_BINARY_OPERATOR(/, __divides)
1191 _DEFINE_BINARY_OPERATOR(%, __modulus)
1192 _DEFINE_BINARY_OPERATOR(^, __bitwise_xor)
1193 _DEFINE_BINARY_OPERATOR(&, __bitwise_and)
1194 _DEFINE_BINARY_OPERATOR(|, __bitwise_or)
1195 _DEFINE_BINARY_OPERATOR(<<, __shift_left)
1196 _DEFINE_BINARY_OPERATOR(>>, __shift_right)
1197 _DEFINE_BINARY_OPERATOR(&&, __logical_and)
1198 _DEFINE_BINARY_OPERATOR(||, __logical_or)
1199 _DEFINE_BINARY_OPERATOR(==, __equal_to)
1200 _DEFINE_BINARY_OPERATOR(!=, __not_equal_to)
1201 _DEFINE_BINARY_OPERATOR(<, __less)
1202 _DEFINE_BINARY_OPERATOR(>, __greater)
1203 _DEFINE_BINARY_OPERATOR(<=, __less_equal)
1204 _DEFINE_BINARY_OPERATOR(>=, __greater_equal)
1206 #undef _DEFINE_BINARY_OPERATOR
1208 #if __cplusplus >= 201103L
1210 * @brief Return an iterator pointing to the first element of
1212 * @param __va valarray.
1217 begin(valarray<_Tp>& __va) noexcept
1218 { return __va.size() ? std::__addressof(__va[0]) : nullptr; }
1221 * @brief Return an iterator pointing to the first element of
1222 * the const valarray.
1223 * @param __va valarray.
1228 begin(const valarray<_Tp>& __va) noexcept
1229 { return __va.size() ? std::__addressof(__va[0]) : nullptr; }
1232 * @brief Return an iterator pointing to one past the last element of
1234 * @param __va valarray.
1239 end(valarray<_Tp>& __va) noexcept
1241 if (auto __n = __va.size())
1242 return std::__addressof(__va[0]) + __n;
1248 * @brief Return an iterator pointing to one past the last element of
1249 * the const valarray.
1250 * @param __va valarray.
1255 end(const valarray<_Tp>& __va) noexcept
1257 if (auto __n = __va.size())
1258 return std::__addressof(__va[0]) + __n;
1264 /// @} group numeric_arrays
1266 _GLIBCXX_END_NAMESPACE_VERSION
1269 #endif /* _GLIBCXX_VALARRAY */