STD::MASK_ARRAY(3)

💖 std::mask_array<_Tp> 💖

okay bestie, welcome to std::mask_array< _Tp > from the Library Functions Manual, section 3 🎀 — it's a Reference to selected subset of an array. no cap, that's literally the whole vibe.

---

✨ NAME ✨

std::mask_array< _Tp > — a reference to a selected subset of an array, and she ate 💅

---

🌸 SYNOPSIS 🌸

#include <valarray>

🦋 Public Types

• typedef _Tp value_type

🫶 Public Member Functions

• mask_array (const mask_array &) — the copy constructor. Both slices refer to the same underlying array. (yes, they're sharing, it's giving twins not clones 😭)
• template<class _Dom> void operator%= (const _Expr< _Dom, _Tp > &) const
• void operator%= (const valarray< _Tp > &) const — Modulo slice elements by corresponding elements of v.
• template<class _Dom> void operator&= (const _Expr< _Dom, _Tp > &) const
• void operator&= (const valarray< _Tp > &) const — Logical and slice elements with corresponding elements of v.
• template<class _Dom> void operator*= (const _Expr< _Dom, _Tp > &) const
• void operator*= (const valarray< _Tp > &) const — Multiply slice elements by corresponding elements of v.
• template<class _Dom> void operator+= (const _Expr< _Dom, _Tp > &) const
• void operator+= (const valarray< _Tp > &) const — Add corresponding elements of v to slice elements.
• template<class _Dom> void operator-= (const _Expr< _Dom, _Tp > &) const
• void operator-= (const valarray< _Tp > &) const — Subtract corresponding elements of v from slice elements.
• template<class _Dom> void operator/= (const _Expr< _Dom, _Tp > &) const
• void operator/= (const valarray< _Tp > &) const — Divide slice elements by corresponding elements of v.
• template<class _Dom> void operator<<= (const _Expr< _Dom, _Tp > &) const
• void operator<<= (const valarray< _Tp > &) const — Left shift slice elements by corresponding elements of v.
• template<class _Dom> void operator= (const _Expr< _Dom, _Tp > &) const
• template<class _Ex> void operator= (const _Expr< _Ex, _Tp > &__e) const
• void operator= (const _Tp &) const — Assign all slice elements to t.
• mask_array & operator= (const mask_array &) — the assignment operator. Assigns elements to corresponding elements of a.
• void operator= (const valarray< _Tp > &) const
• template<class _Dom> void operator>>= (const _Expr< _Dom, _Tp > &) const
• void operator>>= (const valarray< _Tp > &) const — Right shift slice elements by corresponding elements of v.
• template<class _Dom> void operator^= (const _Expr< _Dom, _Tp > &) const
• void operator^= (const valarray< _Tp > &) const — Logical xor slice elements with corresponding elements of v.
• template<class _Dom> void operator|= (const _Expr< _Dom, _Tp > &) const
• void operator|= (const valarray< _Tp > &) const — Logical or slice elements with corresponding elements of v.

👑

Friends

• class valarray< _Tp >

---

💜 DETAILED DESCRIPTION 💜

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

"Reference to selected subset of an array." periodt.

so a mask_array is a reference to the actual elements of an array, and those elements get picked out by a bitmask — which shows up in the form of an array of bool. the way you get a mask_array is to call operator[](valarray<bool>) on a valarray. the mask_array that comes back then lets you carry operations out on that referenced subset of elements in the original valarray. it's giving backstage pass to some of the array, not the whole thing 🔥

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. see how she skipped index 0 and 2? iconic filtering behaviour ✨

🍓 Parameters

• Tp — Element type.

---

🧚 MEMBER FUNCTION DOCUMENTATION 🧚

okay so here are the valarray versions spelled out in full, one by one, no skipping, we do not leave the girlies behind 💅

• template<class _Tp> void std::mask_array< _Tp >::operator%= (const valarray< _Tp > & ) const — Modulo slice elements by corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator&= (const valarray< _Tp > & ) const — Logical and slice elements with corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator*= (const valarray< _Tp > & ) const — Multiply slice elements by corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator+= (const valarray< _Tp > & ) const — Add corresponding elements of v to slice elements.
• template<class _Tp> void std::mask_array< _Tp >::operator-= (const valarray< _Tp > & ) const — Subtract corresponding elements of v from slice elements.
• template<class _Tp> void std::mask_array< _Tp >::operator/= (const valarray< _Tp > & ) const — Divide slice elements by corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator<<= (const valarray< _Tp > & ) const — Left shift slice elements by corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator>>= (const valarray< _Tp > & ) const — Right shift slice elements by corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator^= (const valarray< _Tp > & ) const — Logical xor slice elements with corresponding elements of v.
• template<class _Tp> void std::mask_array< _Tp >::operator|= (const valarray< _Tp > & ) const — Logical or slice elements with corresponding elements of v.

---

🌈 AUTHOR 🌈

Generated automatically by Doxygen for libstdc++ from the source code. (the robot wrote it, I just did her makeup 💖)

---

and that's the whole page bestie, no notes, we kept every single operator, every overload, every default, every word — slay 💅✨

kisses, this was std::mask_array< _Tp >(3) from libstdc++, section 3 of the manual, and it's literally the end of the page 🎀🦋💜