pm_dateTime::isValidDateTime Interface Reference

Generate and return .true. if the input date and time values(:) or (year, month, day, zone, hour, second, millisecond) octuple corresponds to a valid Gregorian Calendar date and time. More...

Detailed Description

Generate and return .true. if the input date and time values(:) or (year, month, day, zone, hour, second, millisecond) octuple corresponds to a valid Gregorian Calendar date and time.

Returning the correct result requires taking into account the possibility of leap years and the varying day counts of months.
A valid date requires,

1. a month between 1 and 12,
2. a day between 1 and 31 and consistent with the specified month and year,
3. a zone must be between -12:00 and +14:00 UTC, corresponding to -720 and +840 minutes as used here.
4. an hour of day between 0 and 23,
5. a minute of hour between 0 and 59,
6. a second of minute between 0 and 59,
7. a millisecond of second between 0 and 999.

Parameters

[in]	values	: The input contiguous array of shape (:) of type integer of default kind IK, containing the octuple [year, month, day, zone, hour, minute, second, millisecond] or a subset of it that always starts with year representing a Gregorian calendar date and/or time. The order of the elements of values follows that of the values argument of the Fortran intrinsic date_and_time(). (optional. It must 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 a year of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present 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 a month of a year of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present 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 a day of a month of a year of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument month is present.)
[in]	zone	: The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing a time zone of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument day is present.)
[in]	hour	: The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the hour of a day of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument zone is present.)
[in]	minute	: The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the minute of the hour of a day of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument hour is present.)
[in]	second	: The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the second of the minute of the hour of a day of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument minute is present.)
[in]	millisecond	: The input scalar, or array of the same shape as other array-like arguments, of type integer of default kind IK, containing the millisecond of the second of the minute of the hour of a day of the Gregorian calendar. (optional, default = any value that yields a valid date given the other input argument. It can be present only if the input argument second is present.)

Returns

isValid : The output scalar or array of the same shape as the input array-like arguments (except Vector), of type logical of default kind LK. It is .true. if and only if the input argument(s) correspond to a valid date and/or month of the Gregorian Calendar.
Otherwise, it is .false. is the input date and time is invalid or if the condition 0 < size(values) < 9 does not hold.

Possible calling interfaces ⛓

use pm_dateTime, only: isValidDateTime
logical(LK) :: isValid
 
isValid = isValidDateTime(year) ! elemental
isValid = isValidDateTime(year, month) ! elemental
isValid = isValidDateTime(year, month, day) ! elemental
isValid = isValidDateTime(year, month, day, zone) ! elemental
isValid = isValidDateTime(year, month, day, zone, hour) ! elemental
isValid = isValidDateTime(year, month, day, zone, hour, minute) ! elemental
isValid = isValidDateTime(year, month, day, zone, hour, minute, second) ! elemental
isValid = isValidDateTime(year, month, day, zone, hour, minute, second, millisecond) ! elemental
isValid = isValidDateTime(values(1:1)) ! values = [year]
isValid = isValidDateTime(values(1:2)) ! values = [year, month]
isValid = isValidDateTime(values(1:3)) ! values = [year, month, day]
isValid = isValidDateTime(values(1:4)) ! values = [year, month, day, zone]
isValid = isValidDateTime(values(1:5)) ! values = [year, month, day, zone, hour]
isValid = isValidDateTime(values(1:6)) ! values = [year, month, day, zone, hour, minute]
isValid = isValidDateTime(values(1:7)) ! values = [year, month, day, zone, hour, minute, second]
isValid = isValidDateTime(values(1:8)) ! values = [year, month, day, zone, hour, minute, second, millisecond]
!

Warning

An input argument year = 0 corresponds to the historic 1 BC notation of the Gregorian calendar.
This is in accordance with the convention in astronomical year numbering and the international standard date system, ISO 8601.
In these systems, the year 0 is a leap year.

The size of the input argument values(:) must be non-zero and less than 8, otherwise, the returned value is .false..

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.

Remarks

The procedures under discussion are elemental. The procedures under this generic interface are non-elemental when the input argument values(:) is present.

See also

getDateAfter
getDateTime

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_io, only: display_type
    use pm_dateTime, only: isValidDateTime, getYear
 
    implicit none
 
    integer :: i
    integer(IK) :: Values(9)
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("isValidDateTime(0_IK)")
    call disp%show( isValidDateTime(0_IK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getYear()")
    call disp%show( getYear() )
    call disp%show("isValidDateTime(getYear())")
    call disp%show( isValidDateTime(getYear()) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("call date_and_time(values = Values(1:8))")
                    call date_and_time(values = Values(1:8))
    call disp%show("Values(1:8)")
    call disp%show( Values(1:8) )
    call disp%skip()
    do i = size(Values), 0, -1
        call disp%show("i")
        call disp%show( i )
        call disp%show("isValidDateTime(Values(1:i))")
        call disp%show( isValidDateTime(Values(1:i)) )
        call disp%skip()
    end do
    call disp%skip()
 
    call disp%skip()
    call disp%show("isValidDateTime(1999_IK, 2_IK, 28_IK) ! February is 28 days in non-leap years.")
    call disp%show( isValidDateTime(1999_IK, 2_IK, 28_IK) )
    call disp%show("isValidDateTime(1999_IK, 2_IK, 29_IK) ! February is 28 days in non-leap years.")
    call disp%show( isValidDateTime(1999_IK, 2_IK, 29_IK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isValidDateTime(2000_IK, 2_IK, 28_IK) ! February is 29 days in leap years.")
    call disp%show( isValidDateTime(2000_IK, 2_IK, 28_IK) )
    call disp%show("isValidDateTime(2000_IK, 2_IK, 29_IK) ! February is 29 days in leap years.")
    call disp%show( isValidDateTime(2000_IK, 2_IK, 29_IK) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
isValidDateTime(0_IK)
T
 
 
getYear()
+2024
isValidDateTime(getYear())
T
 
 
call date_and_time(values = Values(1:8))
Values(1:8)
+2024, +8, +22, -240, +20, +23, +19, +482
 
i
+9
isValidDateTime(Values(1:i))
F
 
i
+8
isValidDateTime(Values(1:i))
T
 
i
+7
isValidDateTime(Values(1:i))
T
 
i
+6
isValidDateTime(Values(1:i))
T
 
i
+5
isValidDateTime(Values(1:i))
T
 
i
+4
isValidDateTime(Values(1:i))
T
 
i
+3
isValidDateTime(Values(1:i))
T
 
i
+2
isValidDateTime(Values(1:i))
T
 
i
+1
isValidDateTime(Values(1:i))
T
 
i
+0
isValidDateTime(Values(1:i))
F
 
 
 
isValidDateTime(1999_IK, 2_IK, 28_IK) ! February is 28 days in non-leap years.
T
isValidDateTime(1999_IK, 2_IK, 29_IK) ! February is 28 days in non-leap years.
F
 
 
isValidDateTime(2000_IK, 2_IK, 28_IK) ! February is 29 days in leap years.
T
isValidDateTime(2000_IK, 2_IK, 29_IK) ! February is 29 days in leap years.
T
 
 

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.

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 2795 of file pm_dateTime.F90.

---

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

• src/fortran/main/pm_dateTime.F90