ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_dateTime::getWeekDate Interface Reference

Generate and return the ISO 8601 Week Date triple [week year, week number, week day] corresponding to the input Gregorian date and time values(1:3) or (year, month, day) triple. More...

Detailed Description

Generate and return the ISO 8601 Week Date triple [week year, week number, week day] corresponding to the input Gregorian date and time values(1:3) or (year, month, day) triple.

The ISO week date system is 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 following table contains examples of the Gregorian Calendar date and their corresponding Week Dates.

Gregorian Date ISO Date ISO Week Date
Sat 1 Jan 1977 1977-01-01 1976-W53-6
Sun 2 Jan 1977 1977-01-02 1976-W53-7
Sat 31 Dec 1977 1977-12-31 1977-W52-6
Sun 1 Jan 1978 1978-01-01 1977-W52-7
Mon 2 Jan 1978 1978-01-02 1978-W01-1
Sun 31 Dec 1978 1978-12-31 1978-W52-7
Mon 1 Jan 1979 1979-01-01 1979-W01-1
Sun 30 Dec 1979 1979-12-30 1979-W52-7
Mon 31 Dec 1979 1979-12-31 1980-W01-1
Tue 1 Jan 1980 1980-01-01 1980-W01-2
Sun 28 Dec 1980 1980-12-28 1980-W52-7
Mon 29 Dec 1980 1980-12-29 1981-W01-1
Tue 30 Dec 1980 1980-12-30 1981-W01-2
Wed 31 Dec 1980 1980-12-31 1981-W01-3
Thu 1 Jan 1981 1981-01-01 1981-W01-4
Thu 31 Dec 1981 1981-12-31 1981-W53-4
Fri 1 Jan 1982 1982-01-01 1981-W53-5
Sat 2 Jan 1982 1982-01-02 1981-W53-6
Sun 3 Jan 1982 1982-01-03 1981-W53-7

When all input arguments are missing, the procedures under this generic interface return the current ISO Week Date.

Parameters
[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.)
Returns
WeekDate : The output array of shape (1:3) of type integer of default kind IK containing the ISO 8601 Week Date triple [week year, week number, week day].


Possible calling interfaces

integer(IK) :: WeekDate(3)
WeekDate(1:3) = getWeekDate() ! always impure.
WeekDate(1:3) = getWeekDate(values(1:3))
WeekDate(1:3) = getWeekDate(year, month, day)
!
Generate and return the ISO 8601 Week Date triple [week year, week number, week day] corresponding to...
This module contains classes and procedures for computing, manipulating, and styling dates and times.
Warning
The size of the input argument values(:) must be at least 3 and at most 8.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are 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.
See also
getWeekYear
getDateTime
getDateAfter
getDateBefore


Example usage

1program example
2
3 use pm_kind, only: SK, IK
4 use pm_io, only: display_type
5 use pm_dateTime, only: getDateTime
6 use pm_dateTime, only: getWeekDate
7
8 implicit none
9
10 integer(IK) :: Values(8)
11
12 type(display_type) :: disp
13 disp = display_type(file = "main.out.F90")
14
15 call disp%skip()
16 call disp%show("getDateTime()")
17 call disp%show( getDateTime() )
18 call disp%show("getWeekDate()")
19 call disp%show( getWeekDate() )
20 call disp%skip()
21
22 call disp%skip()
23 call disp%show("call date_and_time(values = Values)")
24 call date_and_time(values = Values)
25 call disp%show("Values(1:3)")
26 call disp%show( Values(1:3) )
27 call disp%show("getWeekDate(Values(1:3))")
28 call disp%show( getWeekDate(Values(1:3)) )
29 call disp%skip()
30
31 call disp%skip()
32 call disp%show("getWeekDate(1977_IK, 1_IK, 1_IK) ! 1976-W53-6")
33 call disp%show( getWeekDate(1977_IK, 1_IK, 1_IK) )
34 call disp%skip()
35
36 call disp%skip()
37 call disp%show("getWeekDate(1977_IK, 1_IK, 2_IK) ! 1976-W53-7")
38 call disp%show( getWeekDate(1977_IK, 1_IK, 2_IK) )
39 call disp%skip()
40
41 call disp%skip()
42 call disp%show("getWeekDate(1977_IK, 12_IK, 31_IK) ! 1977-W52-6")
43 call disp%show( getWeekDate(1977_IK, 12_IK, 31_IK) )
44 call disp%skip()
45
46 call disp%skip()
47 call disp%show("getWeekDate(1978_IK, 1_IK, 1_IK) ! 1977-W52-7")
48 call disp%show( getWeekDate(1978_IK, 1_IK, 1_IK) )
49 call disp%skip()
50
51 call disp%skip()
52 call disp%show("getWeekDate(1978_IK, 1_IK, 2_IK) ! 1978-W01-1")
53 call disp%show( getWeekDate(1978_IK, 1_IK, 2_IK) )
54 call disp%skip()
55
56 call disp%skip()
57 call disp%show("getWeekDate(1978_IK, 12_IK, 31_IK) ! 1978-W52-7")
58 call disp%show( getWeekDate(1978_IK, 12_IK, 31_IK) )
59 call disp%skip()
60
61 call disp%skip()
62 call disp%show("getWeekDate(1979_IK, 1_IK, 1_IK) ! 1979-W01-1")
63 call disp%show( getWeekDate(1979_IK, 1_IK, 1_IK) )
64 call disp%skip()
65
66 call disp%skip()
67 call disp%show("getWeekDate(1979_IK, 12_IK, 30_IK) ! 1979-W52-7")
68 call disp%show( getWeekDate(1979_IK, 12_IK, 30_IK) )
69 call disp%skip()
70
71 call disp%skip()
72 call disp%show("getWeekDate(1979_IK, 12_IK, 31_IK) ! 1980-W01-1")
73 call disp%show( getWeekDate(1979_IK, 12_IK, 31_IK) )
74 call disp%skip()
75
76end program example
Generate and return the current or the requested date and time as an integer-valued array of size 8 o...
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
3+2024, +11, +14, -360, +22, +14, +55, +370
5+2024, +46, +4
6
7
8call date_and_time(values = Values)
9Values(1:3)
10+2024, +11, +14
11getWeekDate(Values(1:3))
12+2024, +46, +4
13
14
15getWeekDate(1977_IK, 1_IK, 1_IK) ! 1976-W53-6
16+1976, +53, +6
17
18
19getWeekDate(1977_IK, 1_IK, 2_IK) ! 1976-W53-7
20+1976, +53, +7
21
22
23getWeekDate(1977_IK, 12_IK, 31_IK) ! 1977-W52-6
24+1977, +52, +6
25
26
27getWeekDate(1978_IK, 1_IK, 1_IK) ! 1977-W52-7
28+1977, +52, +7
29
30
31getWeekDate(1978_IK, 1_IK, 2_IK) ! 1978-W01-1
32+1978, +1, +1
33
34
35getWeekDate(1978_IK, 12_IK, 31_IK) ! 1978-W52-7
36+1978, +52, +7
37
38
39getWeekDate(1979_IK, 1_IK, 1_IK) ! 1979-W01-1
40+1979, +1, +1
41
42
43getWeekDate(1979_IK, 12_IK, 30_IK) ! 1979-W52-7
44+1979, +52, +7
45
46
47getWeekDate(1979_IK, 12_IK, 31_IK) ! 1980-W01-1
48+1980, +1, +1
49
50
Test:
test_pm_dateTime


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.

  1. If you use any parts or concepts from this library to any extent, please acknowledge the usage by citing the relevant publications of the ParaMonte library.
  2. If you regenerate any parts/ideas from this library in a programming environment other than those currently supported by this ParaMonte library (i.e., other than C, C++, Fortran, MATLAB, Python, R), please also ask the end users to cite this original ParaMonte library.

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.

Author:
Amir Shahmoradi, March 22, 2012, 00:00 AM, National Institute for Fusion Studies, The University of Texas Austin

Definition at line 2573 of file pm_dateTime.F90.


The documentation for this interface was generated from the following file: