mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46: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>
67 lines
2.9 KiB
Markdown
67 lines
2.9 KiB
Markdown
---
|
|
title: "Containers"
|
|
weight: 100
|
|
---
|
|
|
|
## Containers
|
|
The library defines a set of containers that have been specially tailored for embedded systems. They have a maximum capacity fixed at compile time and make no calls to `malloc`/`free` or `new`/`delete`. They are completely deterministic.
|
|
|
|
Most container types have been designed to mimic, as far as possible, those found in the STL. Some do not have direct STL equivalents.
|
|
|
|
As the storage for all of the container types is allocated as a contiguous block, they are extremely cache friendly.
|
|
|
|
**Note:**
|
|
Unlike the STL, the ETL's `vector<bool>` really *is* a container and actually *does* contains `bool`.
|
|
If you require a compact Boolean container then `etl::bitset` may be more appropriate.
|
|
|
|
## Intrusive containers
|
|
There are intrusive versions of certain containers. These do not store copies of the inserted values, but link to the original objects. Certain types of intrusive container require that the stored object derives from an intrusive link.
|
|
|
|
Most intrusive containers do not have a maximum fixed capacity.
|
|
See here for more information.
|
|
|
|
To eliminate code bloat, most container templates utilise 'hoisting' where functionality, independent of the size and/or type, is separated out in to base classes.
|
|
|
|
For example, `vector<int, 5>` and `vector<int, 10>` will share code from `ivector<int>`.
|
|
`vector<int, 5>`, `vector<float, 7>` and `vector<int, 10>` will all share code from `vector_base`.
|
|
|
|
The `i` prefixed container types may be used as size independent pointer or reference types for all sizes of thederived type.
|
|
|
|
```cpp
|
|
etl::vector<int, 5> vector1;
|
|
etl::vector<int, 10> vector2;
|
|
|
|
etl::ivector<int>* pvector;
|
|
|
|
pvector = &vector1;pvector->push_back(3);
|
|
pvector = &vector2;pvector->push_back(4);
|
|
```
|
|
|
|
## Move semantics and rvalue references
|
|
The following containers support rvalue references and move semantics.
|
|
|
|
`vector`
|
|
`deque`
|
|
`list`
|
|
`forward_list`
|
|
`flat_set`
|
|
`flat_multiset`
|
|
`flat_map`
|
|
`flat_multimap`
|
|
|
|
*This list may be out of date*.
|
|
|
|
## Differences from the STL containers
|
|
As the containers have a fixed capacity, most also implement `full()` and `available()` member functions.
|
|
|
|
Most of the containers allocate their storage from an internal instance of `etl::pool`.
|
|
Because of this the containers have a certain set of attributes that differ from the standard library.
|
|
- The storage for all containers is contiguous, thereby enhancing cache hits.
|
|
- No heap memory is used; no OS or user supplied memory management is required.
|
|
- Non-static containers declared locally within functions will store their contents on the stack.
|
|
- Copying or swapping a container is not a low cost action, as all of the contents will be copied.
|
|
|
|
## Notes
|
|
Although the containers utilise inheritance, like the STL containers, they are not intended to be used
|
|
polymorphically, unless enabled by a compile time macros `ETL_POLYMORPHIC_XXX`.
|