ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
Generate and return the day number of the week of a Gregorian Calendar date, assuming Monday is the first day of the week. If there is no input argument, then the current day number of the week is returned. More...
Generate and return the day number of the week of a Gregorian Calendar date, assuming Monday is the first day of the week. If there is no input argument, then the current day number of the week is returned.
The internationally recognized method of conveying the day of the week is governed by ISO 8601, which uses the Zeller congruence algorithm for calculating the day of a week in a particular month and year, invented by Christian Zeller.
Monday is the official first day of the week according to ISO 8601.
Fun Facts:
97
leap years and 303
normal years.1
advances by 1
. For each leap year it advances by 2
.1
of year N
occurs on the same day of the week as January 1
of year N + 400
.7
does not divide 400
, January 1
occurs more frequently on some days than others.[in] | values | : The input contiguous array of shape (:) , of size 3 or larger, of type integer of default kind IK, containing the [year, month, day] triple of the Gregorian calendar.For the current local date, this triple can be obtained from the Fortran intrinsic date_and_time() or getDateTime().Only the first three elements ( values(1:3) ) are used to compute the output.The ability to pass longer vectors as input is to allow the output values(1:8) of various functionalities of this module to be passed directly to the procedures under this generic interface.(optional. It can be present if and only if all other input arguments are missing.) |
[in] | year | : The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the year of the Gregorian calendar.(optional. It can be present if and only if the input argument values is missing.) |
[in] | month | : The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the month of the Gregorian calendar.(optional. It must be present if and only if the input argument year is present.) |
[in] | day | : The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the day of the Gregorian calendar.(optional. It must be present if and only if the input argument month is present.) |
weekday
: The output scalar or array of the same shape as the input array-like arguments of type integer
of default kind IK, containing the day of the week, starting with Monday as day number 1
.
Possible calling interfaces ⛓
values(:)
must be at least 3
and at most 8
.year
, month
, and day
must be valid values.month
must be a number between 1
and 12
.day
must be a number between 1
and 31
.CHECK_ENABLED=1
.pure
procedure(s) documented herein become impure
when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1
.pure
in release
build and impure
in debug
and testing
builds.elemental
. The procedures under this generic interface are non-elemental when the input argument values(:)
is present.
Example usage ⛓
ifort
compiler ⛓ ifort
compiler ⛓ gfortran
compiler ⛓
Final Remarks ⛓
If you believe this algorithm or its documentation can be improved, we appreciate your contribution and help to edit this page's documentation and source file on GitHub.
For details on the naming abbreviations, see this page.
For details on the naming conventions, see this page.
This software is distributed under the MIT license with additional terms outlined below.
This software is available to the public under a highly permissive license.
Help us justify its continued development and maintenance by acknowledging its benefit to society, distributing it, and contributing to it.
Definition at line 3543 of file pm_dateTime.F90.