STD::MASK_ARRAY(3cxx)

📦
version 14-20240412 · 16 versions
, in ubuntu noble

okay bestie, sit down, hydrate, and get comfy: this is the manual page for std::mask_array< _Tp >, from the C++ docs, section 3cxx. It’s literally “Reference to selected subset of an array,” and it’s giving backstage-pass energy to a valarray. 💅✨

💖 NAME 💖

std::mask_array< _Tp > — Reference to selected subset of an array. That’s the whole name, no cap. 🫶

✨ SYNOPSIS ✨

First things first, you gotta include the header, bestie:

#include <valarray>

🌸 Public Types 🌸

  • typedef _Tp value_type — the element type, just vibing as value_type.

🧚 Public Member Functions 🧚

Okay, this is the main-character list. Every overload is here, and yes, we’re listing all of them. 🎀

  • mask_array (const mask_array &) — Copy constructor. Both slices refer to the same underlying array — same underlying tea, two sippers. 🫖
  • operator%= — Modulo slice elements by corresponding elements of v.
    • template<class _Dom > void operator%= (const _Expr< _Dom, _Tp > &) const
    • void operator%= (const valarray< _Tp > &) const
  • operator&= — 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
  • operator*= — Multiply slice elements by corresponding elements of v.
    • template<class _Dom > void operator*= (const _Expr< _Dom, _Tp > &) const
    • void operator*= (const valarray< _Tp > &) const
  • operator+= — Add corresponding elements of v to slice elements.
    • template<class _Dom > void operator+= (const _Expr< _Dom, _Tp > &) const
    • void operator+= (const valarray< _Tp > &) const
  • operator-= — Subtract corresponding elements of v from slice elements.
    • template<class _Dom > void operator-= (const _Expr< _Dom, _Tp > &) const
    • void operator-= (const valarray< _Tp > &) const
  • operator/= — Divide slice elements by corresponding elements of v.
    • template<class _Dom > void operator/= (const _Expr< _Dom, _Tp > &) const
    • void operator/= (const valarray< _Tp > &) const
  • operator<<= — Left shift slice elements by corresponding elements of v.
    • template<class _Dom > void operator<<= (const _Expr< _Dom, _Tp > &) const
    • void operator<<= (const valarray< _Tp > &) const
  • operator= — the assignment overloads, all lined up:
    • 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 &) — Assignment operator. Assigns elements to corresponding elements of a.
    • void operator= (const valarray< _Tp > &) const
  • operator>>= — 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
  • operator^= — 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
  • operator|= — Logical or slice elements with corresponding elements of v.
    • template<class _Dom > void operator|= (const _Expr< _Dom, _Tp > &) const
    • void operator|= (const valarray< _Tp > &) const

🦋 Friends 🦋

  • class valarray< _Tp >

🔥 Detailed Description 🔥

The docs literally print this class signature, stray quote and all — I’m keeping it exactly because we don’t edit the source tea:

template<class _Tp>
class std::mask_array< _Tp >"Reference to selected subset of an array.

Now the plot: 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. It’s like a VIP list for elements only. 🎟️

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. Two little icons made it past the velvet rope. 🫶

🍓 Parameters 🍓

  • Tp — Element type. That’s it, that’s the parameter.

🌈 Member Function Documentation 🌈

These are the ones the docs call out again, with their exact signatures. Yes, we’re repeating them because the manual does — consistency slay. 💅

  • 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 robots wrote this one, and honestly they ate. 🤖✨

💖 source/version: libstdc++ · page: std::mask_array< _Tp >(3cxx) · date: no date shown on this page, bestie. mwah 💋

📦 where this page comes from