ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_container::css_pdt Type Reference

This is the css_pdt parameterized type for generating instances of container of scalar of string objects of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU).
More...

Public Attributes

integer kind = SK
 
character(:, kind), allocatable val
 

Detailed Description

This is the css_pdt parameterized type for generating instances of container of scalar of string objects of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU).

The css_pdt container is widely known as varying string or string container within the Fortran language.
The constructor of this derived type takes the following arguments.

Parameters
[in]val: The input scalar or array of arbitrary rank of type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU).
[in]trimmed: The input scalar or array of the same shape as the input val, of type logical of default kind LK.
If .true., the corresponding elements of the input val will not be trimmed.
Setting this argument to .true. will lead to better runtime performance.
(optional, default = .false., i.e., all input val will be left-adjusted and trimmed).
Returns
container : The output object of type css_pdt(kind(val) of the same kind, rank, and shape as the input val, each element of which contains the corresponding element of the input val.


Possible calling interfaces

type(css_pdt(kind("a"))), allocatable :: containers(:)
type(css_pdt(kind("a"))) :: container
container = css_pdt(val, trimmed = trimmed)
! example
container = css_pdt("aaa")
containers = css_pdt([character(3) :: "a", "aa", "aaa"])
containers = css_pdt([character(3) :: "a", "aa", "aaa"], trimmed = .false._LK)
This module contains the derived types for generating allocatable containers of scalar,...
This is the css_pdt parameterized type for generating instances of container of scalar of string obje...
Remarks
The procedures under discussion are pure.
The procedures under discussion are elemental.
See also
css_pdt
cvs_pdt
cms_pdt
ccs_pdt
css_type
cvs_type
cms_type
ccs_type


Example usage

1program example
2 use pm_kind, only: SK, IK, LK
3 use pm_io, only: display_type
4 use pm_io, only: display_type
5 use pm_arrayRange, only: getRange
6 use pm_str, only: getCharVec
7
8 implicit none
9
10 type(display_type) :: disp
11 disp = display_type(file = "main.out.F90")
12
13#if PDT_ENABLED
14 block
15
16 use pm_kind, only: SKG => SK
17 use pm_container, only: css_pdt
18 type(css_pdt), allocatable :: scalar, vector(:), matrix(:,:), cube(:,:,:)
19
20 call disp%skip()
21 call disp%show("scalar = css_pdt(SKG_'ParaMonte')")
22 scalar = css_pdt(SKG_'ParaMonte')
23 call disp%show("scalar")
24 call disp%show( scalar , deliml = SK_"""" )
25 call disp%skip()
26
27 call disp%skip()
28 call disp%show("vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'])")
29 vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'])
30 call disp%show("vector")
31 call disp%show( vector , deliml = SK_"""" )
32 call disp%skip()
33
34 call disp%skip()
35 call disp%show("vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'], trimmed = .false._LK)")
36 vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'], trimmed = .false._LK)
37 call disp%show("vector")
38 call disp%show( vector , deliml = SK_"""" )
39 call disp%skip()
40
41 call disp%skip()
42 call disp%show("vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'], trimmed = .true._LK) ! This will avoid the automatic application of `trim()` to the input string vector.")
43 vector = css_pdt([character(3,SKG) :: 'a', 'aa', 'aaa'], trimmed = .true._LK)
44 call disp%show("vector")
45 call disp%show( vector , deliml = SK_"""" )
46 call disp%skip()
47
48 call disp%skip()
49 call disp%show("matrix = css_pdt( reshape(getCharVec(getRange(SKG_'A', SKG_'X')), shape = [3, 8]) )")
50 matrix = css_pdt( reshape(getCharVec(getRange(SKG_'A', SKG_'X')), shape = [3, 8]) )
51 call disp%show("matrix")
52 call disp%show( matrix , deliml = SK_"""" )
53 call disp%skip()
54
55 call disp%skip()
56 call disp%show("cube = css_pdt( reshape(getCharVec(getRange(SKG_'A', SKG_'X')), shape = [2, 3, 4]) )")
57 cube = css_pdt( reshape(getCharVec(getRange(SKG_'A', SKG_'X')), shape = [2, 3, 4]) )
58 call disp%show("cube")
59 call disp%show( cube , deliml = SK_"""" )
60 call disp%skip()
61
62 end block
63#else
64 call disp%show("PDT examples are disabled in the current ParaMonte library configuration.")
65#endif
66
67end program example
Generate minimally-spaced character, integer, real sequences or sequences at fixed intervals of size ...
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
Generate and return a vector of single-characters each element of which corresponds to one character ...
Definition: pm_str.F90:1242
This module contains procedures and generic interfaces for generating ranges of discrete character,...
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
This module contains classes and procedures for various string manipulations and inquiries.
Definition: pm_str.F90:49
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1PDT examples are disabled in the current ParaMonte library configuration.
2
Test:
test_pm_container


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.

Author:
Fatemeh Bagheri, Tuesday, April 30, 2019, 12:58 PM, SEIR, UTA Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 783 of file pm_container.F90.

Member Data Documentation

◆ kind

integer pm_container::css_pdt::kind = SK

Definition at line 784 of file pm_container.F90.

◆ val

character(:, kind), allocatable pm_container::css_pdt::val

Definition at line 785 of file pm_container.F90.


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