197403Sobrien// The template and inlines for the -*- C++ -*- gslice_array class. 297403Sobrien 3169691Skan// Copyright (C) 1997, 1998, 1999, 2000, 2001, 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 gslice_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 _GSLICE_ARRAY_H 39132720Skan#define _GSLICE_ARRAY_H 1 4097403Sobrien 4197403Sobrien#pragma GCC system_header 4297403Sobrien 43169691Skan_GLIBCXX_BEGIN_NAMESPACE(std) 4497403Sobrien 45132720Skan /** 46132720Skan * @brief Reference to multi-dimensional subset of an array. 47132720Skan * 48132720Skan * A gslice_array is a reference to the actual elements of an array 49132720Skan * specified by a gslice. The way to get a gslice_array is to call 50132720Skan * operator[](gslice) on a valarray. The returned gslice_array then 51132720Skan * permits carrying operations out on the referenced subset of elements in 52132720Skan * the original valarray. For example, operator+=(valarray) will add 53132720Skan * values to the subset of elements in the underlying valarray this 54132720Skan * gslice_array refers to. 55132720Skan * 56132720Skan * @param Tp Element type. 57132720Skan */ 58117397Skan template<typename _Tp> 59117397Skan class gslice_array 6097403Sobrien { 6197403Sobrien public: 62117397Skan typedef _Tp value_type; 6397403Sobrien 64132720Skan // _GLIBCXX_RESOLVE_LIB_DEFECTS 65132720Skan // 253. valarray helper functions are almost entirely useless 66132720Skan 67132720Skan /// Copy constructor. Both slices refer to the same underlying array. 68132720Skan gslice_array(const gslice_array&); 69132720Skan 70132720Skan /// Assignment operator. Assigns slice elements to corresponding 71132720Skan /// elements of @a a. 72132720Skan gslice_array& operator=(const gslice_array&); 73132720Skan 74132720Skan /// Assign slice elements to corresponding elements of @a v. 75117397Skan void operator=(const valarray<_Tp>&) const; 76132720Skan /// Multiply slice elements by corresponding elements of @a v. 77117397Skan void operator*=(const valarray<_Tp>&) const; 78132720Skan /// Divide slice elements by corresponding elements of @a v. 79117397Skan void operator/=(const valarray<_Tp>&) const; 80132720Skan /// Modulo slice elements by corresponding elements of @a v. 81117397Skan void operator%=(const valarray<_Tp>&) const; 82132720Skan /// Add corresponding elements of @a v to slice elements. 83117397Skan void operator+=(const valarray<_Tp>&) const; 84132720Skan /// Subtract corresponding elements of @a v from slice elements. 85117397Skan void operator-=(const valarray<_Tp>&) const; 86132720Skan /// Logical xor slice elements with corresponding elements of @a v. 87117397Skan void operator^=(const valarray<_Tp>&) const; 88132720Skan /// Logical and slice elements with corresponding elements of @a v. 89117397Skan void operator&=(const valarray<_Tp>&) const; 90132720Skan /// Logical or slice elements with corresponding elements of @a v. 91117397Skan void operator|=(const valarray<_Tp>&) const; 92132720Skan /// Left shift slice elements by corresponding elements of @a v. 93117397Skan void operator<<=(const valarray<_Tp>&) const; 94132720Skan /// Right shift slice elements by corresponding elements of @a v. 95117397Skan void operator>>=(const valarray<_Tp>&) const; 96132720Skan /// Assign all slice elements to @a t. 97117397Skan void operator=(const _Tp&) const; 9897403Sobrien 99117397Skan template<class _Dom> 100169691Skan void operator=(const _Expr<_Dom, _Tp>&) const; 101117397Skan template<class _Dom> 102169691Skan void operator*=(const _Expr<_Dom, _Tp>&) const; 103117397Skan template<class _Dom> 104169691Skan void operator/=(const _Expr<_Dom, _Tp>&) const; 105117397Skan template<class _Dom> 106169691Skan void operator%=(const _Expr<_Dom, _Tp>&) const; 107117397Skan template<class _Dom> 108169691Skan void operator+=(const _Expr<_Dom, _Tp>&) const; 109117397Skan template<class _Dom> 110169691Skan void operator-=(const _Expr<_Dom, _Tp>&) const; 111117397Skan template<class _Dom> 112169691Skan void operator^=(const _Expr<_Dom, _Tp>&) const; 113117397Skan template<class _Dom> 114169691Skan void operator&=(const _Expr<_Dom, _Tp>&) const; 115117397Skan template<class _Dom> 116169691Skan void operator|=(const _Expr<_Dom, _Tp>&) const; 117117397Skan template<class _Dom> 118169691Skan void operator<<=(const _Expr<_Dom, _Tp>&) const; 119117397Skan template<class _Dom> 120169691Skan void operator>>=(const _Expr<_Dom, _Tp>&) const; 121132720Skan 12297403Sobrien private: 123117397Skan _Array<_Tp> _M_array; 124117397Skan const valarray<size_t>& _M_index; 125132720Skan 126117397Skan friend class valarray<_Tp>; 127132720Skan 128117397Skan gslice_array(_Array<_Tp>, const valarray<size_t>&); 12997403Sobrien 130117397Skan // not implemented 131117397Skan gslice_array(); 13297403Sobrien }; 13397403Sobrien 134117397Skan template<typename _Tp> 13597403Sobrien inline 136117397Skan gslice_array<_Tp>::gslice_array(_Array<_Tp> __a, 137117397Skan const valarray<size_t>& __i) 138132720Skan : _M_array(__a), _M_index(__i) {} 13997403Sobrien 140117397Skan template<typename _Tp> 14197403Sobrien inline 142117397Skan gslice_array<_Tp>::gslice_array(const gslice_array<_Tp>& __a) 143132720Skan : _M_array(__a._M_array), _M_index(__a._M_index) {} 14497403Sobrien 145117397Skan template<typename _Tp> 146132720Skan inline gslice_array<_Tp>& 147132720Skan gslice_array<_Tp>::operator=(const gslice_array<_Tp>& __a) 148132720Skan { 149132720Skan std::__valarray_copy(_Array<_Tp>(__a._M_array), 150132720Skan _Array<size_t>(__a._M_index), _M_index.size(), 151132720Skan _M_array, _Array<size_t>(_M_index)); 152132720Skan return *this; 153132720Skan } 154132720Skan 155132720Skan template<typename _Tp> 15697403Sobrien inline void 157117397Skan gslice_array<_Tp>::operator=(const _Tp& __t) const 158132720Skan { 159132720Skan std::__valarray_fill(_M_array, _Array<size_t>(_M_index), 160132720Skan _M_index.size(), __t); 16197403Sobrien } 16297403Sobrien 163117397Skan template<typename _Tp> 16497403Sobrien inline void 165117397Skan gslice_array<_Tp>::operator=(const valarray<_Tp>& __v) const 16697403Sobrien { 167132720Skan std::__valarray_copy(_Array<_Tp>(__v), __v.size(), 168132720Skan _M_array, _Array<size_t>(_M_index)); 16997403Sobrien } 17097403Sobrien 171117397Skan template<typename _Tp> 172117397Skan template<class _Dom> 173117397Skan inline void 174117397Skan gslice_array<_Tp>::operator=(const _Expr<_Dom, _Tp>& __e) const 175117397Skan { 176132720Skan std::__valarray_copy (__e, _M_index.size(), _M_array, 177132720Skan _Array<size_t>(_M_index)); 178117397Skan } 17997403Sobrien 18097403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 181117397Skan#define _DEFINE_VALARRAY_OPERATOR(_Op, _Name) \ 182117397Skan template<typename _Tp> \ 183117397Skan inline void \ 184117397Skan gslice_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const \ 185117397Skan { \ 186117397Skan _Array_augmented_##_Name(_M_array, _Array<size_t>(_M_index), \ 187169691Skan _Array<_Tp>(__v), __v.size()); \ 188117397Skan } \ 18997403Sobrien \ 190117397Skan template<typename _Tp> \ 191132720Skan template<class _Dom> \ 192132720Skan inline void \ 193117397Skan gslice_array<_Tp>::operator _Op##= (const _Expr<_Dom, _Tp>& __e) const\ 194117397Skan { \ 195117397Skan _Array_augmented_##_Name(_M_array, _Array<size_t>(_M_index), __e,\ 196117397Skan _M_index.size()); \ 197117397Skan } 19897403Sobrien 199117397Skan_DEFINE_VALARRAY_OPERATOR(*, __multiplies) 200132720Skan_DEFINE_VALARRAY_OPERATOR(/, __divides) 201117397Skan_DEFINE_VALARRAY_OPERATOR(%, __modulus) 202132720Skan_DEFINE_VALARRAY_OPERATOR(+, __plus) 203117397Skan_DEFINE_VALARRAY_OPERATOR(-, __minus) 204117397Skan_DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor) 205117397Skan_DEFINE_VALARRAY_OPERATOR(&, __bitwise_and) 206117397Skan_DEFINE_VALARRAY_OPERATOR(|, __bitwise_or) 207117397Skan_DEFINE_VALARRAY_OPERATOR(<<, __shift_left) 208117397Skan_DEFINE_VALARRAY_OPERATOR(>>, __shift_right) 20997403Sobrien 21097403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 21197403Sobrien 212169691Skan_GLIBCXX_END_NAMESPACE 21397403Sobrien 214132720Skan#endif /* _GSLICE_ARRAY_H */ 215