197403Sobrien// The template and inlines for the -*- C++ -*- indirect_array class. 297403Sobrien 3169691Skan// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005 4117397Skan// 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 indirect_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 _INDIRECT_ARRAY_H 39132720Skan#define _INDIRECT_ARRAY_H 1 4097403Sobrien 4197403Sobrien#pragma GCC system_header 4297403Sobrien 43169691Skan_GLIBCXX_BEGIN_NAMESPACE(std) 44169691Skan 45132720Skan /** 46132720Skan * @brief Reference to arbitrary subset of an array. 47132720Skan * 48132720Skan * An indirect_array is a reference to the actual elements of an array 49169691Skan * specified by an ordered array of indices. The way to get an 50169691Skan * indirect_array is to call operator[](valarray<size_t>) on a valarray. 51169691Skan * The returned indirect_array then permits carrying operations out on the 52169691Skan * referenced subset of elements in the original valarray. 53132720Skan * 54132720Skan * For example, if an indirect_array is obtained using the array (4,2,0) as 55132720Skan * an argument, and then assigned to an array containing (1,2,3), then the 56132720Skan * underlying array will have array[0]==3, array[2]==2, and array[4]==1. 57132720Skan * 58132720Skan * @param Tp Element type. 59132720Skan */ 6097403Sobrien template <class _Tp> 61132720Skan class indirect_array 62132720Skan { 63132720Skan public: 64132720Skan typedef _Tp value_type; 6597403Sobrien 66132720Skan // _GLIBCXX_RESOLVE_LIB_DEFECTS 67132720Skan // 253. valarray helper functions are almost entirely useless 6897403Sobrien 69132720Skan /// Copy constructor. Both slices refer to the same underlying array. 70132720Skan indirect_array(const indirect_array&); 7197403Sobrien 72132720Skan /// Assignment operator. Assigns elements to corresponding elements 73132720Skan /// of @a a. 74132720Skan indirect_array& operator=(const indirect_array&); 7597403Sobrien 76132720Skan /// Assign slice elements to corresponding elements of @a v. 77132720Skan void operator=(const valarray<_Tp>&) const; 78132720Skan /// Multiply slice elements by corresponding elements of @a v. 79132720Skan void operator*=(const valarray<_Tp>&) const; 80132720Skan /// Divide slice elements by corresponding elements of @a v. 81132720Skan void operator/=(const valarray<_Tp>&) const; 82132720Skan /// Modulo slice elements by corresponding elements of @a v. 83132720Skan void operator%=(const valarray<_Tp>&) const; 84132720Skan /// Add corresponding elements of @a v to slice elements. 85132720Skan void operator+=(const valarray<_Tp>&) const; 86132720Skan /// Subtract corresponding elements of @a v from slice elements. 87132720Skan void operator-=(const valarray<_Tp>&) const; 88132720Skan /// Logical xor slice elements with corresponding elements of @a v. 89132720Skan void operator^=(const valarray<_Tp>&) const; 90132720Skan /// Logical and slice elements with corresponding elements of @a v. 91132720Skan void operator&=(const valarray<_Tp>&) const; 92132720Skan /// Logical or slice elements with corresponding elements of @a v. 93132720Skan void operator|=(const valarray<_Tp>&) const; 94132720Skan /// Left shift slice elements by corresponding elements of @a v. 95132720Skan void operator<<=(const valarray<_Tp>&) const; 96132720Skan /// Right shift slice elements by corresponding elements of @a v. 97132720Skan void operator>>=(const valarray<_Tp>&) const; 98132720Skan /// Assign all slice elements to @a t. 99132720Skan void operator= (const _Tp&) const; 100132720Skan // ~indirect_array(); 101132720Skan 102132720Skan template<class _Dom> 103132720Skan void operator=(const _Expr<_Dom, _Tp>&) const; 104132720Skan template<class _Dom> 105132720Skan void operator*=(const _Expr<_Dom, _Tp>&) const; 106132720Skan template<class _Dom> 107132720Skan void operator/=(const _Expr<_Dom, _Tp>&) const; 108132720Skan template<class _Dom> 109132720Skan void operator%=(const _Expr<_Dom, _Tp>&) const; 110132720Skan template<class _Dom> 111132720Skan void operator+=(const _Expr<_Dom, _Tp>&) const; 112132720Skan template<class _Dom> 113132720Skan void operator-=(const _Expr<_Dom, _Tp>&) const; 114132720Skan template<class _Dom> 115132720Skan void operator^=(const _Expr<_Dom, _Tp>&) const; 116132720Skan template<class _Dom> 117132720Skan void operator&=(const _Expr<_Dom, _Tp>&) const; 118132720Skan template<class _Dom> 119132720Skan void operator|=(const _Expr<_Dom, _Tp>&) const; 120132720Skan template<class _Dom> 121132720Skan void operator<<=(const _Expr<_Dom, _Tp>&) const; 122132720Skan template<class _Dom> 123132720Skan void operator>>=(const _Expr<_Dom, _Tp>&) const; 124132720Skan 125132720Skan private: 126132720Skan /// Copy constructor. Both slices refer to the same underlying array. 127132720Skan indirect_array(_Array<_Tp>, size_t, _Array<size_t>); 128132720Skan 129132720Skan friend class valarray<_Tp>; 130132720Skan friend class gslice_array<_Tp>; 131132720Skan 132132720Skan const size_t _M_sz; 133132720Skan const _Array<size_t> _M_index; 134132720Skan const _Array<_Tp> _M_array; 135132720Skan 136132720Skan // not implemented 137132720Skan indirect_array(); 138132720Skan }; 139132720Skan 14097403Sobrien template<typename _Tp> 141132720Skan inline 142117397Skan indirect_array<_Tp>::indirect_array(const indirect_array<_Tp>& __a) 143132720Skan : _M_sz(__a._M_sz), _M_index(__a._M_index), _M_array(__a._M_array) {} 14497403Sobrien 14597403Sobrien template<typename _Tp> 146169691Skan inline 147169691Skan indirect_array<_Tp>::indirect_array(_Array<_Tp> __a, size_t __s, 148169691Skan _Array<size_t> __i) 149169691Skan : _M_sz(__s), _M_index(__i), _M_array(__a) {} 15097403Sobrien 15197403Sobrien template<typename _Tp> 152169691Skan inline indirect_array<_Tp>& 153169691Skan indirect_array<_Tp>::operator=(const indirect_array<_Tp>& __a) 154169691Skan { 155169691Skan std::__valarray_copy(__a._M_array, _M_sz, __a._M_index, _M_array, 156169691Skan _M_index); 157169691Skan return *this; 158169691Skan } 15997403Sobrien 16097403Sobrien template<typename _Tp> 161169691Skan inline void 162169691Skan indirect_array<_Tp>::operator=(const _Tp& __t) const 163169691Skan { std::__valarray_fill(_M_array, _M_index, _M_sz, __t); } 16497403Sobrien 16597403Sobrien template<typename _Tp> 166169691Skan inline void 167169691Skan indirect_array<_Tp>::operator=(const valarray<_Tp>& __v) const 168169691Skan { std::__valarray_copy(_Array<_Tp>(__v), _M_sz, _M_array, _M_index); } 16997403Sobrien 17097403Sobrien template<typename _Tp> 171169691Skan template<class _Dom> 172169691Skan inline void 173169691Skan indirect_array<_Tp>::operator=(const _Expr<_Dom, _Tp>& __e) const 174169691Skan { std::__valarray_copy(__e, _M_sz, _M_array, _M_index); } 17597403Sobrien 17697403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 177117397Skan#define _DEFINE_VALARRAY_OPERATOR(_Op, _Name) \ 178117397Skan template<typename _Tp> \ 179117397Skan inline void \ 180117397Skan indirect_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const\ 181117397Skan { \ 182117397Skan _Array_augmented_##_Name(_M_array, _M_index, _Array<_Tp>(__v), _M_sz); \ 183117397Skan } \ 18497403Sobrien \ 185117397Skan template<typename _Tp> \ 186117397Skan template<class _Dom> \ 187117397Skan inline void \ 188117397Skan indirect_array<_Tp>::operator _Op##=(const _Expr<_Dom,_Tp>& __e) const\ 189117397Skan { \ 190117397Skan _Array_augmented_##_Name(_M_array, _M_index, __e, _M_sz); \ 191117397Skan } 19297403Sobrien 193117397Skan_DEFINE_VALARRAY_OPERATOR(*, __multiplies) 194117397Skan_DEFINE_VALARRAY_OPERATOR(/, __divides) 195117397Skan_DEFINE_VALARRAY_OPERATOR(%, __modulus) 196117397Skan_DEFINE_VALARRAY_OPERATOR(+, __plus) 197117397Skan_DEFINE_VALARRAY_OPERATOR(-, __minus) 198117397Skan_DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor) 199117397Skan_DEFINE_VALARRAY_OPERATOR(&, __bitwise_and) 200117397Skan_DEFINE_VALARRAY_OPERATOR(|, __bitwise_or) 201117397Skan_DEFINE_VALARRAY_OPERATOR(<<, __shift_left) 202117397Skan_DEFINE_VALARRAY_OPERATOR(>>, __shift_right) 20397403Sobrien 20497403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 20597403Sobrien 206169691Skan_GLIBCXX_END_NAMESPACE 20797403Sobrien 208132720Skan#endif /* _INDIRECT_ARRAY_H */ 209