STD::VALARRAY(3)

💖 std::valarray< _Tp > 💖

Library Functions Manual · section 3

okay so bestie, sit down, hydrate, because today we are talking about std::valarray< _Tp >, and she is that girl. this is the manual page for the smart array that the C++ standard library built specifically for numeric processing. no cap. 🎀

---

✨ NAME ✨

std::valarray< _Tp > — Smart array designed to support numeric processing.

she's literally described as smart. the bar is on the floor and she cleared it. 💅

---

🌸 SYNOPSIS 🌸

#include <valarray>

---

🦋 Public Types 🦋

• typedef _Tp value_type — the type of the stuff living inside her. iconique.

---

💜 Public Member Functions 💜

okay this is the big one, the main event, the reason we're all here. strap in. 🌈

• valarray () noexcept — Construct an empty array. she starts with nothing and that's valid.
• template<class _Dom> valarray (const _Expr< _Dom, _Tp > &__e) — the docs gave this one no description at all, so she's keeping it mysterious. 🙈
• valarray (const _Tp &, size_t) — Construct an array with n elements initialized to t.
• template<typename _Tp> valarray (const _Tp *__restrict__ __p, size_t __n) — no description here either. enigmatic queen. 💀
• valarray (const _Tp *__restrict__, size_t) — Construct an array initialized to the first n elements of t.
• valarray (const gslice_array< _Tp > &) — Construct an array with the same size and values in ga.
• valarray (const indirect_array< _Tp > &) — Construct an array with the same size and values in ia.
• valarray (const mask_array< _Tp > &) — Construct an array with the same size and values in ma.
• valarray (const slice_array< _Tp > &) — Construct an array with the same size and values in sa.
• valarray (const valarray &) — Copy constructor. making a whole new her, fr fr.
• valarray (initializer_list< _Tp >) — Construct an array with an initializer_list of values.
• valarray (size_t) — Construct an array with n elements.
• valarray (valarray &&) noexcept — Move constructor. she's moving out, no drama, noexcept. 🫶
• _Expr< _ValFunClos< _ValArray, _Tp >, _Tp > apply (_Tp __func(_Tp)) const — Apply a function to the array.
• _Expr< _RefFunClos< _ValArray, _Tp >, _Tp > apply (_Tp __func(const _Tp &)) const — Apply a function to the array.
• valarray< _Tp > cshift (int __n) const — Return a rotated array.
• _Tp max () const — Return the maximum element using operator<().
• _Tp min () const — Return the minimum element using operator<().
• _UnaryOp< __logical_not >::_Rt operator! () const — Return a new valarray by applying unary ! to each element.
• template<class _Dom> valarray< _Tp > & operator%= (const _Expr< _Dom, _Tp > &) — no description given. she said "figure it out bestie." 💅
• valarray< _Tp > & operator%= (const _Tp &) — Set each element e of array to e % t.
• valarray< _Tp > & operator%= (const valarray< _Tp > &) — Modulo elements of array by corresponding elements of v.
• template<class _Dom> valarray< _Tp > & operator&= (const _Expr< _Dom, _Tp > &) — no description. silent but deadly.
• valarray< _Tp > & operator&= (const _Tp &) — Set each element e of array to e & t.
• valarray< _Tp > & operator&= (const valarray< _Tp > &) — Logical and corresponding elements of v with elements of array.
• template<class _Dom> valarray< _Tp > & operator*= (const _Expr< _Dom, _Tp > &) — no description. mysterious as always.
• valarray< _Tp > & operator*= (const _Tp &) — Multiply each element of array by t.
• valarray< _Tp > & operator*= (const valarray< _Tp > &) — Multiply elements of array by corresponding elements of v.
• _UnaryOp< __unary_plus >::_Rt operator+ () const — Return a new valarray by applying unary + to each element.
• template<class _Dom> valarray< _Tp > & operator+= (const _Expr< _Dom, _Tp > &) — no description, keeping it lowkey.
• valarray< _Tp > & operator+= (const _Tp &) — Add t to each element of array.
• valarray< _Tp > & operator+= (const valarray< _Tp > &) — Add corresponding elements of v to elements of array.
• _UnaryOp< __negate >::_Rt operator- () const — Return a new valarray by applying unary - to each element.
• template<class _Dom> valarray< _Tp > & operator-= (const _Expr< _Dom, _Tp > &) — no description. 🙈
• valarray< _Tp > & operator-= (const _Tp &) — Subtract t to each element of array.
• valarray< _Tp > & operator-= (const valarray< _Tp > &) — Subtract corresponding elements of v from elements of array.
• template<class _Dom> valarray< _Tp > & operator/= (const _Expr< _Dom, _Tp > &) — no description. she's giving nothing and everything.
• valarray< _Tp > & operator/= (const _Tp &) — Divide each element of array by t.
• valarray< _Tp > & operator/= (const valarray< _Tp > &) — Divide elements of array by corresponding elements of v.
• template<class _Dom> valarray< _Tp > & operator<<= (const _Expr< _Dom, _Tp > &) — no description. iykyk.
• valarray< _Tp > & operator<<= (const _Tp &) — Left shift each element e of array by t bits.
• valarray< _Tp > & operator<<= (const valarray< _Tp > &) — Left shift elements of array by corresponding elements of v.
• template<class _Dom> valarray< _Tp > & operator= (const _Expr< _Dom, _Tp > &) — no description.
• valarray< _Tp > & operator= (const _Tp &__t) — Assign elements to a value.
• valarray< _Tp > & operator= (const gslice_array< _Tp > &__ga) — Assign elements to an array subset.
• valarray< _Tp > & operator= (const indirect_array< _Tp > &__ia) — Assign elements to an array subset.
• valarray< _Tp > & operator= (const mask_array< _Tp > &__ma) — Assign elements to an array subset.
• valarray< _Tp > & operator= (const slice_array< _Tp > &__sa) — Assign elements to an array subset.
• valarray< _Tp > & operator= (const valarray< _Tp > &__v) — Assign elements to an array.
• valarray & operator= (initializer_list< _Tp > __l) — Assign elements to an initializer_list.
• valarray< _Tp > & operator= (valarray< _Tp > &&__v) noexcept — Move assign elements to an array.
• template<class _Dom> valarray< _Tp > & operator>>= (const _Expr< _Dom, _Tp > &) — no description.
• valarray< _Tp > & operator>>= (const _Tp &) — Right shift each element e of array by t bits.
• valarray< _Tp > & operator>>= (const valarray< _Tp > &) — Right shift elements of array by corresponding elements of v.
• gslice_array< _Tp > operator[] (const gslice &__s) — Return a reference to an array subset.
• _Expr< _GClos< _ValArray, _Tp >, _Tp > operator[] (const gslice &__s) const — Return an array subset.
• mask_array< _Tp > operator[] (const valarray< bool > &__m) — Return a reference to an array subset.
• valarray< _Tp > operator[] (const valarray< bool > &__m) const — Return an array subset.
• indirect_array< _Tp > operator[] (const valarray< size_t > &__i) — Return a reference to an array subset.
• _Expr< _IClos< _ValArray, _Tp >, _Tp > operator[] (const valarray< size_t > &__i) const — Return an array subset.
• _Tp & operator[] (size_t __i) noexcept — no description. she just is. 💅
• const _Tp & operator[] (size_t) const noexcept — also no description. the const girlies get it.
• slice_array< _Tp > operator[] (slice __s) — Return a reference to an array subset.
• _Expr< _SClos< _ValArray, _Tp >, _Tp > operator[] (slice __s) const — Return an array subset.
• template<class _Dom> valarray< _Tp > & operator^= (const _Expr< _Dom, _Tp > &) — no description.
• valarray< _Tp > & operator^= (const _Tp &) — Set each element e of array to e ^ t.
• valarray< _Tp > & operator^= (const valarray< _Tp > &) — Logical xor corresponding elements of v with elements of array.
• template<class _Dom> valarray< _Tp > & operator|= (const _Expr< _Dom, _Tp > &) — no description.
• valarray< _Tp > & operator|= (const _Tp &) — Set each element e of array to e | t.
• valarray< _Tp > & operator|= (const valarray< _Tp > &) — Logical or corresponding elements of v with elements of array.
• _UnaryOp< __bitwise_not >::_Rt operator~ () const — Return a new valarray by applying unary ~ to each element.
• void resize (size_t __size, _Tp __c=_Tp()) — Resize array.
• valarray< _Tp > shift (int __n) const — Return a shifted array.
• size_t size () const — Return the number of elements in array.
• _Tp sum () const — Return the sum of all elements in the array.
• void swap (valarray< _Tp > &__v) noexcept — Swap. that's it. that's the whole description. slay. ✨

---

👑 Friends 👑

• struct _Array< _Tp > — yeah she has friends. of course she does. she's popular. 🫶

---

🌈 Detailed Description 🌈

template<class _Tp>
class std::valarray< _Tp >

Smart array designed to support numeric processing.

okay so here's the tea. 🍓

A valarray is an array that provides constraints intended to allow for effective optimization of numeric array processing by reducing the aliasing that can result from pointer representations. It represents a one-dimensional array from which different multidimensional subsets can be accessed and modified.

translation bestie: she's a one-dimensional queen 👑 who is also the gateway to every multidimensional subset you could ever want to access or modify. the constraints are there on purpose so the compiler can optimize her numeric processing without all that pointer-aliasing mess. it's giving "structured for your own good."

💫 Template Parameters 💫

• _Tp — Type of object in the array.

like, what is she made of. that's _Tp. pick your poison. 🧚

---

🎀 Constructor & Destructor Documentation 🎀

🌸 template<class _Tp> std::valarray< _Tp >::valarray (const _Tp * __restrict__, size_t ) 🌸

Construct an array initialized to the first n elements of t.

References valarray().

ngl the way this one just hands you the first n elements and calls it a day... efficient. iconic. no further comment. 💜

---

more coming, bestie — stay tuned 🦋

✨ Member Function Documentation ✨

okay bestie, this is the part where valarray really shows out. 💅 every arithmetic operator you already know and love? it's here. every bitwise one? here too. and the compound-assign versions all mutate the array in place and hand you back a reference so you can chain them like it's nothing. each one does its thing to every element, element by element, no skipping, no cap.

let's go, one at a time 🫶

---

operator!

template<class _Tp> _UnaryOp< __logical_not >::_Rt std::valarray< _Tp >::operator! () const

returns a whole new valarray by slapping unary ! onto each element. iconique. ✨

operator%=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator%= (const _Tp & )

sets each element e of the array to e % t. modulo time 🍓

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator%= (const valarray< _Tp > & )

takes the modulo of the array's elements by the corresponding elements of v. matching energy, element for element 💜

References valarray().

operator&=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator&= (const _Tp & )

sets each element e of the array to e & t. bitwise besties ✨

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator&= (const valarray< _Tp > & )

logical and of the corresponding elements of v with the elements of the array. they're matching each other, it's giving chemistry 😭

References valarray().

operator*=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator*= (const _Tp & )

multiplies each element of the array by t. glow up for every single one 🔥

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator*= (const valarray< _Tp > & )

multiplies the elements of the array by the corresponding elements of v. pair them up, periodt 💅

References valarray().

operator+

template<class _Tp> _UnaryOp< __unary_plus >::_Rt std::valarray< _Tp >::operator+ () const

returns a fresh new valarray by applying unary + to each element. yes, it's just vibes, but it's const vibes ✨

operator+=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator+= (const _Tp & )

adds t to each element of the array. plus one for everyone 🎀

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator+= (const valarray< _Tp > & )

adds the corresponding elements of v to the elements of the array. hand in hand fr fr 🫶

References valarray().

operator-

template<class _Tp> _UnaryOp< __negate >::_Rt std::valarray< _Tp >::operator- () const

returns a new valarray by applying unary - to each element. the ~negation~ era 💀

operator-=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator-= (const _Tp & )

subtracts t to each element of the array. (yes bestie, that's how the original says it, and I am not the one who's gonna argue with the docs 💅)

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator-= (const valarray< _Tp > & )

subtracts the corresponding elements of v from the elements of the array. one array gives, the other takes 🌸

References valarray().

operator/=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator/= (const _Tp & )

divides each element of the array by t. splitting the vibe evenly ✨

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator/= (const valarray< _Tp > & )

divides the elements of the array by the corresponding elements of v. match made in indexing heaven 😭

References valarray().

operator<<=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator<<= (const _Tp & )

left shifts each element e of the array by t bits. scoot over, bit by bit 🌈

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator<<= (const valarray< _Tp > & )

left shifts the elements of the array by the corresponding elements of v. per-element shift counts, fancy 🎀

operator>>=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator>>= (const _Tp & )

right shifts each element e of the array by t bits. the other direction, equally iconic 💜

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator>>= (const valarray< _Tp > & )

right shifts the elements of the array by the corresponding elements of v. 👑

References valarray().

operator^=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator^= (const _Tp & )

sets each element e of the array to e ^ t. xor o'clock 🦋

References valarray().

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator^= (const valarray< _Tp > & )

logical xor of the corresponding elements of v with the elements of the array. either/or energy, never both 💀

References valarray().

operator|=

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator|= (const _Tp & )

sets each element e of the array to e | t. ✨

template<class _Tp> valarray< _Tp > & std::valarray< _Tp >::operator|= (const valarray< _Tp > & )

logical or of the corresponding elements of v with the elements of the array. inclusive queen behavior 🌸

References valarray().

operator~

template<class _Tp> _UnaryOp< __bitwise_not >::_Rt std::valarray< _Tp >::operator~ () const

returns a brand-new valarray by applying unary ~ to each element. flip every bit, serve every look 🌈

---

🎀 Author 🎀

generated automatically by Doxygen for libstdc++ from the source code. (not a human, just a very diligent little doc robot 🫶✨)

---

okay that's the whole page bestie, you made it to the end, and honestly? ate. 👑

this came straight from the libstdc++ docs — page std::valarray< _Tp >(3), with whatever date stamp your build slapped on the footer 💖 no cap, that's the whole thing. go write some element-wise math and be iconic about it. periodt. 💅✨🦋