mirror of
https://github.com/ETLCPP/etl.git
synced 2026-06-16 00:46:03 +08:00
4a88884b39
* 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>
318 lines
5.1 KiB
Markdown
318 lines
5.1 KiB
Markdown
---
|
|
title: "day"
|
|
---
|
|
|
|
{{< callout type="info">}}
|
|
Header: `chrono.h`
|
|
Since: `TBC`
|
|
Similar to: [std::chrono::day](https://en.cppreference.com/w/cpp/chrono/day.html)
|
|
{{< /callout >}}
|
|
|
|
A class representing a day.
|
|
|
|
```cpp
|
|
class day
|
|
```
|
|
|
|
## Typesdefs
|
|
rep The internal representation.
|
|
|
|
## Construction
|
|
```cpp
|
|
ETL_CONSTEXPR
|
|
day()
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Default constructor.
|
|
|
|
---
|
|
```cpp
|
|
ETL_CONSTEXPR
|
|
explicit day(unsigned value)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Construct from unsigned.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
day(const etl::chrono::day& other)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Copy constructor.
|
|
|
|
## Tests
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
bool ok() const
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Return**
|
|
`true` if the day is within the valid range.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_NODISCARD
|
|
ETL_CONSTEXPR14
|
|
int compare(const etl::chrono::day& other) const
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Compare `day` with another.
|
|
if `day < other`, returns `-1`
|
|
else if `day > other`, returns `1`
|
|
else returns `0`
|
|
|
|
## Assignment
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day& operator =(const etl::chrono::day& rhs)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Assignment operator
|
|
|
|
## Increment/decrement
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day& operator ++()
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Pre-increment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator ++(int)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Post-increment operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day& operator --()
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Pre-decrement operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator --(int)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Post-decrement operator.
|
|
|
|
## Mathematical operators
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day& operator +=(const etl::chrono::days& ms)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Plus-equals operator adding etl::chrono::days.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day& operator -=(const etl::chrono::days& ms)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Minus-equals operator subtracting `etl::chrono::days`.
|
|
|
|
## Conversion
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
operator unsigned() const
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Conversion operator to unsigned int.
|
|
|
|
## Non-member mathematical operators
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator +(const etl::chrono::day& m,
|
|
const etl::chrono::days& ms)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Add `etl::chrono::days` to `etl::chrono::day`.
|
|
|
|
**Return**
|
|
`etl::chrono::day.`
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator +(const etl::chrono::days& ms,
|
|
const etl::chrono::day& m)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Add `etl::chrono::day` to `etl::chrono::days`.
|
|
|
|
**Return**
|
|
`etl::chrono::day`.
|
|
|
|
---
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator -(const etl::chrono::day& m,
|
|
const etl::chrono::days& ms)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Subtract `etl::chrono::days` from `etl::chrono::day`.
|
|
|
|
**Return**
|
|
`etl::chrono::day`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::day operator -(const etl::chrono::days& ms,
|
|
const etl::chrono::day& m)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Subtract `etl::chrono::day` from `etl::chrono::days`.
|
|
|
|
**Return**
|
|
`etl::chrono::days`.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
etl::chrono::days operator -(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2) ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Subtract `etl::chrono::day` from `etl::chrono::day`.
|
|
|
|
**Return**
|
|
`etl::chrono::days`.
|
|
|
|
## Non-member comparison operators
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator ==(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Equality operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator !=(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Inequality operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator <(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Less-than operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator <=(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Less-than-or-equal operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator >(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Greater-than operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
ETL_CONSTEXPR14
|
|
bool operator >=(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
ETL_NOEXCEPT
|
|
```
|
|
**Description**
|
|
Greater-than-or-equal operator.
|
|
|
|
---
|
|
|
|
```cpp
|
|
[[nodiscard]] inline constexpr
|
|
auto operator <=>(const etl::chrono::day& m1,
|
|
const etl::chrono::day& m2)
|
|
noexcept
|
|
```
|
|
**Description**
|
|
Spaceship operator.
|
|
C++20
|
|
|
|
## Defined days
|
|
|
|
```cpp
|
|
etl::chrono::January
|
|
etl::chrono::February
|
|
etl::chrono::March
|
|
etl::chrono::April
|
|
etl::chrono::May
|
|
etl::chrono::June
|
|
etl::chrono::July
|
|
etl::chrono::August
|
|
etl::chrono::September
|
|
etl::chrono::October
|
|
etl::chrono::November
|
|
etl::chrono::December
|
|
```
|
|
|
|
## Hash
|
|
|
|
```cpp
|
|
template <>
|
|
struct hash<etl::chrono::day>
|
|
```
|
|
**Description**
|
|
Hash function for `etl::chrono::day`.
|
|
|