mirror of
https://github.com/ETLCPP/etl.git
synced 2026-10-28 18:07:10 +08:00
Various documantation fixes
This commit is contained in:
parent
641d47d033
commit
4bedaa4786
@ -38,7 +38,7 @@ ETL_CONSTEXPR bool is_zero(T value)
|
||||
**Returns**
|
||||
`true` if `value` is Zero.
|
||||
|
||||
## is_exactly_zero
|
||||
## is_exactly_equal
|
||||
|
||||
```cpp
|
||||
template <typename T>
|
||||
@ -260,7 +260,7 @@ A wrapper around `::powl` in `<math.h>`.
|
||||
If `ETL_NO_LONG_DOUBLE_MATH` is defined then returns
|
||||
`::pow` with casts to `double`.
|
||||
otherwise
|
||||
`::powl(base, intpart)`
|
||||
`::powl(base, exponent)`
|
||||
|
||||
## modf
|
||||
|
||||
|
||||
@ -126,7 +126,6 @@ struct type_list_contains
|
||||
```
|
||||
**Description**
|
||||
Defines `value` as `true` if the `type_list` contains the specified type, otherwise `false`.
|
||||
From: `C++17`
|
||||
|
||||
---
|
||||
|
||||
@ -135,7 +134,8 @@ template <typename TTypeList, typename T>
|
||||
constexpr bool type_list_contains_v
|
||||
```
|
||||
**Description**
|
||||
Defined as `true` if the `type_list` contains the specified type, otherwise `false`.
|
||||
Defined as `true` if the `type_list` contains the specified type, otherwise `false`.
|
||||
From: `C++17`
|
||||
|
||||
## type_list_has_duplicates_of
|
||||
```cpp
|
||||
|
||||
@ -28,54 +28,72 @@ second_argument_type;
|
||||
cmp_result;
|
||||
```
|
||||
|
||||
`cmp_result` has the values `Less`, `Equal`, and `Greater`.
|
||||
`cmp_result` defines the values `Less`, `Equal`, and `Greater`.
|
||||
|
||||
## Members
|
||||
```cpp
|
||||
static bool lt(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Less than.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs < rhs`, otherwise `false`.
|
||||
`true` if `TLess()(lhs, rhs)`, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
```cpp
|
||||
static bool lte(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Less than or equal.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs <= rhs`, otherwise `false`.
|
||||
`true` if `lhs` is less than or equal to `rhs`, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
```cpp
|
||||
static bool gt(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Greater than.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs > rhs`, otherwise `false`.
|
||||
`true` if `lhs` is greater than `rhs`, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
```cpp
|
||||
static bool gte(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Greater than or equal.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs >= rhs`, otherwise `false`.
|
||||
`true` if `lhs` is greater than or equal to `rhs`, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
```cpp
|
||||
static bool eq(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Equal.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs == rhs`, otherwise `false`.
|
||||
`true` if neither value compares less than the other, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
```cpp
|
||||
static bool ne(first_argument_type lhs, second_argument_type rhs)
|
||||
```
|
||||
**Description**
|
||||
Not equal.
|
||||
|
||||
**Return**
|
||||
`true` if `lhs != rhs`, otherwise `false`.
|
||||
`true` if if either value compare less than the other, otherwise `false`.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@ -221,10 +221,12 @@ Checks equality of two cyclic values.
|
||||
Previously the first and last limits were also considered.
|
||||
|
||||
<= 20.49.0
|
||||
`etl::cyclic_value<2, 7>(3) != etl::cyclic_value<2, 6>(3)`
|
||||
`etl::cyclic_value<int, 2, 7>(3) != etl::cyclic_value<int, 2, 6>(3)`
|
||||
`etl::cyclic_value<int>(2, 7, 3) != etl::cyclic_value<int>(2, 6, 3)`
|
||||
|
||||
> 20.49.0
|
||||
`etl::cyclic_value<2, 7>(3) == etl::cyclic_value<2, 6>(3)`
|
||||
`etl::cyclic_value<int, 2, 7>(3) == etl::cyclic_value<int, 2, 6>(3)`
|
||||
`etl::cyclic_value<int>(2, 7, 3) == etl::cyclic_value<int>(2, 6, 3)`
|
||||
{{< /callout >}}
|
||||
|
||||
---
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user