etl/docs/chrono/weekday/weekday.md
John Wellbelove 4a88884b39
Issue/add hugo support for documentation (#1449)
* 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>
2026-06-06 13:12:44 +01:00

6.3 KiB

title
weekday

{{< callout type="info">}} Header: chrono.h
From: 20.41.0
Similar to: std::chrono::weekday {{< /callout >}}

A class representing a weekday.

class weekday

Construction

ETL_CONSTEXPR 
weekday()
ETL_NOEXCEPT

Description
Default constructor.


ETL_CONSTEXPR 
explicit weekday(unsigned value) 
ETL_NOEXCEPT

Description
Construct from unsigned.


ETL_CONSTEXPR14 
weekday(const etl::chrono::sys_days& sd)
ETL_NOEXCEPT

Description
Construct from sys_days.


ETL_CONSTEXPR14 
weekday(const etl::chrono::local_days& sd)
ETL_NOEXCEPT

Description
Construct from local_days.


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

Description
Copy constructor.

Tests

ETL_NODISCARD
ETL_CONSTEXPR14 
bool ok() const 
ETL_NOEXCEPT

Return
true if the weekday is valid


ETL_NODISCARD
ETL_CONSTEXPR14 
bool is_weekend() const 
ETL_NOEXCEPT

Return
true if the weekday is a Saturday or Sunday.

Assignment

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

Description
Assignment operator

Access

ETL_CONSTEXPR14 
int c_encoding() const 
ETL_NOEXCEPT

Description
Gets the value of the weekday using C encoding.


ETL_CONSTEXPR14 
int iso_encoding() const 
ETL_NOEXCEPT

Description
Gets the value of the weekday using ISO encoding.


ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::weekday_indexed operator[](unsigned index) const 
ETL_NOEXCEPT

Description
Index operator, from index.


ETL_NODISCARD
ETL_CONSTEXPR14 
etl::chrono::weekday_last operator[](etl::chrono::last_spec last) const 
ETL_NOEXCEPT

Description
Index operator, from etl::chrono::last_spec.

Increment/decrement

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

Description
Pre-increment operator.


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

Description
Post-increment operator.


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

Description
Pre-decrement operator.


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

Description
Post-decrement operator.

Mathematical operators

ETL_CONSTEXPR14 
etl::chrono::weekday& operator +=(const etl::chrono::weekdays& ms) 
ETL_NOEXCEPT

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


ETL_CONSTEXPR14 
etl::chrono::weekday& operator -=(const etl::chrono::weekdays& ms) 
ETL_NOEXCEPT

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

Constants

ETL_NODISCARD
static 
ETL_CONSTEXPR14
etl::chrono::weekday min()
ETL_NOEXCEPT

Description
The minimum weekday value for which ok() will return true.


ETL_NODISCARD
static 
ETL_CONSTEXPR14 
etl::chrono::weekday max()
ETL_NOEXCEPT

Description
The maximum weekday value for which ok() will return true.

Non-member mathematical operators

ETL_CONSTEXPR14 
etl::chrono::weekday operator +(const etl::chrono::weekday& m, 
                                const etl::chrono::weekdays& ms) 
ETL_NOEXCEPT

Description
Add etl::chrono::weekdays to etl::chrono::weekday. Return
etl::chrono::weekday.


ETL_CONSTEXPR14 
etl::chrono::weekday operator +(const etl::chrono::weekdays& ms, 
                                const etl::chrono::weekday& m) 
ETL_NOEXCEPT

Description
Add etl::chrono::weekday to etl::chrono::weekdays. Return
etl::chrono::weekday.


ETL_CONSTEXPR14 
etl::chrono::weekday operator -(const etl::chrono::weekday& m, 
                                const etl::chrono::weekdays& ms) 
ETL_NOEXCEPT

Description
Subtract etl::chrono::weekdays from etl::chrono::weekday. Return
etl::chrono::weekday.


ETL_CONSTEXPR14
etl::chrono::weekday operator -(const etl::chrono::weekdays& ms, 
                                const etl::chrono::weekday& m) 
ETL_NOEXCEPT

Description
Subtract etl::chrono::weekday from etl::chrono::weekdays. Return
etl::chrono::weekdays.


ETL_CONSTEXPR14 
etl::chrono::weekdays operator -(const etl::chrono::weekday& m1, 
                                 const etl::chrono::weekday& m2) ETL_NOEXCEPT

Description
Subtract etl::chrono::weekday from etl::chrono::weekday. Return
etl::chrono::weekdays.

Non-member comparison operators

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

Description
Equality operator.


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

Description
Inequality operator.


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

Description
Less-than operator.


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

Description
Less-than-or-equal operator.


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

Description
Greater-than operator.


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

Description
Greater-than-or-equal operator.


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

Description
Spaceship operator.
C++20

Defined weekdays

etl::chrono::Monday
etl::chrono::Tuesday
etl::chrono::Wednesday
etl::chrono::Thursday
etl::chrono::Friday
etl::chrono::Saturday
etl::chrono::Sunday

Hash

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

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