etl/docs/maths/constants.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* 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>
2026-06-06 13:12:44 +01:00

199 lines
3.8 KiB
Markdown

---
title: "Constants"
---
A set of compile time constants.
## log
```cpp
template <size_t N, size_t BASE>
struct log;
```
Header: *log.h*
Defines the member value as the log of N to base BASE.
Set to the integer below the ideal floating point value.
C++17 and above
```cpp
template <size_t N, size_t BASE>
inline constexpr size_t log_v = log<N, BASE>::value;
```
## log2
```cpp
template <size_t N>
struct log2;
```
Header: *log.h*
Defines the member value as the log of N to base 2
Set to the integer below the ideal floating point value.
C++17 and above
```cpp
template <size_t N>
inline constexpr size_t log2_v = log2<N>::value;
```
## log10
```cpp
template <size_t N>
struct log10;
```
Header: *log.h*
Defines the member value as the log of N to base 10
Set to the integer below the ideal floating point value.
C++17 and above
```cpp
template <size_t N>
inline constexpr size_t log10_v = log10<N>::value;
```
## power
```cpp
template <size_t N, size_t POWER>
struct power;
```
Header: *power.h*
Defines the member value as N raised to the power `POWER`.
C++17 and above
```cpp
template <size_t N, size_t POWER>
inline constexpr size_t power_v = power<N, POWER>::value;
```
## power_of_2_round_up
```cpp
template <size_t N>
struct power_of_2_round_up;
```
Header: *power.h*
Defines the member value to the next equal or higher power of 2.
```cpp
power_of_2_round_up<7> -> 8
power_of_2_round_up<8> -> 8
power_of_2_round_up<9> -> 16
```
C++17 and above
```cpp
template <size_t N, size_t POWER>
inline constexpr size_t power_of_2_round_up_v = power_of_2_round_up<N, POWER>::value;
```
## power_of_2_round_down
```cpp
template <size_t N>
struct power_of_2_round_down;
```
Header: *power.h*
Defines the member value to the next equal or lower power of 2.
```cpp
power_of_2_round_down<7> -> 4
power_of_2_round_down<8> -> 4
power_of_2_round_down<9> -> 8
```
C++17 and above
```cpp
template <size_t N, size_t POWER>
inline constexpr size_t power_of_2_round_down_v = power_of_2_round_down<N, POWER>::value;
```
## is_power_of_2
```cpp
template <size_t N>
struct is_power_of_2;
```
Header: *power.h*
Defines the member value to true if N is a power of 2, otherwise false.
C++17 and above
```cpp
template <size_t N, size_t POWER>
inline constexpr size_t is_power_of_2_v = is_power_of_2<N, POWER>::value;
```
## sqrt
```cpp
template <size_t N, size_t I = 1>
struct sqrt;
```
Header: *sqrt.h*
Defines the member value as the largest integer that, when squared, is at less than or equal to N.
C++17 and above
```cpp
template <size_t N, size_t I = 1>
inline constexpr size_t sqrt_v = sqrt<N, POWER>::value;
```
## factorial
```cpp
template <const size_t N>
struct factorial;
```
Header: *factorial.h*
Defines the member value as the Nth factorial.
C++17 and above
```cpp
template <size_t N>
inline constexpr size_t factorial_v = factorial<N>::value;
```
## fibbonacci
```cpp
template <const size_t N>
struct fibbonacci;
```
Header: *fibbonacci.h*
Defines the member value as the Nth in the Fibbonacci sequence
C++17 and above
```cpp
template <size_t N>
inline constexpr size_t fibbonacci_v = fibbonacci<N>::value;
```
## Maths constants
Header: *math_constants.h*
Namespace : *etl::math*
```cpp
ETL_CONSTANT double pi = 3.14159265358979;
ETL_CONSTANT double pi_reciprocal = 0.31830988618379;
ETL_CONSTANT double pi_squared = 9.86960440108936;
ETL_CONSTANT double e = 2.71828182845905;
ETL_CONSTANT double e_reciprocal = 0.36787944117144;
ETL_CONSTANT double e_squared = 7.38905609893065;
ETL_CONSTANT double root2 = 1.41421356237310;
ETL_CONSTANT double root2_reciprocal = 0.70710678118655;
ETL_CONSTANT double euler = 0.57721566490153;
ETL_CONSTANT double golden_ratio = 1.61803398874989;
```