mirror of
https://github.com/ETLCPP/etl.git
synced 2026-07-30 16:26:17 +08:00
Documentation updates (#1469)
Co-authored-by: John Wellbelove <john.wellbelove@etlcpp.com>
This commit is contained in:
parent
d598337107
commit
8f4373e555
@ -22,7 +22,7 @@ See also:
|
||||
## Description
|
||||
|
||||
The `etl::multi_array` class is defined as a recursive variadic template.
|
||||
It defines a multi-dimensional array class based on nested etl::array definitions.
|
||||
It defines a multi-dimensional array class based on nested `etl::array` definitions.
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
@ -71,7 +71,7 @@ bool any = bst.any(0x3F); // Check the lower 6 bits.
|
||||
|`span_type` | A mutable span type. |
|
||||
|`const_span_type`| A non-mutable span type. |
|
||||
|`element_type` | The type used as the internal storage for a bitset. By default, this is unsigned char. |
|
||||
|`buffer_type` | The type used as the to define the external buffer. Defined in etl::bitset_ext only. 20.34.0 |
|
||||
|`buffer_type` | The type used as the to define the external buffer. Defined in `etl::bitset_ext` only. `20.34.0` |
|
||||
|
||||
## Constants
|
||||
|
||||
@ -122,7 +122,7 @@ etl::bitset_ext(const char32_t* str, element_type* pbuffer);
|
||||
```
|
||||
**Description**
|
||||
The bitset is either default constructed, initialised with a numeric value, or a text string of zeros and ones.
|
||||
A pointer to the external must b supplied that is large enough to hold the bitset.
|
||||
A pointer to an external must be supplied that is large enough to hold the bitset.
|
||||
The buffer may be defined as follows:-
|
||||
```cpp
|
||||
using Bitset = etl::bitset_ext<32>;
|
||||
@ -143,7 +143,7 @@ etl::bitset_ext(const char32_t* str, buffer_type& buffer);
|
||||
```
|
||||
**Description**
|
||||
The bitset is either default constructed, initialised with a numeric value, or a text string of zeros and ones.
|
||||
A n external must b supplied that is large enough to hold the bitset.
|
||||
An external buffer must be supplied that is large enough to hold the bitset.
|
||||
The buffer may be defined as follows:-
|
||||
```cpp
|
||||
using Bitset = etl::bitset_ext<32>;
|
||||
@ -166,9 +166,9 @@ Set all bits.
|
||||
etl::bitset& set(element_type value);
|
||||
```
|
||||
**Description**
|
||||
20.34.0
|
||||
Set the bits to value.
|
||||
Set the bits to `value`.
|
||||
Valid when the bitset width matches the element type width.
|
||||
From: `20.34.0`
|
||||
|
||||
---
|
||||
|
||||
@ -292,7 +292,7 @@ T extract() const
|
||||
**Description**
|
||||
Extract an integral value from an arbitrary position and length.
|
||||
Compile time position and length.
|
||||
20.38.11
|
||||
From: `20.38.11`
|
||||
For C++98/03
|
||||
|
||||
## Bit access
|
||||
@ -342,9 +342,9 @@ bool any(element_type mask) const
|
||||
```
|
||||
**Description**
|
||||
Only enabled for bitsets that fit within one element.
|
||||
Returns true if any of the bits are set, after the mask has been applied, otherwise false.
|
||||
Returns `true` if any of the bits are set, after the mask has been applied, otherwise `false`.
|
||||
Valid when the bitset width matches the element type width.
|
||||
20.34.0
|
||||
From: `20.34.0`
|
||||
|
||||
---
|
||||
|
||||
@ -359,9 +359,9 @@ bool none(element_type mask) const
|
||||
```
|
||||
**Description**
|
||||
Only enabled for bitsets that fit within one element.
|
||||
Returns true if none of the bits are set, after the mask has been applied, otherwise false.
|
||||
Returns `true` if none of the bits are set, after the mask has been applied, otherwise `false`.
|
||||
Valid when the bitset width matches the element type width.
|
||||
20.34.0
|
||||
From: `20.34.0`
|
||||
|
||||
---
|
||||
|
||||
@ -369,16 +369,16 @@ Valid when the bitset width matches the element type width.
|
||||
bool all() const
|
||||
```
|
||||
**Description**
|
||||
Returns true if al of the bits are set, otherwise false.
|
||||
Returns `true` if al of the bits are set, otherwise `false`.
|
||||
|
||||
```cpp
|
||||
bool all(element_type mask) const
|
||||
```
|
||||
**Description**
|
||||
Only enabled for bitsets that fit within one element.
|
||||
Returns true if al of the bits are set, after the mask has been applied, otherwise false.
|
||||
Returns `true` if al of the bits are set, after the mask has been applied, otherwise `false`.
|
||||
Valid when the bitset width matches the element type width.
|
||||
20.34.0
|
||||
From: `20.34.0`
|
||||
|
||||
---
|
||||
|
||||
@ -386,7 +386,7 @@ Valid when the bitset width matches the element type width.
|
||||
size_t find_first(bool state) const
|
||||
```
|
||||
**Description**
|
||||
Returns the position of the first bit in the specified state. If not found then returns bitset<>::npos.
|
||||
Returns the position of the first bit in the specified state. If not found then returns `bitset<>::npos`.
|
||||
|
||||
---
|
||||
|
||||
@ -394,8 +394,8 @@ Returns the position of the first bit in the specified state. If not found then
|
||||
size_t find_next(bool state, size_t position) const
|
||||
```
|
||||
**Description**
|
||||
Returns the position of the next bit in the specified state, starting from position. If not found then returns bitset<>::npos.
|
||||
position is not checked for validity.
|
||||
Returns the position of the next bit in the specified state, starting from position. If not found then returns `bitset<>::npos`.
|
||||
`position` is not checked for validity.
|
||||
|
||||
## Bit operations
|
||||
|
||||
|
||||
@ -39,7 +39,7 @@ Clears the filter of all entries.
|
||||
void add(parameter_t key)
|
||||
```
|
||||
**Description**
|
||||
Adds a key to the filter, where parameter_t is derived from the first hash argument type.
|
||||
Adds a key to the filter, where `parameter_t` is derived from the first hash argument type.
|
||||
|
||||
---
|
||||
|
||||
@ -47,7 +47,7 @@ Adds a key to the filter, where parameter_t is derived from the first hash argum
|
||||
bool exists(parameter_t key) const
|
||||
```
|
||||
**Description**
|
||||
Checks to see if a key may exist in the filter, where parameter_t is derived from the first hash argument type.
|
||||
Checks to see if a key may exist in the filter, where `parameter_t` is derived from the first hash argument type.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -197,7 +197,7 @@ Use `add_task` to add additional tasks.
|
||||
|
||||
**The scheduler**
|
||||
An instance of `etl::scheduler` with the required scheduling policy.
|
||||
Initialise the task list by calling add_task_list.
|
||||
Initialise the task list by calling 'add_task_list'.
|
||||
|
||||
**Callbacks**
|
||||
If you wish to get callbacks for 'idle' or 'watchdog' then define callback functions and call `set_idle_callback` and `set_watchdog_callback`.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user