Generate and return the ordinal day, also knowns as Day of Year (DOY), i.e., the number of days since the beginning of the input year until and including the input Gregorian Calendar date [year, month, day].
More...

Detailed Description

Generate and return the ordinal day, also knowns as Day of Year (DOY), i.e., the number of days since the beginning of the input year until and including the input Gregorian Calendar date [year, month, day].

The day of year is important for forming ISO Ordinal Dates. An Ordinal Date is a simple form for occasions when the arbitrary nature of week and month definitions are more of an impediment than an aid, for instance, when comparing dates from different calendars. The ordinal date is comprised of the year [YYYY] and the day of that year [DDD], from 001 through 365 (366 in leap years). For example, 1981-04-05 corresponds to the ordinal date 1981-095.

This format is used with simple hardware systems that have a need for a date system, but where including full calendar calculation software may be a significant nuisance. This system is sometimes referred to as Julian Date, but this can cause confusion with the astronomical Julian day, a sequential count of the number of days since day 0 beginning 1 January 4713 BC Greenwich noon, Julian proleptic calendar (or noon on ISO date −4713-11-24 which uses the Gregorian proleptic calendar with a year 0000).

Returning the correct result requires taking into account the possibility of leap years.

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: ordinalDay : The output scalar of type integer of default kind IK, containing the ordinal day of the specified Gregorian Calendar date.
If all input arguments are missing, the ordinal day corresponding to the current Gregorian date is returned.

Possible calling interfaces ⛓

: use pm_dateTime, only: getOrdinalDay

integer(IK) :: ordinalDay

ordinalDay = getOrdinalDay() ! use the current date.

ordinalDay = getOrdinalDay(values(1:3)) ! values = [year, month, day]

ordinalDay = getOrdinalDay(year, month, day) ! elemental

!

pm_dateTime::getOrdinalDay
Generate and return the ordinal day, also knowns as Day of Year (DOY), i.e., the number of days since...
Definition: pm_dateTime.F90:3223

pm_dateTime
This module contains classes and procedures for computing, manipulating, and styling dates and times.
Definition: pm_dateTime.F90:308

Warning: The size of the input argument values(:) must be at least 3 and at most 8.
The input values for the year, month, and day must be valid values.
The input month must be a number between 1 and 12.
The input day must be a number between 1 and 31.
These conditions are 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.

Remarks: The procedures under discussion are elemental. The procedures under this generic interface are non-elemental when all input arguments are missing or only the input argument values(:) is present.

See also: isLastDayInMonth

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: getOrdinalDay

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("getOrdinalDay()")

19 call disp%show( getOrdinalDay() )

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("getOrdinalDay(Values(1:3))")

28 call disp%show( getOrdinalDay(Values(1:3)) )

29 call disp%skip()

30

31 call disp%skip()

32 call disp%show("getOrdinalDay(-4713_IK, 11_IK, 24_IK)")

33 call disp%show( getOrdinalDay(-4713_IK, 11_IK, 24_IK) )

34 call disp%skip()

35

36 call disp%skip()

37 call disp%show("getOrdinalDay(-1_IK, 1_IK, 1_IK)")

38 call disp%show( getOrdinalDay(-1_IK, 1_IK, 1_IK) )

39 call disp%skip()

40

41 call disp%skip()

42 call disp%show("getOrdinalDay(-1_IK, 12_IK, 31_IK)")

43 call disp%show( getOrdinalDay(-1_IK, 12_IK, 31_IK) )

44 call disp%skip()

45

46 call disp%skip()

47 call disp%show("getOrdinalDay(0_IK, 12_IK, 31_IK)")

48 call disp%show( getOrdinalDay(0_IK, 12_IK, 31_IK) )

49 call disp%skip()

50

51 call disp%skip()

52 call disp%show("getOrdinalDay(1_IK, 12_IK, 31_IK)")

53 call disp%show( getOrdinalDay(1_IK, 12_IK, 31_IK) )

54 call disp%skip()

55

56 call disp%skip()

57 call disp%show("getOrdinalDay(1582_IK, 10_IK, 15_IK)")

58 call disp%show( getOrdinalDay(1582_IK, 10_IK, 15_IK) )

59 call disp%skip()

60

61 call disp%skip()

62 call disp%show("getOrdinalDay(1901_IK, 1_IK, 1_IK)")

63 call disp%show( getOrdinalDay(1901_IK, 1_IK, 1_IK) )

64 call disp%skip()

65

66 call disp%skip()

67 call disp%show("getOrdinalDay(1999_IK, 3_IK, 1_IK)")

68 call disp%show( getOrdinalDay(1999_IK, 3_IK, 1_IK) )

69 call disp%skip()

70

71 call disp%skip()

72 call disp%show("getOrdinalDay(2000_IK, 3_IK, 1_IK)")

73 call disp%show( getOrdinalDay(2000_IK, 3_IK, 1_IK) )

74 call disp%skip()

75

76 call disp%skip()

77 call disp%show("getOrdinalDay(1999_IK, 4_IK, 15_IK) ! 105")

78 call disp%show( getOrdinalDay(1999_IK, 4_IK, 15_IK) )

79 call disp%skip()

80

81 call disp%skip()

82 call disp%show("getOrdinalDay(2000_IK, 4_IK, 15_IK) ! 106 (leap year)")

83 call disp%show( getOrdinalDay(2000_IK, 4_IK, 15_IK) )

84 call disp%skip()

85

86 call disp%skip()

87 call disp%show("getOrdinalDay(9999_IK, 12_IK, 31_IK)")

88 call disp%show( getOrdinalDay(9999_IK, 12_IK, 31_IK) )

89 call disp%skip()

90

91end program example

pm_dateTime::getDateTime
Generate and return the current or the requested date and time as an integer-valued array of size 8 o...
Definition: pm_dateTime.F90:2367

pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726

pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508

pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252

pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393

pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268

pm_kind::IK
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

pm_kind::SK
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

pm_io::display_type
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

2getDateTime()

3+2024, +8, +22, -240, +20, +23, +10, +956

4getOrdinalDay()

5+235

6

7

8call date_and_time(values = Values)

9Values(1:3)

10+2024, +8, +22

11getOrdinalDay(Values(1:3))

12+235

13

14

15getOrdinalDay(-4713_IK, 11_IK, 24_IK)

16+328

17

18

19getOrdinalDay(-1_IK, 1_IK, 1_IK)

20+1

21

22

23getOrdinalDay(-1_IK, 12_IK, 31_IK)

24+365

25

26

27getOrdinalDay(0_IK, 12_IK, 31_IK)

28+366

29

30

31getOrdinalDay(1_IK, 12_IK, 31_IK)

32+365

33

34

35getOrdinalDay(1582_IK, 10_IK, 15_IK)

36+288

37

38

39getOrdinalDay(1901_IK, 1_IK, 1_IK)

40+1

41

42

43getOrdinalDay(1999_IK, 3_IK, 1_IK)

44+60

45

46

47getOrdinalDay(2000_IK, 3_IK, 1_IK)

48+61

49

50

51getOrdinalDay(1999_IK, 4_IK, 15_IK) ! 105

52+105

53

54

55getOrdinalDay(2000_IK, 4_IK, 15_IK) ! 106 (leap year)

56+106

57

58

59getOrdinalDay(9999_IK, 12_IK, 31_IK)

60+365

61

62

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.

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.
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.

Copyright: Computational Data Science Lab

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

Definition at line 3223 of file pm_dateTime.F90.

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

src/fortran/main/pm_dateTime.F90