libstdc++: elements_of.h Source File

libstdc++

elements_of.h
1// Tag type for yielding ranges rather than values in <generator> -*- C++ -*-
2
3// Copyright (C) 2023-2026 Free Software Foundation, Inc.
4//
5// This file is part of the GNU ISO C++ Library. This library is free
6// software; you can redistribute it and/or modify it under the
7// terms of the GNU General Public License as published by the
8// Free Software Foundation; either version 3, or (at your option)
9// any later version.
10
11// This library is distributed in the hope that it will be useful,
12// but WITHOUT ANY WARRANTY; without even the implied warranty of
13// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14// GNU General Public License for more details.
15
16// Under Section 7 of GPL version 3, you are granted additional
17// permissions described in the GCC Runtime Library Exception, version
18// 3.1, as published by the Free Software Foundation.
19
20// You should have received a copy of the GNU General Public License and
21// a copy of the GCC Runtime Library Exception along with this program;
22// see the files COPYING3 and COPYING.RUNTIME respectively. If not, see
23// <http://www.gnu.org/licenses/>.
24
25#ifndef _GLIBCXX_BITS_ELEMENTS_OF
26#define _GLIBCXX_BITS_ELEMENTS_OF
27
28#ifdef _GLIBCXX_SYSHDR
29#pragma GCC system_header
30#endif
31
32#include <bits/c++config.h>
33
34#include <bits/version.h>
35
36// C++ >= 23 && __glibcxx_coroutine
37#if defined(__glibcxx_ranges) && defined(__glibcxx_generator)
38#include <bits/ranges_base.h>
39#include <bits/memoryfwd.h>
40
41#if _GLIBCXX_HOSTED
42# include <bits/allocator.h> // likely desirable if hosted.
43#endif // HOSTED
44
45namespace std _GLIBCXX_VISIBILITY(default)
46{
47_GLIBCXX_BEGIN_NAMESPACE_VERSION
48namespace ranges
49{
50
51 /**
52 * @ingroup ranges
53 * @since C++23
54 * @{
55 */
56
57 template<range _Range, typename _Alloc = allocator<byte>>
58 struct elements_of
59 {
60 [[no_unique_address]] _Range range;
61 [[no_unique_address]] _Alloc allocator = _Alloc();
62 };
63
64 template<typename _Range, typename _Alloc = allocator<byte>>
65 elements_of(_Range&&, _Alloc = _Alloc())
66 -> elements_of<_Range&&, _Alloc>;
67
68 /// @}
69}
70_GLIBCXX_END_NAMESPACE_VERSION
71} // namespace std
72
73#endif // __glibcxx_generator && __glibcxx_ranges
74#endif // _GLIBCXX_BITS_ELEMENTS_OF
allocator.h
memoryfwd.h
ranges_base.h
version.h
c++config.h
std
ISO C++ entities toplevel namespace is std.
std::ranges::elements_of
Definition elements_of.h:59
std::ranges::range
[range.range] The range concept.
Definition ranges_base.h:510