197403Sobrien// The template and inlines for the -*- C++ -*- slice_array class. 297403Sobrien 3169691Skan// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005 4132720Skan// Free Software Foundation, Inc. 597403Sobrien// 697403Sobrien// This file is part of the GNU ISO C++ Library. This library is free 797403Sobrien// software; you can redistribute it and/or modify it under the 897403Sobrien// terms of the GNU General Public License as published by the 997403Sobrien// Free Software Foundation; either version 2, or (at your option) 1097403Sobrien// any later version. 1197403Sobrien 1297403Sobrien// This library is distributed in the hope that it will be useful, 1397403Sobrien// but WITHOUT ANY WARRANTY; without even the implied warranty of 1497403Sobrien// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 1597403Sobrien// GNU General Public License for more details. 1697403Sobrien 1797403Sobrien// You should have received a copy of the GNU General Public License along 1897403Sobrien// with this library; see the file COPYING. If not, write to the Free 19169691Skan// Software Foundation, 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 2097403Sobrien// USA. 2197403Sobrien 2297403Sobrien// As a special exception, you may use this file as part of a free software 2397403Sobrien// library without restriction. Specifically, if other files instantiate 2497403Sobrien// templates or use macros or inline functions from this file, or you compile 2597403Sobrien// this file and link it with other files to produce an executable, this 2697403Sobrien// file does not by itself cause the resulting executable to be covered by 2797403Sobrien// the GNU General Public License. This exception does not however 2897403Sobrien// invalidate any other reasons why the executable file might be covered by 2997403Sobrien// the GNU General Public License. 3097403Sobrien 3197403Sobrien/** @file slice_array.h 3297403Sobrien * This is an internal header file, included by other library headers. 3397403Sobrien * You should not attempt to use it directly. 3497403Sobrien */ 3597403Sobrien 36169691Skan// Written by Gabriel Dos Reis <Gabriel.Dos-Reis@DPTMaths.ENS-Cachan.Fr> 37169691Skan 38132720Skan#ifndef _SLICE_ARRAY_H 39132720Skan#define _SLICE_ARRAY_H 1 4097403Sobrien 4197403Sobrien#pragma GCC system_header 4297403Sobrien 43169691Skan_GLIBCXX_BEGIN_NAMESPACE(std) 44169691Skan 45132720Skan /** 46132720Skan * @brief Class defining one-dimensional subset of an array. 47132720Skan * 48132720Skan * The slice class represents a one-dimensional subset of an array, 49132720Skan * specified by three parameters: start offset, size, and stride. The 50132720Skan * start offset is the index of the first element of the array that is part 51132720Skan * of the subset. The size is the total number of elements in the subset. 52132720Skan * Stride is the distance between each successive array element to include 53132720Skan * in the subset. 54132720Skan * 55132720Skan * For example, with an array of size 10, and a slice with offset 1, size 3 56132720Skan * and stride 2, the subset consists of array elements 1, 3, and 5. 57132720Skan */ 58117397Skan class slice 59117397Skan { 60117397Skan public: 61132720Skan /// Construct an empty slice. 62117397Skan slice(); 63132720Skan 64132720Skan /** 65132720Skan * @brief Construct a slice. 66132720Skan * 67132720Skan * @param o Offset in array of first element. 68132720Skan * @param d Number of elements in slice. 69132720Skan * @param s Stride between array elements. 70132720Skan */ 71117397Skan slice(size_t, size_t, size_t); 72132720Skan 73132720Skan /// Return array offset of first slice element. 74117397Skan size_t start() const; 75132720Skan /// Return size of slice. 76117397Skan size_t size() const; 77132720Skan /// Return array stride of slice. 78117397Skan size_t stride() const; 79132720Skan 80117397Skan private: 81117397Skan size_t _M_off; // offset 82117397Skan size_t _M_sz; // size 83117397Skan size_t _M_st; // stride unit 84117397Skan }; 85117397Skan 86117397Skan // The default constructor constructor is not required to initialize 87117397Skan // data members with any meaningful values, so we choose to do nothing. 88132720Skan inline 89117397Skan slice::slice() {} 90132720Skan 91132720Skan inline 92117397Skan slice::slice(size_t __o, size_t __d, size_t __s) 93169691Skan : _M_off(__o), _M_sz(__d), _M_st(__s) {} 94132720Skan 95117397Skan inline size_t 96117397Skan slice::start() const 97117397Skan { return _M_off; } 98132720Skan 99117397Skan inline size_t 100117397Skan slice::size() const 101117397Skan { return _M_sz; } 102132720Skan 103117397Skan inline size_t 104117397Skan slice::stride() const 105117397Skan { return _M_st; } 106117397Skan 107132720Skan /** 108132720Skan * @brief Reference to one-dimensional subset of an array. 109132720Skan * 110132720Skan * A slice_array is a reference to the actual elements of an array 111132720Skan * specified by a slice. The way to get a slice_array is to call 112132720Skan * operator[](slice) on a valarray. The returned slice_array then permits 113132720Skan * carrying operations out on the referenced subset of elements in the 114132720Skan * original valarray. For example, operator+=(valarray) will add values 115132720Skan * to the subset of elements in the underlying valarray this slice_array 116132720Skan * refers to. 117132720Skan * 118132720Skan * @param Tp Element type. 119132720Skan */ 120117397Skan template<typename _Tp> 12197403Sobrien class slice_array 12297403Sobrien { 12397403Sobrien public: 124117397Skan typedef _Tp value_type; 12597403Sobrien 126132720Skan // _GLIBCXX_RESOLVE_LIB_DEFECTS 127132720Skan // 253. valarray helper functions are almost entirely useless 128132720Skan 129132720Skan /// Copy constructor. Both slices refer to the same underlying array. 130117397Skan slice_array(const slice_array&); 13197403Sobrien 132132720Skan /// Assignment operator. Assigns slice elements to corresponding 133132720Skan /// elements of @a a. 134117397Skan slice_array& operator=(const slice_array&); 13597403Sobrien 136132720Skan /// Assign slice elements to corresponding elements of @a v. 137117397Skan void operator=(const valarray<_Tp>&) const; 138132720Skan /// Multiply slice elements by corresponding elements of @a v. 139117397Skan void operator*=(const valarray<_Tp>&) const; 140132720Skan /// Divide slice elements by corresponding elements of @a v. 141117397Skan void operator/=(const valarray<_Tp>&) const; 142132720Skan /// Modulo slice elements by corresponding elements of @a v. 143117397Skan void operator%=(const valarray<_Tp>&) const; 144132720Skan /// Add corresponding elements of @a v to slice elements. 145117397Skan void operator+=(const valarray<_Tp>&) const; 146132720Skan /// Subtract corresponding elements of @a v from slice elements. 147117397Skan void operator-=(const valarray<_Tp>&) const; 148132720Skan /// Logical xor slice elements with corresponding elements of @a v. 149117397Skan void operator^=(const valarray<_Tp>&) const; 150132720Skan /// Logical and slice elements with corresponding elements of @a v. 151117397Skan void operator&=(const valarray<_Tp>&) const; 152132720Skan /// Logical or slice elements with corresponding elements of @a v. 153117397Skan void operator|=(const valarray<_Tp>&) const; 154132720Skan /// Left shift slice elements by corresponding elements of @a v. 155117397Skan void operator<<=(const valarray<_Tp>&) const; 156132720Skan /// Right shift slice elements by corresponding elements of @a v. 157117397Skan void operator>>=(const valarray<_Tp>&) const; 158132720Skan /// Assign all slice elements to @a t. 159117397Skan void operator=(const _Tp &) const; 160117397Skan // ~slice_array (); 161117397Skan 162117397Skan template<class _Dom> 163169691Skan void operator=(const _Expr<_Dom, _Tp>&) const; 164117397Skan template<class _Dom> 165169691Skan void operator*=(const _Expr<_Dom, _Tp>&) const; 166117397Skan template<class _Dom> 167169691Skan void operator/=(const _Expr<_Dom, _Tp>&) const; 168117397Skan template<class _Dom> 169169691Skan void operator%=(const _Expr<_Dom, _Tp>&) const; 170117397Skan template<class _Dom> 171169691Skan void operator+=(const _Expr<_Dom, _Tp>&) const; 172117397Skan template<class _Dom> 173169691Skan void operator-=(const _Expr<_Dom, _Tp>&) const; 174117397Skan template<class _Dom> 175169691Skan void operator^=(const _Expr<_Dom, _Tp>&) const; 176117397Skan template<class _Dom> 177169691Skan void operator&=(const _Expr<_Dom, _Tp>&) const; 178117397Skan template<class _Dom> 179169691Skan void operator|=(const _Expr<_Dom, _Tp>&) const; 180117397Skan template<class _Dom> 181169691Skan void operator<<=(const _Expr<_Dom, _Tp>&) const; 182117397Skan template<class _Dom> 183169691Skan void operator>>=(const _Expr<_Dom, _Tp>&) const; 184117397Skan 18597403Sobrien private: 186117397Skan friend class valarray<_Tp>; 187117397Skan slice_array(_Array<_Tp>, const slice&); 18897403Sobrien 189169691Skan const size_t _M_sz; 190169691Skan const size_t _M_stride; 191117397Skan const _Array<_Tp> _M_array; 192117397Skan 193117397Skan // not implemented 194117397Skan slice_array(); 19597403Sobrien }; 19697403Sobrien 197117397Skan template<typename _Tp> 198132720Skan inline 199117397Skan slice_array<_Tp>::slice_array(_Array<_Tp> __a, const slice& __s) 200132720Skan : _M_sz(__s.size()), _M_stride(__s.stride()), 201132720Skan _M_array(__a.begin() + __s.start()) {} 20297403Sobrien 203117397Skan template<typename _Tp> 204132720Skan inline 205117397Skan slice_array<_Tp>::slice_array(const slice_array<_Tp>& a) 206132720Skan : _M_sz(a._M_sz), _M_stride(a._M_stride), _M_array(a._M_array) {} 207132720Skan 208117397Skan // template<typename _Tp> 209117397Skan // inline slice_array<_Tp>::~slice_array () {} 21097403Sobrien 21197403Sobrien template<typename _Tp> 212117397Skan inline slice_array<_Tp>& 213117397Skan slice_array<_Tp>::operator=(const slice_array<_Tp>& __a) 214117397Skan { 215132720Skan std::__valarray_copy(__a._M_array, __a._M_sz, __a._M_stride, 216132720Skan _M_array, _M_stride); 217117397Skan return *this; 218117397Skan } 21997403Sobrien 220117397Skan template<typename _Tp> 22197403Sobrien inline void 222117397Skan slice_array<_Tp>::operator=(const _Tp& __t) const 223132720Skan { std::__valarray_fill(_M_array, _M_sz, _M_stride, __t); } 224132720Skan 225117397Skan template<typename _Tp> 22697403Sobrien inline void 227117397Skan slice_array<_Tp>::operator=(const valarray<_Tp>& __v) const 228132720Skan { std::__valarray_copy(_Array<_Tp>(__v), _M_array, _M_sz, _M_stride); } 229132720Skan 230117397Skan template<typename _Tp> 231117397Skan template<class _Dom> 23297403Sobrien inline void 233117397Skan slice_array<_Tp>::operator=(const _Expr<_Dom,_Tp>& __e) const 234132720Skan { std::__valarray_copy(__e, _M_sz, _M_array, _M_stride); } 23597403Sobrien 23697403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 237117397Skan#define _DEFINE_VALARRAY_OPERATOR(_Op,_Name) \ 238117397Skan template<typename _Tp> \ 239117397Skan inline void \ 240117397Skan slice_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const \ 241117397Skan { \ 242117397Skan _Array_augmented_##_Name(_M_array, _M_sz, _M_stride, _Array<_Tp>(__v));\ 243117397Skan } \ 24497403Sobrien \ 245117397Skan template<typename _Tp> \ 246117397Skan template<class _Dom> \ 247117397Skan inline void \ 248117397Skan slice_array<_Tp>::operator _Op##=(const _Expr<_Dom,_Tp>& __e) const\ 249117397Skan { \ 250117397Skan _Array_augmented_##_Name(_M_array, _M_stride, __e, _M_sz); \ 251117397Skan } 25297403Sobrien 253132720Skan 254117397Skan_DEFINE_VALARRAY_OPERATOR(*, __multiplies) 255117397Skan_DEFINE_VALARRAY_OPERATOR(/, __divides) 256117397Skan_DEFINE_VALARRAY_OPERATOR(%, __modulus) 257117397Skan_DEFINE_VALARRAY_OPERATOR(+, __plus) 258117397Skan_DEFINE_VALARRAY_OPERATOR(-, __minus) 259117397Skan_DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor) 260117397Skan_DEFINE_VALARRAY_OPERATOR(&, __bitwise_and) 261117397Skan_DEFINE_VALARRAY_OPERATOR(|, __bitwise_or) 262117397Skan_DEFINE_VALARRAY_OPERATOR(<<, __shift_left) 263117397Skan_DEFINE_VALARRAY_OPERATOR(>>, __shift_right) 26497403Sobrien 26597403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 26697403Sobrien 267169691Skan_GLIBCXX_END_NAMESPACE 26897403Sobrien 269132720Skan#endif /* _SLICE_ARRAY_H */ 270