mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-15 16:36:03 +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>
83 lines
2.1 KiB
Markdown
83 lines
2.1 KiB
Markdown
---
|
|
title: "endian"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `endian.h`
|
|
Since: `TBC`
|
|
{{< /callout >}}
|
|
|
|
Constants & utilities for endianess.
|
|
|
|
For endian specific integral types, see `unaligned_type`.
|
|
|
|
The values for endianness are dependant on the platform setup.
|
|
|
|
If `ETL_ENDIAN_NATIVE` is defined by the user, then
|
|
 `etl::endian::little = 0`
|
|
 `etl::endian::big = 1`
|
|
|
|
If `ETL_ENDIAN_NATIVE` is not defined by the user, then the ETL selects an appropriate definition.
|
|
 If `ETL_CPP20_SUPPORTED == 1` and `ETL_USING_STL == 1` then
|
|
  `etl::endian::little = std::endian::little`
|
|
  `etl::endian::big = std::endian::big`
|
|
  `etl::endian::native = std::endian::native`
|
|
|
|
else if `__BYTE_ORDER__` is defined then
|
|
 If `__ORDER_LITTLE_ENDIAN__` is defined then
|
|
  `etl::endian::little = __ORDER_LITTLE_ENDIAN__`
|
|
  `etl::endian::big = __ORDER_BIG_ENDIAN__`
|
|
  `etl::endian::native = __BYTE_ORDER__`
|
|
|
|
 else if `__LITTLE_ENDIAN__` is defined
|
|
  `etl::endian::little = __LITTLE_ENDIAN__`
|
|
  `etl::endian::big = __BIG_ENDIAN__`
|
|
  `etl::endian::native = __BYTE_ORDER__`
|
|
|
|
else
|
|
The user needs to define `ETL_ENDIAN_NATIVE` either as `0` for little endian or `1` for big endian.
|
|
|
|
## endian
|
|
A smart enumeration defining little and big members.
|
|
```cpp
|
|
etl::endian::little;
|
|
etl::endian::big;
|
|
```
|
|
|
|
## endianness
|
|
Interrogates the endianness of the platform.
|
|
```cpp
|
|
etl::endian operator ()() const
|
|
```
|
|
`constexpr` if `ETL_CPP11_SUPPORTED == 1` and `ETL_ENDIAN_NATIVE` is defined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
operator etl::endian() const
|
|
```
|
|
`constexpr` if `ETL_CPP11_SUPPORTED == 1` and `ETL_ENDIAN_NATIVE` is defined.
|
|
|
|
---
|
|
|
|
```cpp
|
|
static etl::endian value()
|
|
```
|
|
`constexpr` if `ETL_CPP11_SUPPORTED == 1` and `ETL_ENDIAN_NATIVE` is defined.
|
|
|
|
|
|
## Host to network
|
|
```cpp
|
|
template <typename T>
|
|
T hton(T value)
|
|
```
|
|
**Description**
|
|
Converts `value` from host to network ordering.
|
|
|
|
## Network to host
|
|
```cpp
|
|
template <typename T>
|
|
T ntoh(T value)
|
|
```
|
|
**Description**
|
|
Converts `value` from network to host ordering. |