pm_io::field_type Type Reference

The derived type that can be used for constructing containers of format or left and right delimiters for the (five) intrinsic Fortran field types. More...

Public Attributes
character(:, SK), allocatable	string
	The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping character fields before displaying them. More...
character(:, SK), allocatable	integer
	The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping integer fields before displaying them. More...
character(:, SK), allocatable	logical
	The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping logical fields before displaying them. More...
character(:, SK), allocatable	complex
	The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping complex fields before displaying them. More...
character(:, SK), allocatable	real
	The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping real fields before displaying them. More...

Detailed Description

The derived type that can be used for constructing containers of format or left and right delimiters for the (five) intrinsic Fortran field types.

Object of this derived type can be either,

1. passed as input arguments to the constructor of display_type to specify the IO formatting of fields of objects of various intrinsic types that are to be subsequently displayed by the methods of display_type.
   
2. used in other situations to specify properties of IO fields of various intrinsic types, for example, to specify the left and right delimiters of fields of objects of intrinsic types.
   

Parameters

[in]	string	: The input allocatable scalar character of default kind SK containing a specific formatting property of a field of type character. (optional. If missing, the corresponding component of the output field object remains unallocated.)
[in]	integer	: The input allocatable scalar character of default kind SK containing a specific formatting property of a field of type integer. (optional. If missing, the corresponding component of the output field object remains unallocated.)
[in]	logical	: The input allocatable scalar character of default kind SK containing a specific formatting property of a field of type logical. (optional. If missing, the corresponding component of the output field object remains unallocated.)
[in]	complex	: The input allocatable scalar character of default kind SK containing a specific formatting property of a field of type complex. (optional. If missing, the corresponding component of the output field object remains unallocated.)
[in]	real	: The input allocatable scalar character of default kind SK containing a specific formatting property of a field of type real. (optional. If missing, the corresponding component of the output field object remains unallocated.)

Returns

field : The output scalar object of type field_type containing allocatable scalar character components corresponding to the input arguments.
Any component of the output field corresponding to a missing input argument remains unallocated on output.

Possible calling interfaces ⛓

use pm_io, only: field_type
type(field_type) :: field
 
field = field_type(string = string, integer = integer, logical = logical, complex = complex, real = real)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

wrap_type%%wrap()
display_type%%show()
display_type%%skip()
getStrWrapped
getCentered
setCentered
isFailedGetShellWidth
isFailedGetShellHeight

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, LK
    use pm_io, only: field_type
    use pm_io, only: display_type
    use pm_distUnif, only: getUnifRand
    use pm_distUnif, only: setUnifRand
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = SK_"main.out.F90")
 
    call disp%skip()
    call disp%show('disp = display_type(file = SK_"main.out.F90", format = field_type(complex = SK_"math"))')
                    disp = display_type(file = SK_"main.out.F90", format = field_type(complex = SK_"math"))
    call disp%show("call disp%show( getUnifRand((-1., -1.), (+1., +1.), 5_IK) )")
                    call disp%show( getUnifRand((-1., -1.), (+1., +1.), 5_IK) )
    call disp%skip()
    call disp%show('disp = display_type(file = SK_"main.out.F90", deliml = field_type(string = SK_"**", real = SK_"("), delimr = field_type(string = SK_"**", real = SK_")"))')
                    disp = display_type(file = SK_"main.out.F90", deliml = field_type(string = SK_"**", real = SK_"("), delimr = field_type(string = SK_"**", real = SK_")"))
    call disp%show("call disp%show('This is a custom (star-) delimited string.')", deliml = SK_"", delimr = SK_"")
                    call disp%show('This is a custom (star-) delimited string.')
    call disp%show("call disp%show( getUnifRand(-1., +1., 5_IK) )", deliml = SK_"", delimr = SK_"")
                    call disp%show( getUnifRand(-1., +1., 5_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 ⛓

 
disp = display_type(file = SK_"main.out.F90", format = field_type(complex = SK_"math"))
 
call disp%show( getUnifRand((-1., -1.), (+1., +1.), 5_IK) )
+0.457857370+0.434354186i, -0.941208601+0.352715850i, +0.386015654+0.498311520E-1i, +0.431145549-0.218367577i, +0.746247768E-1+0.337893128i
 
disp = display_type(file = SK_"main.out.F90", deliml = field_type(string = SK_"**", real = SK_"("), delimr = field_type(string = SK_"**", real = SK_")"))
 
call disp%show('This is a custom (star-) delimited string.')
**This is a custom(star-) delimited string.**
call disp%show( getUnifRand(-1., +1., 5_IK) )
(-0.614024758), (-0.891578197E-1), (-0.999374866), (+0.449042439), (+0.660932422)
 
 

Test:

test_pm_io

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 482 of file pm_io.F90.

Member Data Documentation

complex

character(:, SK), allocatable pm_io::field_type::complex

The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping complex fields before displaying them.

Definition at line 486 of file pm_io.F90.

integer

character(:, SK), allocatable pm_io::field_type::integer

The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping integer fields before displaying them.

Definition at line 484 of file pm_io.F90.

logical

character(:, SK), allocatable pm_io::field_type::logical

The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping logical fields before displaying them.

Definition at line 485 of file pm_io.F90.

real

character(:, SK), allocatable pm_io::field_type::real

The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping real fields before displaying them.

Definition at line 487 of file pm_io.F90.

string

character(:, SK), allocatable pm_io::field_type::string

The scalar character of default kind SK representing the default left or right delimiter to be used for wrapping character fields before displaying them.

Definition at line 483 of file pm_io.F90.

---

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

• src/fortran/main/pm_io.F90