pm_io::getCountRecord Interface Reference

Generate and return the number of records in the entire record-oriented input file. More...

Detailed Description

Generate and return the number of records in the entire record-oriented input file.

If any error occurs during the IO and the output iostat argument is missing, the program will halt by calling error stop.
Within the procedures,

1. If the input argument file is present, the file will be opened on input and closed before returning the control.
   
2. If the input argument unit is present, the file is assumed to opened already, will be rewound to the file beginning, and will be positioned after the last record in file without being closed on return.
   

See getCountRecordLeft for counting the number of records left in an already-opened file.

Parameters

[in]	file	: The input scalar character of default kind SK containing the file path, whose number of records will be returned. The input file must not be connected prior to calling this procedure. If the file is already connected, specify the file unit as input unit argument. (optional. It must be present if and only if the input argument unit is missing.)
[in]	unit	: The input scalar integer of default kind IK containing the connected file unit, whose number of records will be returned. The input unit must be connected prior to calling this procedure. If the unit is not already connected, specify the file path as the input file argument. (optional. It must be present if and only if the input argument unit is missing.)
	isCountable	: The external user-specified function that takes one input scalar character of default kind SK of arbitrary length type parameter containing the most recent record that has been read from the input file. It returns a scalar logical of default kind LK that is .true. if and only if the input record should be included in counting. The following illustrates the generic interface of isCountable, function isCountable(record) result(countable) use pm_kind, only: LK, SK character(*, SK), intent(in) :: record logical(LK) :: countable end function This user-defined countability check is extremely useful where certain records in the file ought to be excluded from counting or only records with specific patterns should be included (for example, excluding or including only records that are empty or begin with or end with or have specific patterns). (optional. If missing, all records are included in counting.)
[in]	del	: The input scalar logical of default kind LK. If .true., the file will be deleted upon return. If .false., the file will only be closed (without deletion) upon return. (optional, default = .false.)
[out]	iostat	: The optional output scalar integer of default kind IK. If present and no error occurs, it is set to 0 on output. If present and an error occurs (e.g., if the input argument values are wrong or inconsistent), it is set to a positive non-zero value. If missing and an error occurs, then the program halts by calling error stop followed by the relevant error message. (optional.)
[in,out]	iomsg	: The input/output scalar character of default kind SK containing the error message, if any error occurs. A length type parameter value of LEN_IOMSG is generally sufficient for iomsg to contain the output error messages. (optional. Its presence is relevant only if the iostat output argument is also present.)

Returns

nrecord : The output scalar integer of default kind IK, representing the number of records in the input file.

Possible calling interfaces ⛓

use pm_io, only: getCountRecord
 
nrecord = getCountRecord(file, isCountable = isCountable, del = del, iostat = iostat, iomsg = iomsg) ! file must not be connected.
nrecord = getCountRecord(unit, isCountable = isCountable, del = del, iostat = iostat, iomsg = iomsg) ! unit must be already connected. `rewind(unit)` will occur.

Warning

The input file must not be connected prior to calling this procedure.
The input unit must be already connected prior to calling this procedure.
These conditions are verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.

Remarks

The procedures under discussion are impure.

See also

getCountRecordLeft
isPreconnected
getFileUnit

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_io, only: display_type
    use pm_io, only: getCountRecord
 
    implicit none
 
    integer(IK)                     :: iostat
    character(255, SK)              :: iomsg
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!Count the number of records in the record-oriented (sequential access) `main.F90` file.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip
 
    iomsg = repeat(" ", len(iomsg))
 
    call disp%skip
    call disp%show("getCountRecord(file = SK_'main.F90')")
    call disp%show( getCountRecord(file = SK_'main.F90') )
    call disp%skip
 
    call disp%skip
    call disp%show("getCountRecord(file = SK_'main.F90', iostat = iostat, iomsg = iomsg)")
    call disp%show( getCountRecord(file = SK_'main.F90', iostat = iostat, iomsg = iomsg) )
    call disp%show("iostat")
    call disp%show( iostat )
    call disp%show("trim(adjustl(iomsg))")
    call disp%show( trim(adjustl(iomsg)) , deliml = SK_"""" )
    call disp%skip
 
    call disp%skip
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%show("!Exclude certain records that match the user-specified behavior via isCountable.")
    call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
    call disp%skip
 
    call disp%skip
    call disp%show("getCountRecord(file = SK_'main.F90', isCountable = isCountable)")
    call disp%show( getCountRecord(file = SK_'main.F90', isCountable = isCountable) )
    call disp%skip
 
contains
 
    function isCountable(record) result(countable)
        character(*, SK), intent(in)    :: record
        logical(LK)                     :: countable
        countable = index(record, SK_"call disp%skip", kind = IK) == 0_IK
    end function
 
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 ⛓

 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!Count the number of records in the record-oriented (sequential access) `main.F90` file.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
getCountRecord(file = SK_'main.F90')
+56
 
 
getCountRecord(file = SK_'main.F90', iostat = iostat, iomsg = iomsg)
+56
iostat
+0
trim(adjustl(iomsg))
"                                                                                                                                                                                                                                                               "
 
 
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
!Exclude certain records that match the user-specified behavior via isCountable.
!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 
getCountRecord(file = SK_'main.F90', isCountable = isCountable)
+46
 
 

Test:

test_pm_io

Todo:

This procedure can be converted to a generic interface to add the optional iseq() external comparison procedures for custom exclusion or inclusion of lines in the count.

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, Tuesday March 7, 2017, 3:50 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 1502 of file pm_io.F90.

---

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

• src/fortran/main/pm_io.F90