std::begin(std::valarray)

template< class T > /unspecified1/ begin( valarray<T>& v );	(1)	(since C++11)
template< class T > /unspecified2/ begin( const valarray<T>& v );	(2)	(since C++11)

The overload of std::begin for valarray returns an iterator of unspecified type referring to the first element in the numeric array.

1) The return type meets the requirements of mutable LegacyRandomAccessIterator.

2) The return type meets the requirements of constant LegacyRandomAccessIterator.

The iterator obtained from this function is invalidated when the member function resize() is called on the array v or when the lifetime of v ends, whichever comes first.

Parameters

v

-

a numeric array

Return value

Iterator to the first value in the numeric array.

Exceptions

May throw implementation-defined exceptions.

Notes

Unlike other functions that take std::valarray arguments, begin() cannot accept the replacement types (such as the types produced by expression templates) that may be returned from expressions involving valarrays: std::begin(v1 + v2) is not portable, std::begin(std::valarray<T>(v1 + v2)) has to be used instead.

The intent of this function is to allow range for loops to work with valarrays, not to provide container semantics.

Example

Run this code

#include <iostream>
#include <valarray>
#include <algorithm>
 
auto show = [](std::valarray<int> const& v) {
    std::for_each(std::begin(v), std::end(v), [](int c) {
        std::cout << c << ' ';
    });
    std::cout << '\n';
};
 
int main()
{
    const std::valarray<int> x { 47, 70, 37, 52, 90, 23, 17, 33, 22, 16, 21, 4 };
    const std::valarray<int> y { 25, 31, 71, 56, 21, 21, 15, 34, 21, 27, 12, 6 };
 
    show(x); 
    show(y); 
 
    const std::valarray<int> z { x + y };
 
    std::for_each(std::begin(z), std::end(z), [](char c) { std::cout << c; });
}

Output:

47 70 37 52 90 23 17 33 22 16 21 4 
25 31 71 56 21 21 15 34 21 27 12 6 
Hello, C++!

Compiler support
Freestanding and hosted
Language
Standard library headers
Named requirements
Feature test macros (C++20)
Language support library
Concepts library (C++20)
Metaprogramming library (C++11)
Diagnostics library
General utilities library
Strings library
Containers library
Iterators library
Ranges library (C++20)
Algorithms library
Numerics library
Localizations library
Input/output library
Filesystem library (C++17)
Regular expressions library (C++11)
Concurrency support library (C++11)
Technical specifications
Symbols index
External libraries

Common mathematical functions
Mathematical special functions (C++17)
Mathematical constants (C++20)
Floating-point environment (C++11)
Complex numbers
Numeric arrays
Pseudo-random number generation
Factor operations
gcd (C++17)
lcm (C++17)
Interpolations
midpoint (C++20)
lerp (C++20)
Generic numeric operations
iota (C++11)
ranges::iota (C++23)
accumulate
inner_product
adjacent_difference
partial_sum
reduce (C++17)
transform_reduce (C++17)
inclusive_scan (C++17)
exclusive_scan (C++17)
transform_inclusive_scan (C++17)
transform_exclusive_scan (C++17)
Bit operations
bit_cast (C++20)
byteswap (C++23)
has_single_bit (C++20)
bit_ceil (C++20)
bit_floor (C++20)
bit_width (C++20)
rotl (C++20)
rotr (C++20)
countl_zero (C++20)
countl_one (C++20)
countr_zero (C++20)
countr_one (C++20)
popcount (C++20)
endian (C++20)