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>
3.7 KiB
| title |
|---|
| alignment |
{{< callout type="info">}}
Header: alignment.h
Since: TBC
{{< /callout >}}
A way of aligning memory storage through template parameters.
type_with_alignment
Returns a fundamental type that has the same alignment as that specified in the template parameter.
template <const size_t ALIGNMENT>
class type_with_alignment
Example
using type_t = etl::type_with_alignment<4>::type;
aligned_storage
Creates a memory store of the specified length at the specified alignment.
template <const size_t LENGTH, const size_t ALIGNMENT>
struct aligned_storage;
Example
// Creates aligned storage of length 100 at an alignment of 8.
etl::aligned_storage<100, 8>::type storage;
The class defines various conversion operators for ease of use.
Conversions are supplied to T&, const T&, T*, const T*, plus explicit get_address and get_reference member functions.
aligned_storage_as
Creates a memory store of the specified length at the same alignment as the specified type.
template <const size_t LENGTH, typename T>
struct aligned_storage_as;
Example
// Creates aligned storage of length 100 at an alignment of a double.
etl::aligned_storage_as<100, double>::type storage;
typed_storage
From: 20.40.1
template <typename T>
class typed_storage;
Wrapper class that provides a memory area and lets the user create an instance of T in this memory at runtime.
This class also erases the destructor call of T, i.e. if typed_storage goes out of scope, the destructor if the wrapped type will not be called. This can be done explicitly by calling destroy().
T value_type
T& reference
const T& const_reference
T* pointer
const T* const_pointer
typed_storage()
Description
Constructor
~typed_storage() = default;
Description
Defaulted destructor which will NOT call the destructor of the object which was created by calling create().
void destroy()
Description
Calls the destructor of the wrapped object and asserts if has_value() is false.
bool has_value() const
Returns
true if object has been constructed using create(), otherwise false.
template <typename... Args>
reference create(Args&&... args)
Description
Constructs the instance of T forwarding the given args to its constructor and asserts etl::typed_storage_error if has_value() is false.
Returns the instance of T which has been constructed in the internal byte array.
pointer operator->()
Return
A pointer of type T and asserts etl::typed_storage_error if has_value() is false.
const_pointer operator->() const
Return
A const pointer of type T and asserts etl::typed_storage_error if has_value() is false.
reference operator*()
Return
Reference of type T and asserts if etl::typed_storage_error if has_value() is false.
const_reference operator*() const
Return
Const reference of type T and asserts etl::typed_storage_error if has_value() is false.
is_aligned
From: 20.35.12
bool is_aligned(void* p, size_t alignment)
Description
Check that p has alignment.
template <size_t Alignment>
bool is_aligned(void* p)
Description
Check that p has Alignment.
template <typename T>
bool is_aligned(void* p)
Description
Check that p has the alignment of T.
alignment_exception
From: 20.35.12
Exception base for alignment
alignment_error
From: 20.35.12
Memory misalignment exception.