pm_dateTime::isMorning Interface Reference

Generate and return .true. if the hour in the current or the input time zone (-720 : +840) is Ante Meridiem (before noon). More...

Detailed Description

Generate and return .true. if the hour in the current or the input time zone (-720 : +840) is Ante Meridiem (before noon).

Parameters

[in]	zone	: The input scalar or array of arbitrary shape of type integer of default kind IK containing the time zone of interest in units of minutes. (optional, default = the current local time zone.)
[in]	julianDay	: The input scalar or array of arbitrary shape of type real of default kind RK containing the (possibly proleptic) Julian Day. (optional, default = the current locale Julian Day.)

Returns

isMorning : The output scalar or array of the same rank as input array-like arguments, of type logical of default kind LK. It is .true. if and only if the current time or the time corresponding to the input zone or julianDay or both represents represents morning.

Possible calling interfaces ⛓

use pm_dateTime, only: isMorning
real(RK)    :: julianDay
logical(LK) :: morning
integer(IK) :: zone
 
morning = isMorning() ! impure : current local hour
morning = isMorning(zone) ! elemental : current (realtime) hour in the specified time zone
morning = isMorning(julianDay) ! elemental
morning = isMorning(julianDay, zone) ! elemental
!

Warning

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 there is no input argument.

The conditions -12 * 60 < zone and zone < +14 * 60 must hold for the corresponding input arguments.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

Remarks

The procedures under discussion are elemental.

The procedures under this generic interface are non-elemental when there is no input argument.

See also

getMillisecond
getSecond
getMinute
getHour12
getHour
getZone
getZoneAbbr
getDay
getMonth
getYear
isLeapYear

Example usage ⛓

program example
 
    use pm_kind, only: IK, RK, SK
    use pm_io, only: display_type
    use pm_dateTime, only: getDateTime
    use pm_dateTime, only: isMorning
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getDateTime()")
    call disp%show( getDateTime() )
    call disp%show("isMorning() ! is it morning at local time?")
    call disp%show( isMorning() )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(0) ! is it morning at UTC?")
    call disp%show( isMorning(0) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(60 * [-12, 3, 14]) ! is it morning in the specified timezones with respect to UTC?")
    call disp%show( isMorning(60 * [-12, 3, 14]) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(-0.5_RK) ! November 24, -4713, start of the day (just after midnight)")
    call disp%show( isMorning(-0.5_RK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(-0.3_RK) ! November 24, -4713, start of the day (after midnight, before noon)")
    call disp%show( isMorning(-0.3_RK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(0._RK) ! November 24, -4713, noon (start of JD in Gregorian Calendar)")
    call disp%show( isMorning(0._RK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(0.5_RK) ! November 25, -4713, start of the day (just after midnight)")
    call disp%show( isMorning(0.5_RK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning(0.5_RK, zone = -6 * 60) ! November 25, -4713, start of the UTC day (just after midnight) but at timezone -6 (Texas) where it is still afternoon")
    call disp%show( isMorning(0.5_RK, zone = -6 * 60) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK]) ! morning immediately after midnight, morning before noon, afternoon right before midnight")
    call disp%show( isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK]) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK], zone = 60 * [-1, +14, -12]) ! afternoon near midnight, afternoon the day before UTC, morning right before none at time zone -720")
    call disp%show( isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK], zone = 60 * [-1, +14, -12]) )
    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 ⛓

 
getDateTime()
+2024, +8, +22, -240, +20, +23, +18, +754
isMorning() ! is it morning at local time?
F
 
 
isMorning(0) ! is it morning at UTC?
T
 
 
isMorning(60 * [-12, 3, 14]) ! is it morning in the specified timezones with respect to UTC?
F, T, F
 
 
isMorning(-0.5_RK) ! November 24, -4713, start of the day (just after midnight)
T
 
 
isMorning(-0.3_RK) ! November 24, -4713, start of the day (after midnight, before noon)
T
 
 
isMorning(0._RK) ! November 24, -4713, noon (start of JD in Gregorian Calendar)
F
 
 
isMorning(0.5_RK) ! November 25, -4713, start of the day (just after midnight)
T
 
 
isMorning(0.5_RK, zone = -6 * 60) ! November 25, -4713, start of the UTC day (just after midnight) but at timezone -6 (Texas) where it is still afternoon
F
 
 
isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK]) ! morning immediately after midnight, morning before noon, afternoon right before midnight
T, T, F
 
 
isMorning([2440587.5_RK, 2440587.9_RK, 2444239.49999_RK], zone = 60 * [-1, +14, -12]) ! afternoon near midnight, afternoon the day before UTC, morning right before none at time zone -720
F, F, 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, January 30, 2021, 5:36 AM, Dallas, TX

Definition at line 3873 of file pm_dateTime.F90.

---

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

• src/fortran/main/pm_dateTime.F90