mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 08:26:04 +08:00
4a88884b39
* Add ranges * Initial Hugo setup * Work in progress * Added selection for local or remote site * Updated to 'light' theme * Changed to using Hextra Hugo theme * Changed to using Hextra Hugo theme * Changed to Hextra Hugo theme * Change to Hextra Hugo theme * Updated Hugo setup. * Updated Hugo setup. # Conflicts: # docs/releases/_index.md * Work in progress * Added new fonts Added new documentation * Latest documentation updates * Latest documentation updates # Conflicts: # docs/containers/array.md # docs/containers/array_view.md # docs/containers/array_wrapper.md # docs/containers/bip_buffer_spsc_atomic.md # docs/containers/bitset.md # docs/containers/indirect_vector.md # docs/containers/vector.md # docs/getting-started/compilers.md * Added bloom_filter markdown doc * Added more documentation Updated CSS for light and dark modes * Fixed some menus Added mode documentation files * Updated CSS rules Added badges to home page Added uniqur_ptr + pool tutorial * Fixed formatting on the home page markdown Modified light amd dark code formatting * Updated unique_ptr-with-pool * Added container and shared message tutorials * Updates to documentation * Added const_multimap * Updated source-formatting.md * Added initial raw text files form Web site editor * Innore coverage build directory * Exported raw text documentation files from the web site editor * Hugo updates * Added Hugo intalation and markdown descriptions * More addition to the documentation * Added closure.md and updates to delegate.md * Added format.md * Added documentation for etl::delegate_observable, etl::function, Base64 codec * Added io_port documentation * Added basic_format_spec * Added documentation for string_stream and string utilities. * Added more documentation Updated the documentation CSS * Added documentation for clocks, day, duration * Added more documentation for chrono classes Updated callouts * More chrono documentation * Completed chrono documentation * Maths functions documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Completed maths documentation * Added multiple documentation files * Added iterator.md * Added debug_count.md and versions.md * Added debug_count.md and versions.md * Added more documentation * More documentation * Added some design pattern documentation Modified some of the layout files Modified the About documentation * Converted more documentation pages Modified the site CSS * Added more documentation Moced some documentation files to new directories * Added more documentation Tweaks to CSS * Added callback_timer_deferred_locked documentation * Added callback_timer_locked documentation * More documentation updates * More documentation updates * More documentation updates * New documentation files. Harmonised file name format * New documentation files. * Multiple document updates * Multiple document updates * Final conversion of web pages * Updates before PR * Updates before PR * Updates before PR # Conflicts: # docs/blog/_index.md * Final pre PR updates * Updates to message framework documentation * Renamed directory * Fix spelling * Added author and date to blog files Moved documentation files merged from development * Fixed 'Description' typo * Fix typos # Conflicts: # docs/IO/io_port.md # docs/containers/sets/const-multiset.md # docs/containers/sets/const-set.md # docs/maths/correlation.md # docs/maths/gamma.md * Renamed two files to lower case * Minor renaming * Added author and date * Updated callout on bresenham_line.md Added support for showing the ETL version on the documentation first page, by copying the version.txt file as a hugo asset. Updated the Python 'update_release.py' to copy 'version.txt' * Replace space in filename with hyphen. Added more information to hugo-commands.md * Replace space in filename with hyphen. Added more information to hugo-commands.md # Conflicts: # docs/getting-started/view-the-docs-locally/hugo-commands.md * Added a link to pseudo_moving_average.md * Updated title pages for groups * Fixed missing 404 for non-existent pages * Fixed coordinate variable names in the 'Calculating the intersection' example --------- Co-authored-by: Roland Reichwein <Roland.Reichwein@bmw.de> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com> Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.co.uk>
4.9 KiB
4.9 KiB
| title |
|---|
| tuple |
{{< callout type="info">}}
Header: tuple.h
From: 20.41.0
Similar to: std::tuple
{{< /callout >}}
A fixed-size collection of heterogeneous values.
Adds additional functionality to std::tuple.
etl::tuple<typename... Types>
Template deduction guides
C++17 and above.
Template deduction guide from variadic arguments.
template <typename... TArgs>
tuple(TArgs... args) -> tuple<TArgs...>;
Template deduction guide from pair.
template <typename T1, typename T2>
tuple(ETL_OR_STD::pair<T1, T2>) -> tuple<T1, T2>;
Example
etl::tuple tp(1, 2.2, 3, std::string("4"));
Equivalent to:
etl::tuple<int, double, int, std::string> t(1, 2.2, 3, std::string("4"));
Make tuple
template <typename... Types>
ETL_NODISCARD
ETL_CONSTEXPR14
etl::tuple<etl::unwrap_ref_decay_t<Types>...> make_tuple(Types&&... args)
Example
auto t = etl::make_tuple(1, 2.2, 3, std::string("4"));
Equivalent to:
etl::tuple<int, double, int, std::string> t(1, 2.2, 3, std::string("4"));
Member types
value_type
The first type contained by this tuple.
this_type
The type of this tuple.
base_type
The type of the base tuple to this tuple. This is a tuple of all types except for the first.
index_sequence_type
The index_sequence type for this tuple.
Constructor
Default or copy constructs each element.
Can be initialised like a C array.
etl::array<int, 10> data = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 };
Access
template <size_t Index, typename Tuple>
etl::tuple_element;
Capacity
template <typename Tuple>
struct tuple_size;
ETL Extensions
template <typename T>
struct is_tuple
If T is a tuple then etl::is_tuple is defined as etl::true_type, otherwise etl::false_type.
Specialisations of STL to allow the use of C++ structured bindings.
template <typename... Types>
struct tuple_size<etl::tuple<Types...>>
Specialisation of tuple_size to allow the use of C++ structured bindings.
Declared in namespace std.
template <size_t Index, typename... Types>
struct tuple_element<Index, etl::tuple<Types...>>
Specialisation of tuple_element to allow the use of C++ structured bindings.
Declared in namespace std.
Convert an etl::tuple to a std::tuple
template <typename... Types>
ETL_NODISCARD
ETL_CONSTEXPR14
auto to_std(const etl::tuple<Types...>& etl_tuple)
Converts an etl::tuple to a std::tuple.
Enabled when STL is available.
template <typename... Types>
ETL_NODISCARD
ETL_CONSTEXPR14
auto to_std(etl::tuple<Types...>&& etl_tuple)
Converts an etl::tuple to a std::tuple.
Enabled when STL is available.
Convert an std::tuple to a etl::tuple
template <typename... Types>
ETL_NODISCARD
ETL_CONSTEXPR14
auto to_etl(const std::tuple<Types...>& std_tuple)
Converts a std::tuple to an etl::tuple.
Enabled when STL is available.
template <typename... Types>
ETL_NODISCARD
ETL_CONSTEXPR14
auto to_etl(std::tuple<Types...>&& std_tuple)
Converts a std::tuple to an etl::tuple.
Enabled when STL is available.
Create a tuple from selected elements of another
template <typename Tuple, size_t... Indices>
ETL_NODISCARD
ETL_CONSTEXPR14
auto select_from_tuple(Tuple&& tuple, etl::index_sequence<Indices...>)
Creates a new tuple by selecting elements from another, given a run time index sequence.
Static asserts if the number of indices does not match the tuple size.
template <size_t... Indices, typename Tuple>
ETL_NODISCARD
ETL_CONSTEXPR14
auto select_from_tuple(Tuple&& tuple)
Creates a new tuple by selecting elements from another, given a template parameter index sequence.
Static asserts if the number of indices does not match the tuple size.
Non-member functions
template <size_t Index, typename... Types>
ETL_CONSTEXPR14
etl::tuple_element_t<Index, etl::tuple<Types...>>& get(tuple<Types...>&);
template <size_t Index, typename... Types>
ETL_CONSTEXPR14
etl::tuple_element_t<Index, etl::tuple<Types...>>&& get(tuple<Types...>&&);
template <size_t Index, typename... Types>
ETL_CONSTEXPR14
const etl::tuple_element_t<Index, etl::tuple<Types...>>& get(const tuple<Types...>&);
template <size_t Index, typename... Types>
ETL_CONSTEXPR14
const etl::tuple_element_t<Index, etl::tuple<Types...>>&& get(const tuple<Types...>&&);
template <typename T, typename... Types>
ETL_CONSTEXPR14
T& get(tuple<Types...>&);
template <typename T, typename... Types>
ETL_CONSTEXPR14
T&& get(tuple<Types...>&&);
template <typename T, typename... Types>
ETL_CONSTEXPR14
const T& get(const tuple<Types...>&);
template <typename T, typename... Types>
ETL_CONSTEXPR14
const T&& get(const tuple<Types...>&&);