# std::mask_array< _Tp > Class Template Reference

List of all members.

## Detailed Description

### template<class _Tp>
class std::mask_array< _Tp >

A mask_array is a reference to the actual elements of an array specified by a bitmask in the form of an array of bool. The way to get a mask_array is to call operator[](valarray<bool>) on a valarray. The returned mask_array then permits carrying operations out on the referenced subset of elements in the original valarray.

For example, if a mask_array is obtained using the array (false, true, false, true) as an argument, the mask array has two elements referring to array[1] and array[3] in the underlying array.

Parameters:

  | Tp | Element type.

Definition at line 61 of file mask_array.h.

## Public Types

- typedef _Tp value_type

## Public Member Functions

- mask_array (const mask_array &)
- template<class _Dom> void operator &= (const _Expr< _Dom, _Tp > &) const
- void operator &= (const valarray< _Tp > &) const
- template<class _Dom> void operator *= (const _Expr< _Dom, _Tp > &) const
- void operator *= (const valarray< _Tp > &) const
- template<class _Dom> void operator%= (const _Expr< _Dom, _Tp > &) const
- void operator%= (const valarray< _Tp > &) const
- template<class _Dom> void operator+= (const _Expr< _Dom, _Tp > &) const
- void operator+= (const valarray< _Tp > &) const
- template<class _Dom> void operator-= (const _Expr< _Dom, _Tp > &) const
- void operator-= (const valarray< _Tp > &) const
- template<class _Dom> void operator/= (const _Expr< _Dom, _Tp > &) const
- void operator/= (const valarray< _Tp > &) const
- template<class _Dom> void operator<<= (const _Expr< _Dom, _Tp > &) const
- void operator<<= (const valarray< _Tp > &) const
- template<class _Dom> void operator= (const _Expr< _Dom, _Tp > &) const
- void operator= (const _Tp &) const
- void operator= (const valarray< _Tp > &) const
- mask_array & operator= (const mask_array &)
- template<class _Dom> void operator>>= (const _Expr< _Dom, _Tp > &) const
- void operator>>= (const valarray< _Tp > &) const
- template<class _Dom> void operator^= (const _Expr< _Dom, _Tp > &) const
- void operator^= (const valarray< _Tp > &) const
- template<class _Dom> void operator|= (const _Expr< _Dom, _Tp > &) const
- void operator|= (const valarray< _Tp > &) const

## Friends

- class valarray< _Tp >

## Constructor & Destructor Documentation

template<typename _Tp>

std::mask_array< _Tp >::mask_array | ( | const mask_array< _Tp > & |  | ) | `[inline]`

Copy constructor. Both slices refer to the same underlying array.

Definition at line 138 of file mask_array.h.

## Member Function Documentation

template<typename _Tp>

void std::mask_array< _Tp >::operator &= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Logical and slice elements with corresponding elements of v.

Definition at line 195 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator *= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Multiply slice elements by corresponding elements of v.

Definition at line 189 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator%= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Modulo slice elements by corresponding elements of v.

Definition at line 191 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator+= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Add corresponding elements of v to slice elements.

Definition at line 192 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator-= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Subtract corresponding elements of v from slice elements.

Definition at line 193 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator/= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Divide slice elements by corresponding elements of v.

Definition at line 190 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator<<= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Left shift slice elements by corresponding elements of v.

Definition at line 197 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator= | ( | const _Tp & |  | ) | const`[inline]`

Assign all slice elements to t.

Definition at line 157 of file mask_array.h.

References std::__valarray_fill().

template<typename _Tp>

mask_array< _Tp > & std::mask_array< _Tp >::operator= | ( | const mask_array< _Tp > & |  | ) | `[inline]`

of a.

Definition at line 148 of file mask_array.h.

References std::__valarray_copy(), std::mask_array< _Tp >::_M_array, and std::mask_array< _Tp >::_M_mask.

template<typename _Tp>

void std::mask_array< _Tp >::operator>>= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Right shift slice elements by corresponding elements of v.

Definition at line 198 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator^= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Logical xor slice elements with corresponding elements of v.

Definition at line 194 of file mask_array.h.

template<typename _Tp>

void std::mask_array< _Tp >::operator|= | ( | const valarray< _Tp > & |  | ) | const`[inline]`

Logical or slice elements with corresponding elements of v.

Definition at line 196 of file mask_array.h.

The documentation for this class was generated from the following file:

- mask_array.h