etl/docs/chrono/day.md

title
day

{{< callout type="info">}} Header: chrono.h
Since: TBC
Similar to: std::chrono::day {{< /callout >}}

A class representing a day.

class day

Typesdefs

rep The internal representation.

Construction

ETL_CONSTEXPR 
day()
ETL_NOEXCEPT

Description
Default constructor.

---

ETL_CONSTEXPR 
explicit day(unsigned value) 
ETL_NOEXCEPT

Description
Construct from unsigned.

---

ETL_CONSTEXPR14 
day(const etl::chrono::day& other) 
ETL_NOEXCEPT

Description
Copy constructor.

Tests

ETL_NODISCARD
ETL_CONSTEXPR14 
bool ok() const 
ETL_NOEXCEPT

Return
true if the day is within the valid range.

---

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

ETL_CONSTEXPR14 
etl::chrono::day& operator =(const etl::chrono::day& rhs) 
ETL_NOEXCEPT

Description
Assignment operator

Increment/decrement

ETL_CONSTEXPR14 
etl::chrono::day& operator ++() 
ETL_NOEXCEPT

Description
Pre-increment operator.

---

ETL_CONSTEXPR14
etl::chrono::day operator ++(int) 
ETL_NOEXCEPT

Description
Post-increment operator.

---

ETL_CONSTEXPR14
etl::chrono::day& operator --() 
ETL_NOEXCEPT

Description
Pre-decrement operator.

---

ETL_CONSTEXPR14 
etl::chrono::day operator --(int) 
ETL_NOEXCEPT

Description
Post-decrement operator.

Mathematical operators

ETL_CONSTEXPR14 
etl::chrono::day& operator +=(const etl::chrono::days& ms) 
ETL_NOEXCEPT

Description
Plus-equals operator adding etl::chrono::days.

---

ETL_CONSTEXPR14 
etl::chrono::day& operator -=(const etl::chrono::days& ms) 
ETL_NOEXCEPT

Description
Minus-equals operator subtracting etl::chrono::days.

Conversion

ETL_CONSTEXPR14 
operator unsigned() const 
ETL_NOEXCEPT

Description
Conversion operator to unsigned int.

Non-member mathematical operators

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.

---

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.

---

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.

---

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.

---

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

ETL_CONSTEXPR14 
bool operator ==(const etl::chrono::day& m1, 
                 const etl::chrono::day& m2)
ETL_NOEXCEPT

Description
Equality operator.

---

ETL_CONSTEXPR14 
bool operator !=(const etl::chrono::day& m1, 
                 const etl::chrono::day& m2) 
ETL_NOEXCEPT

Description
Inequality operator.

---

ETL_CONSTEXPR14 
bool operator <(const etl::chrono::day& m1, 
                const etl::chrono::day& m2) 
ETL_NOEXCEPT

Description
Less-than operator.

---

ETL_CONSTEXPR14 
bool operator <=(const etl::chrono::day& m1, 
                 const etl::chrono::day& m2) 
ETL_NOEXCEPT

Description
Less-than-or-equal operator.

---

ETL_CONSTEXPR14 
bool operator >(const etl::chrono::day& m1, 
                const etl::chrono::day& m2) 
ETL_NOEXCEPT

Description
Greater-than operator.

---

ETL_CONSTEXPR14
bool operator >=(const etl::chrono::day& m1, 
                 const etl::chrono::day& m2) 
ETL_NOEXCEPT

Description
Greater-than-or-equal operator.

---

[[nodiscard]] inline constexpr 
auto operator <=>(const etl::chrono::day& m1, 
                  const etl::chrono::day& m2) 
noexcept

Description
Spaceship operator. C++20

Defined days

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

template <>
struct hash<etl::chrono::day>

Description
Hash function for etl::chrono::day.