coffee/etl
1
0
Fork 0
mirror of https://github.com/ETLCPP/etl.git synced 2026-06-15 08:26:04 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fixed 'Description' typo

Browse Source
This commit is contained in:
John Wellbelove 2026-05-30 08:00:44 +01:00
parent 05cf9c55f1
commit f6ad307832
8 changed files with 47 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/IO/io_port.md
View File

@ -275,7 +275,7 @@ Get an iterator to this port.
const_iterator iter() const
const_iterator citer() const
```
**Decsription**
**Description**
Get a `const_iterator` to this port.
---

2
docs/binary/binary.md
View File

@ -198,7 +198,7 @@ Converts an N bit binary number, where bit N-1 is the sign bit, and shift is the
template <typename T>
ETL_CONSTEXPR14 T count_leading_zeros(T value)
```
**Decsription**
**Description**
Counts the number of leading zeros in a binary number
## count_trailing_zeros

2
docs/containers/_index.md
View File

@ -4,7 +4,7 @@ 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.
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.

40
docs/containers/sets/const-multiset.md
View File

@ -83,7 +83,7 @@ const_iterator Constant random access iterator
template <typename... TElements>
ETL_CONSTEXPR14 explicit const_multiset(TElements&&... elements) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_multiset` from a variadic list of elements.
Static asserts if the elements are not of type `value_type`.
Static asserts if the number of elements is greater than the capacity of the `const_multiset`.
@ -93,7 +93,7 @@ Static asserts if the number of elements is greater than the capacity of the `co
```cpp
ETL_CONSTEXPR14 const_multiset_ext() ETL_NOEXCEPT
```
**Decsription**
**Description**
Default construct a `const_multiset`.
---
@ -102,7 +102,7 @@ Default construct a `const_multiset`.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_multiset_ext(const etl::span<const value_type, Size>& sp) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_multiset` from a variadic list of elements.
---
@ -111,7 +111,7 @@ Construct a `const_multiset` from a variadic list of elements.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_multiset_ext(const value_type (&begin_)[Size]) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_multiset` from an array.
## Iterators
@ -120,7 +120,7 @@ Construct a `const_multiset` from an array.
const_iterator begin() const ETL_NOEXCEPT
const_iterator cbegin() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns an iterator to the beginning of the set.
---
@ -129,7 +129,7 @@ Returns an iterator to the beginning of the set.
const_iterator end() const ETL_NOEXCEPT
const_iterator cend() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns an iterator to the end of the set.
## Capacity
@ -137,7 +137,7 @@ Returns an iterator to the end of the set.
```cpp
ETL_CONSTEXPR14 bool empty() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns `true` if the size of the set is zero, otherwise `false`.
---
@ -145,7 +145,7 @@ Returns `true` if the size of the set is zero, otherwise `false`.
```cpp
ETL_CONSTEXPR14 bool full() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns `true` if the size of the lookup is size, otherwise `false`.
---
@ -153,7 +153,7 @@ Returns `true` if the size of the lookup is size, otherwise `false`.
```cpp
ETL_CONSTEXPR14 size_t size() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns the size of the lookup.
---
@ -161,7 +161,7 @@ Returns the size of the lookup.
```cpp
ETL_CONSTEXPR14 size_t max_size() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns the maximum possible size of the set.
## Status
@ -177,7 +177,7 @@ The elements must be sorted and contain no duplicates.
```cpp
ETL_CONSTEXPR14 const_iterator find(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Find the `key` in the container.
**Return**
@ -188,7 +188,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 const_iterator lower_bound(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element after the `key`.
**Return**
@ -199,7 +199,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 const_iterator upper_bound(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element with the `key`.
**Return**
@ -210,7 +210,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`)
**Return**
@ -221,7 +221,7 @@ Returns a range containing all elements equivalent to `key`.
```cpp
ETL_CONSTEXPR14 bool contains(const key_type& k) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Check if the container contains the key.
**Return**
@ -233,7 +233,7 @@ Check if the container contains the key.
template <typename K>
ETL_CONSTEXPR14 const_iterator find(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Find the `key` in the container.
**Return**
@ -245,7 +245,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator lower_bound(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element after the `key`.
**Return**
@ -257,7 +257,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator upper_bound(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element with the `key`.
**Return**
@ -269,7 +269,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`)
**Return**
@ -281,7 +281,7 @@ Returns a range containing all elements equivalent to `key`.
template <typename K>
ETL_CONSTEXPR14 bool contains(const K& k) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Check if the container contains the key.
**Return**

40
docs/containers/sets/const-set.md
View File

@ -83,7 +83,7 @@ const_iterator Constant random access iterator
template <typename... TElements>
ETL_CONSTEXPR14 explicit const_set(TElements&&... elements) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_set` from a variadic list of elements.
Static asserts if the elements are not of type `value_type`.
Static asserts if the number of elements is greater than the capacity of the `const_set`.
@ -93,7 +93,7 @@ Static asserts if the number of elements is greater than the capacity of the `co
```cpp
ETL_CONSTEXPR14 const_set_ext() ETL_NOEXCEPT
```
**Decsription**
**Description**
Default construct a `const_set`.
---
@ -102,7 +102,7 @@ Default construct a `const_set`.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_set_ext(const etl::span<const value_type, Size>& sp) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_set` from a variadic list of elements.
---
@ -111,7 +111,7 @@ Construct a `const_set` from a variadic list of elements.
template <size_type Size>
ETL_CONSTEXPR14 explicit const_set_ext(const value_type (&begin_)[Size]) ETL_NOEXCEPT
```
**Decsription**
**Description**
Construct a `const_set` from an array.
## Iterators
@ -120,7 +120,7 @@ Construct a `const_set` from an array.
const_iterator begin() const ETL_NOEXCEPT
const_iterator cbegin() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns an iterator to the beginning of the set.
---
@ -129,7 +129,7 @@ Returns an iterator to the beginning of the set.
const_iterator end() const ETL_NOEXCEPT
const_iterator cend() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns an iterator to the end of the set.
## Capacity
@ -137,7 +137,7 @@ Returns an iterator to the end of the set.
```cpp
ETL_CONSTEXPR14 bool empty() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns `true` if the size of the set is zero, otherwise `false`.
---
@ -145,7 +145,7 @@ Returns `true` if the size of the set is zero, otherwise `false`.
```cpp
ETL_CONSTEXPR14 bool full() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns `true` if the size of the lookup is size, otherwise `false`.
---
@ -153,7 +153,7 @@ Returns `true` if the size of the lookup is size, otherwise `false`.
```cpp
ETL_CONSTEXPR14 size_t size() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns the size of the lookup.
---
@ -161,7 +161,7 @@ Returns the size of the lookup.
```cpp
ETL_CONSTEXPR14 size_t max_size() const ETL_NOEXCEPT
```
**Decsription**
**Description**
Returns the maximum possible size of the set.
## Status
@ -177,7 +177,7 @@ The elements must be sorted and contain no duplicates.
```cpp
ETL_CONSTEXPR14 const_iterator find(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Find the `key` in the container.
**Return**
@ -188,7 +188,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 const_iterator lower_bound(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element after the `key`.
**Return**
@ -199,7 +199,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 const_iterator upper_bound(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element with the `key`.
**Return**
@ -210,7 +210,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
```cpp
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const key_type& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`)
**Return**
@ -221,7 +221,7 @@ Returns a range containing all elements equivalent to `key`.
```cpp
ETL_CONSTEXPR14 bool contains(const key_type& k) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Check if the container contains the key.
**Return**
@ -233,7 +233,7 @@ Check if the container contains the key.
template <typename K>
ETL_CONSTEXPR14 const_iterator find(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Find the `key` in the container.
**Return**
@ -245,7 +245,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator lower_bound(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element after the `key`.
**Return**
@ -257,7 +257,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 const_iterator upper_bound(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Searches for the first element with the `key`.
**Return**
@ -269,7 +269,7 @@ A `const_iterator` to the element, or `end()` if it could not be found.
template <typename K>
ETL_CONSTEXPR14 pair<const_iterator, const_iterator> equal_range(const K& key) const ETL_NOEXCEPT
```
**Decsription**
**Description**
The return type is either `std::pair` (default) or `etl::pair` (`ETL_NO_STL`)
**Return**
@ -281,7 +281,7 @@ Returns a range containing all elements equivalent to `key`.
template <typename K>
ETL_CONSTEXPR14 bool contains(const K& k) const ETL_NOEXCEPT
```
**Decsription**
**Description**
Check if the container contains the key.
**Return**

2
docs/maths/checksums-hashes.md
View File

@ -359,7 +359,7 @@ Creates a hash from the supplied range.
```cpp
void reset();
```
**Decsription**
**Description**
Resets the hash to the initial condition.
---

4
docs/maths/correlation.md
View File

@ -34,7 +34,7 @@ Default constructor.
template <typename TIterator>
correlation(TIterator first1, TIterator last1, TIterator first2)
```
**Decsription**
**Description**
Construct from two iterator ranges.
```cpp
@ -71,7 +71,7 @@ Add a range of values.
```cpp
double get_covariance() const
```
**Decsription**
**Description**
Returns the calculated covariance for the data.
---

2
docs/maths/gamma.md
View File

@ -39,7 +39,7 @@ Gamma a value.
```cpp
gamma_decode(double gamma, TInput maximum)
```
**Decsription**
**Description**
Constructor.
---