ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation. |
Generate and return the Week Number, i.e., the number of weeks of the input year
until and including the week containing the specified input Gregorian date.
More...
Generate and return the Week Number, i.e., the number of weeks of the input year
until and including the week containing the specified input Gregorian date.
The Week Number is important for constructing the ISO week date system, a leap week calendar system that is part of the \(\ms{ISO 8601}\) date and time standard issued by the International Organization for Standardization (ISO) since 1988 It is (mainly) used in government and business for fiscal years, as well as in timekeeping.
The system specifies a week year atop the Gregorian calendar by defining a notation for ordinal weeks of the year.
The \(\ms{ISO 8601}\) definition for week number 01
is the week with the first Thursday of January of the Gregorian year in it.
The following definitions for the first week of the year are mutually equivalent, since **the ISO week starts with Monday:
4
or more) of its days in January
.W01
.W53
of the previous year.W52
in a common year and W53
in a leap year.W52
of the previous year.Returning the correct result requires taking into account the possibility of leap years.
[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.) |
weekNumber
: The output scalar of type integer
of default kind IK, containing the ordinal week of the specified Gregorian Calendar date.
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. The procedures under this generic interface are always impure
when all input arguments are missing.elemental
. The procedures under this generic interface are non-elemental when all input arguments are missing or only 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 3335 of file pm_dateTime.F90.