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>
353 lines
5.4 KiB
Markdown
353 lines
5.4 KiB
Markdown
---
|
|
title: "histogram"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `histogram.h`
|
|
From: `20.9.0`
|
|
{{< /callout >}}
|
|
|
|
## Member types
|
|
`const_iterator` The iterator used to traverse the histogram data.
|
|
`key_type` The index type for the histogram.
|
|
`count_type` The type used for the histogram counter.
|
|
`value_type` The type returned from the histogram.
|
|
|
|
## Constants
|
|
`Max_Size` The maximum number of elements in the histogram.
|
|
|
|
## histogram
|
|
```cpp
|
|
template <typename TKey, typename TCount, size_t Max_Keys>
|
|
class histogram
|
|
```
|
|
**Description**
|
|
A histogram where the start index of the keys is defined in the constructor.
|
|
|
|
## Member functions
|
|
```cpp
|
|
histogram()
|
|
```
|
|
**Description**
|
|
Default constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
histogram(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Construct from an iterator range.
|
|
|
|
---
|
|
|
|
## histogram
|
|
|
|
```cpp
|
|
template <typename TKey, typename TCount, size_t Max_Keys, size_t Start_Index>
|
|
class histogram
|
|
```
|
|
**Description**
|
|
A histogram where the start index of the keys is defined as a template parameter.
|
|
|
|
## Member functions
|
|
|
|
```cpp
|
|
histogram()
|
|
```
|
|
**Description**
|
|
Default constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
histogram(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Construct from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
histogram(const histogram& other)
|
|
```
|
|
**Description**
|
|
Copy constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
histogram(histogram&& other)
|
|
```
|
|
**Description**
|
|
Move constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
histogram& operator =(const histogram& rhs)
|
|
```
|
|
**Description**
|
|
Assignment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
histogram& operator =(histogram&& rhs)
|
|
```
|
|
**Description**
|
|
Move assignment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void add(key_type key)
|
|
```
|
|
**Description**
|
|
Increment the count for the key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void add(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Increment the counts for the keys from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void operator ()(key_type key)
|
|
```
|
|
**Description**
|
|
Increment the count for the key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void operator ()(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Increment the counts for the keys from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
value_type operator [](key_type key) const
|
|
```
|
|
**Description**
|
|
Get the count for a key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const_iterator begin() const
|
|
const_iterator cbegin() const
|
|
```
|
|
**Description**
|
|
Get the iterator to the first histogram entry.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const_iterator end() const
|
|
const_iterator cend() const
|
|
```
|
|
**Description**
|
|
Get the iterator to the last + 1 histogram entry.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void clear()
|
|
```
|
|
**Description**
|
|
Clear the counts to zero.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t size() const
|
|
```
|
|
Get the number of items in the histogram.
|
|
**Description**
|
|
Always equal to max_size().
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t max_size() const
|
|
```
|
|
**Description**
|
|
Get the number of items in the histogram.
|
|
|
|
---
|
|
|
|
```cpp
|
|
size_t count() const
|
|
```
|
|
**Description**
|
|
Get the total of all the counts.
|
|
|
|
## sparse_histogram
|
|
|
|
```cpp
|
|
template <typename TKey, typename TCount, size_t Max_Keys>
|
|
class sparse_histogram
|
|
```
|
|
**Description**
|
|
A histogram where the keys are sparse or non-integral types.
|
|
|
|
## Types
|
|
`const_iterator` The iterator used to traverse the histogram data.
|
|
`key_type` The index type for the histogram.
|
|
`count_type` The type used for the histogram counter.
|
|
`value_type` The type returned from the histogram. A pair containing the key and count.
|
|
|
|
## Constants
|
|
`Max_Size` The maximum number of elements in the histogram.
|
|
|
|
## Member functions
|
|
```cpp
|
|
sparse_histogram()
|
|
```
|
|
**Description**
|
|
Default constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
sparse_histogram(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Construct from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
sparse_histogram(const sparse_histogram& other)
|
|
```
|
|
**Description**
|
|
Copy constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
sparse_histogram(sparse_histogram&& other)
|
|
```
|
|
**Description**
|
|
Move constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
sparse_histogram& operator =(const sparse_histogram& rhs)
|
|
```
|
|
**Description**
|
|
Assignment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
sparse_histogram& operator =(sparse_histogram&& rhs)
|
|
```
|
|
**Description**
|
|
Move assignment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void add(key_type key)
|
|
```
|
|
**Description**
|
|
Increment the count for the key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void add(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Increment the counts for the keys from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void operator ()(key_type key)
|
|
```
|
|
**Description**
|
|
Increment the count for the key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void operator ()(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Increment the counts for the keys from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const value_type& operator [](key_type key) const
|
|
```
|
|
**Description**
|
|
Get the count for a key.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const_iterator begin() const
|
|
const_iterator cbegin() const
|
|
```
|
|
**Description**
|
|
Get the iterator to the first histogram entry.
|
|
|
|
---
|
|
|
|
```cpp
|
|
const_iterator end() const
|
|
const_iterator cend() const
|
|
```
|
|
**Description**
|
|
Get the iterator to the last + 1 histogram entry.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void clear()
|
|
```
|
|
**Description**
|
|
Clear the counts to zero.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t size() const
|
|
```
|
|
**Description**
|
|
Get the number of items in the histogram.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR size_t max_size() const
|
|
```
|
|
**Description**
|
|
Get the number of items in the histogram.
|
|
|
|
---
|
|
|
|
```cpp
|
|
size_t count() const
|
|
```
|
|
**Description**
|
|
Get the total of all the counts.
|