mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46:03 +08:00
* 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>
133 lines
2.2 KiB
Markdown
133 lines
2.2 KiB
Markdown
---
|
|
title: "standard_deviation"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `standard_deviation.h`
|
|
From: `20.9.0`
|
|
{{< /callout >}}
|
|
|
|
```cpp
|
|
template <bool Standard_Deviation_Type, typename TInput, typename TCalc = TInput>
|
|
class standard_deviation : public etl::unary_function<TInput, void>
|
|
```
|
|
|
|
`Standard_Deviation_Type` `Population` or `Sample`.
|
|
`TInput` The input data type.
|
|
`TCalc` The type to use for internal calculations. By default, equal to `TInput`.
|
|
|
|
**Enumeration**
|
|
```cpp
|
|
standard_deviation_type
|
|
etl::standard_deviation_type::Sample
|
|
etl::standard_deviation_type::Population
|
|
```
|
|
|
|
---
|
|
|
|
```cp
|
|
standard_deviation()
|
|
```
|
|
**Description**
|
|
Default constructor.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
standard_deviation(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Construct from an iterator range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void add(TInput value1)
|
|
```
|
|
**Description**
|
|
Add a value.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void add(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Add a range of values.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void operator()(TInput value)
|
|
```
|
|
**Description**
|
|
Add a values.
|
|
|
|
---
|
|
|
|
```cpp
|
|
template <typename TIterator>
|
|
void operator()(TIterator first, TIterator last)
|
|
```
|
|
**Description**
|
|
Add a range of values.
|
|
|
|
---
|
|
|
|
```cpp
|
|
double get_standard_deviation() const
|
|
```
|
|
**Return**
|
|
The calculated standard deviation for the data.
|
|
|
|
---
|
|
|
|
```cpp
|
|
double get_variance() const
|
|
```
|
|
**Return**
|
|
The calculated variance for the data.
|
|
|
|
---
|
|
|
|
```cpp
|
|
operator double() const
|
|
```
|
|
**Return**
|
|
The calculated standard deviation for the data.
|
|
|
|
---
|
|
|
|
```cpp
|
|
size_t count() const
|
|
```
|
|
**Description**
|
|
Get the total number added entries.
|
|
|
|
---
|
|
|
|
```cpp
|
|
void clear()
|
|
```
|
|
**Description**
|
|
Clear the standard deviation.
|
|
|
|
## Example
|
|
```cpp
|
|
std::array<char, 10> input
|
|
{
|
|
0, 1, 2, 3, 4, 5, 6, 7, 8, 9
|
|
};
|
|
|
|
etl::standard_deviation<etl::standard_deviation_type::Population, char, int32_t>
|
|
standard_deviation(input.begin(), input.end());
|
|
|
|
double standard_deviation_result;
|
|
double variance_result;
|
|
|
|
standard_deviation_result = standard_deviation; // standard_deviation_result == 2.87
|
|
variance_result = standard_deviation.get_variance(); // variance_result == 8.25
|
|
```
|