pm_dateTime::isLastDayInMonth Interface Reference

Generate and return .true. if the input date (year, month, day) triple corresponds to the last day of a Gregorian Calendar month. More...

Detailed Description

Generate and return .true. if the input date (year, month, day) triple corresponds to the last day of a Gregorian Calendar month.

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

lastDayInMonth : The output scalar or array of the same shape as the input array-like arguments of type logical of default kind LK. It is .true. if and only if the input date corresponds to the last day of a month in the Gregorian Calendar.

Possible calling interfaces ⛓

use pm_dateTime, only: isLastDayInMonth
logical(LK) :: lastDayInMonth
 
lastDayInMonth = isLastDayInMonth() ! current date is used.
lastDayInMonth = isLastDayInMonth(values(1:3)) ! values = [year, month, day]
lastDayInMonth = isLastDayInMonth(year, month, day)
!

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.

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

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_val2str, only: getStr
    use pm_io, only: display_type
    use pm_dateTime, only: isLastDayInMonth
 
    implicit none
 
    integer(IK) :: Values(8)
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("! Determine if a given Gregorian calendar date is the last of the month.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip()
 
    call disp%skip()
    call disp%show("isLastDayInMonth(1582_IK, 10_IK, 15_IK)")
    call disp%show( isLastDayInMonth(1582_IK, 10_IK, 15_IK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isLastDayInMonth(1_IK, 1_IK, 31_IK)")
    call disp%show( isLastDayInMonth(1_IK, 1_IK, 31_IK) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("isLastDayInMonth(1999_IK, 12_IK, 31_IK)")
    call disp%show( isLastDayInMonth(1999_IK, 12_IK, 31_IK) )
    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("SK_'The statement `Today is the last day of month` is '//getStr(isLastDayInMonth(Values(1:3)))//SK_'.'")
    call disp%show( SK_'The statement `Today is the last day of month` is '//getStr(isLastDayInMonth(Values(1:3)))//SK_'.' , deliml = SK_"""" )
    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 ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
! Determine if a given Gregorian calendar date is the last of the month.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
isLastDayInMonth(1582_IK, 10_IK, 15_IK)
F
 
 
isLastDayInMonth(1_IK, 1_IK, 31_IK)
T
 
 
isLastDayInMonth(1999_IK, 12_IK, 31_IK)
T
 
 
call date_and_time(values = Values(1:8))
SK_'The statement `Today is the last day of month` is '//getStr(isLastDayInMonth(Values(1:3)))//SK_'.'
"The statement `Today is the last day of month` is FALSE."
 
 

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 Austin

Definition at line 2936 of file pm_dateTime.F90.

---

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

• src/fortran/main/pm_dateTime.F90