pm_val2str::getStr Interface Reference

Generate and return the conversion of the input value to an output Fortran string, possibly with the requested format and sign symbol, if provided. More...

Detailed Description

Generate and return the conversion of the input value to an output Fortran string, possibly with the requested format and sign symbol, if provided.

Parameters

[in]	val	: The input scalar or contiguous array of rank 0, 1, or 2 of either type css_type (derived type container of scalar string of default kind SK) or type css_pdt (parameterized derived type container of scalar string of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU)) or type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) or type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64) or type logical of kind any supported by the processor (e.g., LK) or type complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128) or type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128). containing the value to be converted to string.
[in]	format	: The input scalar of type character of default kind SK representing the Fortran IO format to be used when writing the value to the output allocatable character (optional, the default value depends on the type of the input val: If val is of type complex and the sign argument is missing, then format = "(*('(',g0,',',g0,')',:,','))". If val is of type complex and sign = .true., then format = "(*('(',sp,g0,',',g0,')',:,','))". If val is of type integer or real and the sign argument is missing, then format = "(*(g0,:,','))". If val is of type integer or real and the sign argument is missing, then format = "(*(sp,g0,:,','))". If val is neither integer nor real nor complex, then format = "(*(g0,:,','))". However, If val is of type character, then the blank characters are trimmed form the right side of each value. If val is of type logical, then the values TRUE and FALSE are output, corresponding to .true. and .false.. In all cases, the default separator is a comma ,.)
[in]	length	: The input scalar of type integer of default kind IK representing the length of the output string. If provided, the output string will be preallocated with the requested input length. Then, the value will be written to it. If missing, the blank characters on both ends of the output string will be trimmed. (optional, default = automatically determined such that all leading and trailing blank characters are removed)
[in]	signed	: The input scalar of type logical of default kind LK. If .true., the output, if it is a number, will be signed (+ or -). Otherwise, the output numbers will be unsigned. The value of signed is ignored if the optional input argument format is present. (optional, default = .false.)

Returns

str : The output allocatable scalar of type character of default kind SK containing the input value as a string with the specified format.

Possible calling interfaces ⛓

use pm_val2str, only: getStr
 
str = getStr(val, format = format, length = length, signed = signed)
str = getStr(val(:), format = format, length = length, signed = signed)
str = getStr(val(:,:), format = format, length = length, signed = signed)

Remarks

The procedures under discussion are pure.

Warning

If the input argument length is present, its value must be large enough to contain the full input value.

See also

getStr
setStr
getInt
setInt
getLogical
setLogical
getComplex
setComplex
getReal
setReal

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_kind, only: IKL, IKS, IKD, IKH
    use pm_kind, only: CKL, CKD, CKH
    use pm_kind, only: RKL, RKD, RKH
    use pm_io, only: display_type
    use pm_val2str, only: getStr
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("getStr('paramonte')")
    call disp%show( getStr('paramonte') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr('  paramonte')")
    call disp%show( getStr('  paramonte') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr('  paramonte  ')")
    call disp%show( getStr('  paramonte  ') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(['paramonte', 'library  '])")
    call disp%show( getStr(['paramonte', 'library  ']) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(['paramonte  ', '  library  '])")
    call disp%show( getStr(['paramonte  ', '  library  ']) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(-1_IKL)")
    call disp%show( getStr(-1_IKL) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(.true.)")
    call disp%show( getStr(.true.) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(.false.)")
    call disp%show( getStr(.false.) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(123_IKS)")
    call disp%show( getStr(123_IKS) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(1234_IKD, signed = .true._LK)")
    call disp%show( getStr(1234_IKD, signed = .true._LK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(1234_IKD, length = 10_IK, signed = .true._LK)")
    call disp%show( getStr(1234_IKD, length = 10_IK, signed = .true._LK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(987654321_IKH, length = 15_IK)")
    call disp%show( getStr(987654321_IKH, length = 15_IK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(987654321_IKH, length = 15_IK, format = SK_'(1I15)')")
    call disp%show( getStr(987654321_IKH, length = 15_IK, format = SK_'(1I15)') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(123._RKL)")
    call disp%show( getStr(123._RKL) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(123._RKD, format = SK_'(E25.15)') ! use scientific notation with a width of 25.")
    call disp%show( getStr(123._RKD, format = SK_'(E25.15)') , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr([9.e100_RKH, -123456._RKH])")
    call disp%show( getStr([9.e100_RKH, -123456._RKH]) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr((1._CKH,-1._CKH))")
    call disp%show( getStr((1._CKH,-1._CKH)) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr([(1._CKD,-1._CKD), (2._CKD,-2._CKD)], signed = .true._LK)")
    call disp%show( getStr([(1._CKD,-1._CKD), (2._CKD,-2._CKD)], signed = .true._LK) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getStr(reshape([(1._CKL,-1._CKL), (2._CKL,-2._CKL), (3._CKL,-3._CKL), (4._CKL,-4._CKL)], shape = [2,2]), signed = .true._LK) ! input object of rank 2")
    call disp%show( getStr(reshape([(1._CKL,-1._CKL), (2._CKL,-2._CKL), (3._CKL,-3._CKL), (4._CKL,-4._CKL)], shape = [2,2]), signed = .true._LK) , 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 ⛓

 
getStr('paramonte')
"paramonte"
 
 
getStr('  paramonte')
"  paramonte"
 
 
getStr('  paramonte  ')
"  paramonte"
 
 
getStr(['paramonte', 'library  '])
"paramonte, library, "
 
 
getStr(['paramonte  ', '  library  '])
"paramonte,   library")) "
 
 
getStr(-1_IKL)
"-1"
 
 
getStr(.true.)
"TRUE"
 
 
getStr(.false.)
"FALSE"
 
 
getStr(123_IKS)
"123"
 
 
getStr(1234_IKD, signed = .true._LK)
"+1234"
 
 
getStr(1234_IKD, length = 10_IK, signed = .true._LK)
"+1234     "
 
 
getStr(987654321_IKH, length = 15_IK)
"987654321      "
 
 
getStr(987654321_IKH, length = 15_IK, format = SK_'(1I15)')
"      987654321"
 
 
getStr(123._RKL)
123.000000
 
 
getStr(123._RKD, format = SK_'(E25.15)') ! use scientific notation with a width of 25.
"    0.123000000000000E+03"
 
 
getStr([9.e100_RKH, -123456._RKH])
"0.899999999999999999999999999999999983E+101, -123456.000000000000000000000000000000"
 
 
getStr((1._CKH,-1._CKH))
"(1.00000000000000000000000000000000000, -1.00000000000000000000000000000000000)"
 
 
getStr([(1._CKD,-1._CKD), (2._CKD,-2._CKD)], signed = .true._LK)
"(+1.0000000000000000, -1.0000000000000000), (+2.0000000000000000, -2.0000000000000000)"
 
 
getStr(reshape([(1._CKL,-1._CKL), (2._CKL,-2._CKL), (3._CKL,-3._CKL), (4._CKL,-4._CKL)], shape = [2,2]), signed = .true._LK) ! input object of rank 2
"(+1.00000000, -1.00000000), (+2.00000000, -2.00000000), (+3.00000000, -3.00000000), (+4.00000000, -4.00000000)"
 
 

Test:

test_pm_val2str

Bug:

Status: Unresolved
Source: GNU Fortran Compiler gfortran version 10.3-11
Description: The GNU Fortran Compiler gfortran cannot handle IO of string arrays of zero-length of non-zero size in getStr() in assertion check blocks.
The issue happens to be with deferred-length strings character(:,SKG), allocatable :: Array(:).
The Intel Classic Fortran Compiler ifort can handle this properly.

Remedy (as of ParaMonte Library version 2.0.0): Avoid deferred-length strings where GNU Fortran Compiler gfortran cannot compile.

Bug:

Todo:

Low Priority: This generic interface can be expanded to arrays of higher dimensions than two.

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, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 167 of file pm_val2str.F90.

---

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

• src/fortran/main/pm_val2str.F90