etl/docs/types/largest.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* 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>
2026-06-06 13:12:44 +01:00

5.2 KiB

title
largest

{{< callout type="info">}} Header: largest.h
Since: TBC
{{< /callout >}}

Allows the largest type or largest alignment to be determined.
This file is generated from largest_generator.h. See Generators

largest_type

Template to determine the largest type and size.
Defines type and size of the largest type parameter.

C++ 03

By default, supports up to 16 types.

template <typename T1,         typename T2  = void, typename T3  = void, typename T4  = void,
          typename T5  = void, typename T6  = void, typename T7  = void, typename T8  = void,
          typename T9  = void, typename T10 = void, typename T11 = void, typename T12 = void,
          typename T13 = void, typename T14 = void, typename T15 = void, typename T16 = void>
struct largest_type;

C++ 11 and above

template <typename... TTypes>
struct largest_type;

C++14 and above

template <typename... T>
using largest_type_t = typename largest_type<T...>::type;

C++17 and above

template <typename... T>
constexpr size_t largest_type_v = largest_type<T...>::size;

Example

template <typename T1, typename T2, typename T3>
struct Test
{
  // Defines largest_t as the largest type of T1, T2 and T3.
  typedef typename etl::largest_type<T1, T2, T3>::type largest_t;

  enum
  {
    // Defines size as the size of the largest type.
    size = etl::largest_type<T1, T2, T3>::size;
  }
};

largest_alignment

Template to determine the largest alignment.
Defines value which is the largest alignment.

C++ 03

template <typename T1,         typename T2  = void, typename T3  = void, typename T4  = void,
          typename T5  = void, typename T6  = void, typename T7  = void, typename T8  = void,
          typename T9  = void, typename T10 = void, typename T11 = void, typename T12 = void,
          typename T13 = void, typename T14 = void, typename T15 = void, typename T16 = void>
struct largest_alignment;

C++ 11 and above

template <typename... TTypes>
struct largest_alignment;

C++ 17 and above

template <typename... T>
constexpr size_t largest_alignment_v = largest_alignment<T...>::size;

Example

template <typename T1, typename T2, typename T3>
struct Test
{
  // Defines ALIGNMENT with the value of the largest alignment of T1, T2 and T3.
  enum
  {
    ALIGNMENT = etl::largest_alignment<T1, T2, T3>::value
  };
};

larger_int_type

Template to determine the next larger sized signed int type. The template type maybe signed or unsigned.
If there is no larger type then the signed version of the original type is returned.

template <typename T>
struct larger_int_type;

C++14 and above

template <typename... T>
using larger_int_type_t = typename larger_int_type<T...>::type;

Example

// Would normally define type_t as an int
typedef etl::larger_int_type<short>::type type_t; 

// Would normally define type_t as an int
typedef etl::larger_int_type<unsigned short>::type type_t; 

larger_uint_type

Template to determine the next larger sized unsigned int type. The template type maybe signed or unsigned.
If there is no larger type then the unsigned version of the original type is returned.

template <typename T>
struct larger_uint_type;

C++14 and above

template <typename... T>
using larger_int_type_t = typename larger_int_type<T...>::type;

Example

// Would normally define type_t as an unsigned int
typedef etl::larger_uint_type<short>::type type_t; 

// Would normally define type_t as an unsigned int
typedef etl::larger_uint_type<unsigned short>::type type_t; 

larger_type

Template to determine the next larger sized int type. The template type maybe signed or unsigned.
Signed parameters define signed types, unsigned parameters define unsigned types.
If there is no larger type then the original type is returned.

template <typename T>
struct larger_type;

C++14 and above

template <typename... T>
using larger_type_t = typename larger_type<T...>::type;

Example

// Would normally define type_t as an int
typedef etl::larger_type<short>::type type_t;

// Would normally define type_t as an unsigned int
typedef etl::larger_type<unsigned short>::type type_t;

largest

A handy combination of two of the previous templates.
Template to determine the largest type, size and alignment.
Defines type which is the type of the largest type parameter.
Defines size which is the size of the largest parameter.
Defines alignment which largest alignment of all the type parameters.
NOTE: This may not be the alignment of the largest type.

C++ 03

template <typename T1,         typename T2  = void, typename T3  = void, typename T4  = void,
          typename T5  = void, typename T6  = void, typename T7  = void, typename T8  = void,
          typename T9  = void, typename T10 = void, typename T11 = void, typename T12 = void,
          typename T13 = void, typename T14 = void, typename T15 = void, typename T16 = void>
struct largest;

C++ 11 and above

template <typename... TTypes>
struct largest;

C++14 and above

template <typename... T>
using largest_t = typename largest<T...>::type;