197403Sobrien// The template and inlines for the -*- C++ -*- mask_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 mask_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 _MASK_ARRAY_H 39132720Skan#define _MASK_ARRAY_H 1 4097403Sobrien 4197403Sobrien#pragma GCC system_header 4297403Sobrien 43169691Skan_GLIBCXX_BEGIN_NAMESPACE(std) 4497403Sobrien 45132720Skan /** 46132720Skan * @brief Reference to selected subset of an array. 47132720Skan * 48132720Skan * A mask_array is a reference to the actual elements of an array specified 49132720Skan * by a bitmask in the form of an array of bool. The way to get a 50132720Skan * mask_array is to call operator[](valarray<bool>) on a valarray. The 51132720Skan * returned mask_array then permits carrying operations out on the 52132720Skan * referenced subset of elements in the original valarray. 53132720Skan * 54132720Skan * For example, if a mask_array is obtained using the array (false, true, 55132720Skan * false, true) as an argument, the mask array has two elements referring 56132720Skan * to array[1] and array[3] in the underlying array. 57132720Skan * 58132720Skan * @param Tp Element type. 59132720Skan */ 60132720Skan template <class _Tp> 61117397Skan class mask_array 62132720Skan { 6397403Sobrien public: 64117397Skan typedef _Tp value_type; 65132720Skan 66132720Skan // _GLIBCXX_RESOLVE_LIB_DEFECTS 67132720Skan // 253. valarray helper functions are almost entirely useless 68132720Skan 69132720Skan /// Copy constructor. Both slices refer to the same underlying array. 70132720Skan mask_array (const mask_array&); 71132720Skan 72132720Skan /// Assignment operator. Assigns elements to corresponding elements 73132720Skan /// of @a a. 74132720Skan mask_array& operator=(const mask_array&); 75132720Skan 76117397Skan void operator=(const valarray<_Tp>&) const; 77132720Skan /// Multiply slice elements by corresponding elements of @a v. 78117397Skan void operator*=(const valarray<_Tp>&) const; 79132720Skan /// Divide slice elements by corresponding elements of @a v. 80117397Skan void operator/=(const valarray<_Tp>&) const; 81132720Skan /// Modulo slice elements by corresponding elements of @a v. 82117397Skan void operator%=(const valarray<_Tp>&) const; 83132720Skan /// Add corresponding elements of @a v to slice elements. 84132720Skan void operator+=(const valarray<_Tp>&) const; 85132720Skan /// Subtract corresponding elements of @a v from slice elements. 86117397Skan void operator-=(const valarray<_Tp>&) const; 87132720Skan /// Logical xor slice elements with corresponding elements of @a v. 88132720Skan void operator^=(const valarray<_Tp>&) const; 89132720Skan /// Logical and slice elements with corresponding elements of @a v. 90117397Skan void operator&=(const valarray<_Tp>&) const; 91132720Skan /// Logical or slice elements with corresponding elements of @a v. 92117397Skan void operator|=(const valarray<_Tp>&) const; 93132720Skan /// Left shift slice elements by corresponding elements of @a v. 94132720Skan void operator<<=(const valarray<_Tp>&) const; 95132720Skan /// Right shift slice elements by corresponding elements of @a v. 96132720Skan void operator>>=(const valarray<_Tp>&) const; 97132720Skan /// Assign all slice elements to @a t. 98117397Skan void operator=(const _Tp&) const; 99132720Skan 10097403Sobrien // ~mask_array (); 101132720Skan 102117397Skan template<class _Dom> 103117397Skan void operator=(const _Expr<_Dom,_Tp>&) const; 104117397Skan template<class _Dom> 105117397Skan void operator*=(const _Expr<_Dom,_Tp>&) const; 106117397Skan template<class _Dom> 107117397Skan void operator/=(const _Expr<_Dom,_Tp>&) const; 108117397Skan template<class _Dom> 109117397Skan void operator%=(const _Expr<_Dom,_Tp>&) const; 110117397Skan template<class _Dom> 111117397Skan void operator+=(const _Expr<_Dom,_Tp>&) const; 112117397Skan template<class _Dom> 113117397Skan void operator-=(const _Expr<_Dom,_Tp>&) const; 114117397Skan template<class _Dom> 115117397Skan void operator^=(const _Expr<_Dom,_Tp>&) const; 116117397Skan template<class _Dom> 117117397Skan void operator&=(const _Expr<_Dom,_Tp>&) const; 118117397Skan template<class _Dom> 119117397Skan void operator|=(const _Expr<_Dom,_Tp>&) const; 120117397Skan template<class _Dom> 12197403Sobrien void operator<<=(const _Expr<_Dom,_Tp>&) const; 122117397Skan template<class _Dom> 123132720Skan void operator>>=(const _Expr<_Dom,_Tp>&) const; 12497403Sobrien 12597403Sobrien private: 126117397Skan mask_array(_Array<_Tp>, size_t, _Array<bool>); 127117397Skan friend class valarray<_Tp>; 128132720Skan 129117397Skan const size_t _M_sz; 130117397Skan const _Array<bool> _M_mask; 131169691Skan const _Array<_Tp> _M_array; 132132720Skan 133117397Skan // not implemented 134117397Skan mask_array(); 13597403Sobrien }; 13697403Sobrien 137117397Skan template<typename _Tp> 138117397Skan inline mask_array<_Tp>::mask_array(const mask_array<_Tp>& a) 139132720Skan : _M_sz(a._M_sz), _M_mask(a._M_mask), _M_array(a._M_array) {} 14097403Sobrien 141117397Skan template<typename _Tp> 142132720Skan inline 143117397Skan mask_array<_Tp>::mask_array(_Array<_Tp> __a, size_t __s, _Array<bool> __m) 144132720Skan : _M_sz(__s), _M_mask(__m), _M_array(__a) {} 145132720Skan 146117397Skan template<typename _Tp> 147132720Skan inline mask_array<_Tp>& 148132720Skan mask_array<_Tp>::operator=(const mask_array<_Tp>& __a) 149132720Skan { 150132720Skan std::__valarray_copy(__a._M_array, __a._M_mask, 151132720Skan _M_sz, _M_array, _M_mask); 152132720Skan return *this; 153132720Skan } 154132720Skan 155132720Skan template<typename _Tp> 15697403Sobrien inline void 157117397Skan mask_array<_Tp>::operator=(const _Tp& __t) const 158132720Skan { std::__valarray_fill(_M_array, _M_sz, _M_mask, __t); } 159132720Skan 160117397Skan template<typename _Tp> 16197403Sobrien inline void 162117397Skan mask_array<_Tp>::operator=(const valarray<_Tp>& __v) const 163132720Skan { std::__valarray_copy(_Array<_Tp>(__v), __v.size(), _M_array, _M_mask); } 16497403Sobrien 165117397Skan template<typename _Tp> 166117397Skan template<class _Ex> 167117397Skan inline void 168117397Skan mask_array<_Tp>::operator=(const _Expr<_Ex, _Tp>& __e) const 169132720Skan { std::__valarray_copy(__e, __e.size(), _M_array, _M_mask); } 17097403Sobrien 17197403Sobrien#undef _DEFINE_VALARRAY_OPERATOR 172117397Skan#define _DEFINE_VALARRAY_OPERATOR(_Op, _Name) \ 173117397Skan template<typename _Tp> \ 174117397Skan inline void \ 175117397Skan mask_array<_Tp>::operator _Op##=(const valarray<_Tp>& __v) const \ 176117397Skan { \ 177117397Skan _Array_augmented_##_Name(_M_array, _M_mask, \ 178117397Skan _Array<_Tp>(__v), __v.size()); \ 179117397Skan } \ 18097403Sobrien \ 181117397Skan template<typename _Tp> \ 182117397Skan template<class _Dom> \ 183117397Skan inline void \ 184117397Skan mask_array<_Tp>::operator _Op##=(const _Expr<_Dom, _Tp>& __e) const\ 185117397Skan { \ 186117397Skan _Array_augmented_##_Name(_M_array, _M_mask, __e, __e.size()); \ 187117397Skan } 18897403Sobrien 189117397Skan_DEFINE_VALARRAY_OPERATOR(*, __multiplies) 190117397Skan_DEFINE_VALARRAY_OPERATOR(/, __divides) 191117397Skan_DEFINE_VALARRAY_OPERATOR(%, __modulus) 192117397Skan_DEFINE_VALARRAY_OPERATOR(+, __plus) 193117397Skan_DEFINE_VALARRAY_OPERATOR(-, __minus) 194117397Skan_DEFINE_VALARRAY_OPERATOR(^, __bitwise_xor) 195117397Skan_DEFINE_VALARRAY_OPERATOR(&, __bitwise_and) 196117397Skan_DEFINE_VALARRAY_OPERATOR(|, __bitwise_or) 197117397Skan_DEFINE_VALARRAY_OPERATOR(<<, __shift_left) 198117397Skan_DEFINE_VALARRAY_OPERATOR(>>, __shift_right) 19997403Sobrien 200132720Skan#undef _DEFINE_VALARRAY_OPERATOR 201132720Skan 202169691Skan_GLIBCXX_END_NAMESPACE 20397403Sobrien 204132720Skan#endif /* _MASK_ARRAY_H */ 205