STD::GSLICE_ARRAY(3cxx)

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

🫶 std::gslice_array< _Tp > 🫶

Okay bestie, welcome to the std::gslice_array< _Tp > page from the 3cxx manual — yes, that 3cxx. This whole page is about a very specific little reference-to-a-multi-dimensional-subset situation, and we're gonna keep every detail while making it actually fun to read. 💅

🌸 NAME 🌸

std::gslice_array< _Tp > — reference to a multi-dimensional subset of an array. That's the whole name-and-blurb combo, and it ate. ✨

✨ SYNOPSIS ✨

#include <valarray>

🎀 Public Types 🎀

  • typedef _Tp value_type — the element type gets its cute alias moment. 🦋

💖 Public Member Functions 💖

  • gslice_array (const gslice_array &) — copy constructor, and no cap: both slices refer to the same underlying array. Both of them. Same array. Iconic shared-reference behavior. 💫
  • template<class _Dom > void operator%= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of modulo assignment, exactly as listed here with no extra one-liner on the page. 🎀
  • void operator%= (const valarray< _Tp > &) const — modulo slice elements by corresponding elements of v.
  • template<class _Dom > void operator&= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of logical-and assignment.
  • 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 — the _Expr overload of multiply-assignment.
  • void operator*= (const valarray< _Tp > &) const — multiply slice elements by corresponding elements of v.
  • template<class _Dom > void operator+= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of add-assignment.
  • void operator+= (const valarray< _Tp > &) const — add corresponding elements of v to slice elements.
  • template<class _Dom > void operator-= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of subtract-assignment.
  • void operator-= (const valarray< _Tp > &) const — subtract corresponding elements of v from slice elements.
  • template<class _Dom > void operator/= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of divide-assignment.
  • void operator/= (const valarray< _Tp > &) const — divide slice elements by corresponding elements of v.
  • template<class _Dom > void operator<<= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of left-shift assignment.
  • 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 — the _Expr assignment overload, sitting right here with no separate description on the page.
  • void operator= (const _Tp &) const — assign all slice elements to t.
  • gslice_array & operator= (const gslice_array &) — assignment operator. Assigns slice elements to corresponding elements of a.
  • void operator= (const valarray< _Tp > &) const — assign slice elements to corresponding elements of v.
  • template<class _Dom > void operator>>= (const _Expr< _Dom, _Tp > &) const — the _Expr overload of right-shift assignment.
  • 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 — the _Expr overload of logical-xor assignment.
  • 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 — the _Expr overload of logical-or assignment.
  • void operator|= (const valarray< _Tp > &) const — logical or slice elements with corresponding elements of v.

🫶 Friends 🫶

  • class valarray< _Tp > — friendship status: confirmed. valarray is a friend of this class. 🥹

💖 Detailed Description 💖

template<typename _Tp>
class std::gslice_array< _Tp >

A gslice_array is a reference to the actual elements of an array specified by a gslice. That's the whole main-character setup: it doesn't own a whole new copy of the world, it refers to the real elements in the original array. 👑

The way to get a gslice_array is to call operator[](gslice) on a valarray. The returned gslice_array then permits carrying operations out on the referenced subset of elements in the original valarray. So you're not doing random busywork on a clone — you're working on the referenced subset. For example, operator+=(valarray) will add values to the subset of elements in the underlying valarray this gslice_array refers to. Slay, but make it element-wise. 💅

🌸 Parameters 🌸

  • Tp — element type.

🔥 Member Function Documentation 🔥

  • template<typename _Tp > void std::gslice_array< _Tp >::operator%= (const valarray< _Tp > &) const — modulo slice elements by corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator&= (const valarray< _Tp > &) const — logical and slice elements with corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator*= (const valarray< _Tp > &) const — multiply slice elements by corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator+= (const valarray< _Tp > &) const — add corresponding elements of v to slice elements.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator-= (const valarray< _Tp > &) const — subtract corresponding elements of v from slice elements.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator/= (const valarray< _Tp > &) const — divide slice elements by corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator<<= (const valarray< _Tp > &) const — left shift slice elements by corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator>>= (const valarray< _Tp > &) const — right shift slice elements by corresponding elements of v.
  • template<typename _Tp > void std::gslice_array< _Tp >::operator^= (const valarray< _Tp > &) const — logical xor slice elements with corresponding elements of v.
  • template<typename _Tp > void std::gslice_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. Very “the robot wrote it so you don't have to” energy. 🤖✨

Source/version: libstdc++ — this page is from the 3cxx manual section. Date: the page itself doesn't print one, so no date to quote, and we're not out here inventing facts. It's giving timeless. Bye bestie, go slice that multi-dimensional subset responsibly 💅🎀🫶

📦 where this page comes from