ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_arrayInit::setCoreHalo Interface Reference

Initialize the rectangular core and halo of an input array of arbitrary rank and shape of arbitrary intrinsic type and kind with the corresponding user-specified values.
More...

Detailed Description

Initialize the rectangular core and halo of an input array of arbitrary rank and shape of arbitrary intrinsic type and kind with the corresponding user-specified values.

The halo of an array of arbitrary rank is defined as the complement of rectangular core region of arbitrary size within a super-rectangle array.
The following figure illustrates example cores and halos of two 1D and 2D arrays.

Parameters
[out]array: The output scalar of,
  • type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) of arbitrary length type parameter or,
the output contiguous array of rank 1, 2, or 3, of arbitrary shape, of either,
  • 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).
On output, the rectangular core and halo of the array will be initialized to the specified input arguments core and halo respectively.
[in]core: The input scalar, or contiguous array of the same rank as the output array, of the same type and kind as the output array, containing the value to write to the rectangular core of array.
  • If core is scalar, then the extents along each dimension of array are determined by the input vector argument csize of size rank(array).
    • If array is a scalar string and the input argument csize is present, then core must be of type character with length type parameter 1.
    • If array is a scalar string and the input argument csize is missing, then core must be of type character with length type parameter len(core) <= len(array).
  • If core is an array, then the extents of it (shape(core)) delineate the rectangular core of array into which core will be pasted.
    • If array is of type character, then the condition len(core) <= len(array) must hold.
[in]halo: The input scalar of the same type and kind as the output array, containing the value to write to the halo surrounding the specified rectangular core of the array.
  • If array is a scalar string, then halo must be a single character (with length type parameter 1).
  • If array is an array of type character, then halo can have arbitrary length type parameter satisfying the condition len(halo) <= len(array).
[in]coffset: The input non-negative scalar or vector of size rank(array) of type integer of default kind IK representing the index offset from the first (top-left corner) element of array, such that array(@coffset + 1) represents the indices of first element of the rectangular core of array.
  • If the output array is of rank <= 1, then coffset must be a scalar.
  • If the output array is of rank >= 2, then coffset must be a vector of size rank(array).
[in]csize: The input non-negative scalar or vector of size rank(array) of type integer of default kind IK representing the extent of the rectangular core of array along each dimension, such that array(@coffset + @csize) represents the indices of last element of the rectangular core of array.
  • If the output array is of rank <= 1, then csize must be a scalar.
  • If the output array is of rank >= 2, then csize must be a vector of size rank(array).
(optional. default = shape(core). It must be present if and only if the input argument core is scalar.)


Possible calling interfaces ⛓

use pm_arrayInit, only: setCoreHalo
call setCoreHalo(array(..), core(@shape(array)), halo, coffset(1:rank(array)))
call setCoreHalo(array(..), core , halo, coffset(1:rank(array)), csize(1:rank(array)))
pm_arrayInit::setCoreHalo
Initialize the rectangular core and halo of an input array of arbitrary rank and shape of arbitrary i...
Definition: pm_arrayInit.F90:1504
pm_arrayInit
This module contains procedures and generic interfaces for efficient initialization of arbitrary rect...
Definition: pm_arrayInit.F90:64
Warning
The condition all(0 <= csize) must hold for the corresponding input arguments.
The condition all(0 <= coffset) must hold for the corresponding input arguments.
The condition all(coffset + csize <= shape(array)) must hold for the corresponding input arguments.
The condition len(core) <= len(array) must hold for the corresponding input arguments of type character of arbitrary rank.
The condition len(halo) <= len(array) must hold for the corresponding input arguments of type character of non-zero rank.
The condition len(halo) == 1 must hold for the corresponding input arguments of type character of zero rank.
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
Significant deliberation has gone into this generic interface to ensure its ease of use and future extensibility.
In particular, a generic interface with arguments coffset, csize was preferred over input arguments lbcore, ubcore representing the lower and upper bounds of the scalar core in the output array.
See also
getCoreHalo
setCoreHalo
setResized
setRebound
setRebilled
setRefilled
getCentered
setCentered
getPadded
setPadded


Example usage ⛓

1program example
2
3 use pm_kind, only: LK
4 use pm_kind, only: SK ! All kinds are supported.
5 use pm_kind, only: IK ! All kinds are supported.
6 use pm_kind, only: CK ! All kinds are supported.
7 use pm_kind, only: RK ! All kinds are supported.
8 use pm_io, only: display_type
9 use pm_arrayInit, only: setCoreHalo
10
11 implicit none
12
13 integer(IK) :: i
14 type(display_type) :: disp
15 disp = display_type(file = "main.out.F90")
16
17#define SET_ARRAY \
18 block; \
19 DECLARATION; \
20 call disp%show("array"); \
21 call disp%show( array, deliml = SK_"""" ); \
22 call disp%show("core"); \
23 call disp%show( core, deliml = SK_"""" ); \
24 call disp%show("halo"); \
25 call disp%show( halo, deliml = SK_"""" ); \
26 call disp%show("coffset"); \
27 call disp%show( coffset, deliml = SK_"""" ); \
28 call disp%show("call setCoreHalo(array, core, halo, coffset)"); \
29 call setCoreHalo(array, core, halo, coffset); \
30 call disp%show("array"); \
31 call disp%show( array, deliml = SK_"""" ); \
32 call disp%skip(); \
33 end block;
34
35 call disp%skip()
36 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
37 call disp%show("! Initialize scalar with core and halo values.")
38 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
39 call disp%skip()
40
41#define DECLARATION \
42 character(21) :: array = ""; \
43 character(1 ) :: halo = "*"; \
44 character(15) :: core = "In God We Trust"; \
45 integer(IK) :: coffset = 3;
46 SET_ARRAY
47
48#define DECLARATION \
49 character(41) :: array = ""; \
50 character(1 ) :: halo = "~"; \
51 character(20) :: core = "In Science We Invest"; \
52 integer(IK) :: coffset = 2;
53 SET_ARRAY
54
55 call disp%skip()
56 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
57 call disp%show("! Initialize vector with core and halo values.")
58 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
59 call disp%skip()
60
61#define DECLARATION \
62 character(5) :: array(10) = "", core(4) = [character(5) :: "In", "God", "We", "Trust"], halo = "*****"; \
63 integer(IK) :: coffset = 3;
64 SET_ARRAY
65
66#define DECLARATION \
67 character(7) :: array(10) = "", core(4) = [character(7) :: "In", "Science", "We", "Invest"], halo = "~~~~~~~"; \
68 integer(IK) :: coffset = 3;
69 SET_ARRAY
70
71#define DECLARATION \
72 integer :: array(10) = 0, core(4) = [1, 2, 3, 4], halo = -1; \
73 integer(IK) :: coffset = 2;
74 SET_ARRAY
75
76 call disp%skip()
77 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
78 call disp%show("! Initialize matrix with core and halo values.")
79 call disp%show("!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%")
80 call disp%skip()
81
82#define DECLARATION \
83 integer :: array(10,10) = 0, core(2, 3) = reshape([1, 2, 3, 4, 5, 6], [2, 3]), halo = -1; \
84 integer(IK) :: coffset(rank(array)) = [5, 3];
85 SET_ARRAY
86
87#define DECLARATION \
88 logical :: array(10,10) = .false., core(3, 3) = reshape([(.false., i = 1, 9)], [3, 3]), halo = .true.; \
89 integer(IK) :: coffset(rank(array)) = [3, 5];
90 SET_ARRAY
91
92#define DECLARATION \
93 complex :: array(10,10) = 0, core(3, 3) = reshape([(i, i = 1, 9)], [3, 3]), halo = -1; \
94 integer(IK) :: coffset(rank(array)) = [3, 5];
95 SET_ARRAY
96
97#define DECLARATION \
98 real :: array(10,10) = 0, core(3, 3) = reshape([(i, i = 1, 9)], [3, 3]), halo = -1; \
99 integer(IK) :: coffset(rank(array)) = [3, 5];
100 SET_ARRAY
101
102end program example
pm_io::show
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
pm_io::skip
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
pm_io
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
pm_io::disp
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
pm_kind
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
pm_kind::RK
integer, parameter RK
The default real kind in the ParaMonte library: real64 in Fortran, c_double in C-Fortran Interoperati...
Definition: pm_kind.F90:543
pm_kind::LK
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
pm_kind::CK
integer, parameter CK
The default complex kind in the ParaMonte library: real64 in Fortran, c_double_complex in C-Fortran I...
Definition: pm_kind.F90:542
pm_kind::IK
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
pm_kind::SK
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
pm_io::display_type
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 ⛓
1
2!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3! Initialize scalar with core and halo values.
4!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
5
6array
7" "
8core
9"In God We Trust"
10halo
11"*"
12coffset
13"+3"
14call setCoreHalo(array, core, halo, coffset)
15array
16"***In God We Trust***"
17
18array
19" "
20core
21"In Science We Invest"
22halo
23"~"
24coffset
25"+2"
26call setCoreHalo(array, core, halo, coffset)
27array
28"~~In Science We Invest~~~~~~~~~~~~~~~~~~~"
29
30
31!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
32! Initialize vector with core and halo values.
33!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
34
35array
36" ", " ", " ", " ", " ", " ", " ", " ", " ", " "
37core
38"In ", "God ", "We ", "Trust"
39halo
40"*****"
41coffset
42"+3"
43call setCoreHalo(array, core, halo, coffset)
44array
45"*****", "*****", "*****", "In ", "God ", "We ", "Trust", "*****", "*****", "*****"
46
47array
48" ", " ", " ", " ", " ", " ", " ", " ", " ", " "
49core
50"In ", "Science", "We ", "Invest "
51halo
52"~~~~~~~"
53coffset
54"+3"
55call setCoreHalo(array, core, halo, coffset)
56array
57"~~~~~~~", "~~~~~~~", "~~~~~~~", "In ", "Science", "We ", "Invest ", "~~~~~~~", "~~~~~~~", "~~~~~~~"
58
59array
60"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
61core
62"+1", "+2", "+3", "+4"
63halo
64"-1"
65coffset
66"+2"
67call setCoreHalo(array, core, halo, coffset)
68array
69"-1", "-1", "+1", "+2", "+3", "+4", "-1", "-1", "-1", "-1"
70
71
72!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
73! Initialize matrix with core and halo values.
74!%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
75
76array
77"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
78"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
79"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
80"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
81"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
82"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
83"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
84"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
85"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
86"+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0", "+0"
87core
88"+1", "+3", "+5"
89"+2", "+4", "+6"
90halo
91"-1"
92coffset
93"+5", "+3"
94call setCoreHalo(array, core, halo, coffset)
95array
96"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
97"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
98"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
99"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
100"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
101"-1", "-1", "-1", "+1", "+3", "+5", "-1", "-1", "-1", "-1"
102"-1", "-1", "-1", "+2", "+4", "+6", "-1", "-1", "-1", "-1"
103"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
104"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
105"-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1", "-1"
106
107array
108"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
109"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
110"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
111"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
112"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
113"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
114"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
115"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
116"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
117"F", "F", "F", "F", "F", "F", "F", "F", "F", "F"
118core
119"F", "F", "F"
120"F", "F", "F"
121"F", "F", "F"
122halo
123"T"
124coffset
125"+3", "+5"
126call setCoreHalo(array, core, halo, coffset)
127array
128"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
129"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
130"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
131"T", "T", "T", "T", "T", "F", "F", "F", "T", "T"
132"T", "T", "T", "T", "T", "F", "F", "F", "T", "T"
133"T", "T", "T", "T", "T", "F", "F", "F", "T", "T"
134"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
135"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
136"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
137"T", "T", "T", "T", "T", "T", "T", "T", "T", "T"
138
139array
140"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
141"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
142"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
143"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
144"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
145"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
146"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
147"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
148"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
149"+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000", "+0.00000000, +0.00000000"
150core
151"+1.00000000, +0.00000000", "+4.00000000, +0.00000000", "+7.00000000, +0.00000000"
152"+2.00000000, +0.00000000", "+5.00000000, +0.00000000", "+8.00000000, +0.00000000"
153"+3.00000000, +0.00000000", "+6.00000000, +0.00000000", "+9.00000000, +0.00000000"
154halo
155"-1.00000000, +0.00000000"
156coffset
157"+3", "+5"
158call setCoreHalo(array, core, halo, coffset)
159array
160"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
161"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
162"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
163"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "+1.00000000, +0.00000000", "+4.00000000, +0.00000000", "+7.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
164"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "+2.00000000, +0.00000000", "+5.00000000, +0.00000000", "+8.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
165"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "+3.00000000, +0.00000000", "+6.00000000, +0.00000000", "+9.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
166"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
167"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
168"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
169"-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000", "-1.00000000, +0.00000000"
170
171array
172"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
173"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
174"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
175"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
176"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
177"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
178"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
179"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
180"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
181"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
182core
183"+1.00000000", "+4.00000000", "+7.00000000"
184"+2.00000000", "+5.00000000", "+8.00000000"
185"+3.00000000", "+6.00000000", "+9.00000000"
186halo
187"-1.00000000"
188coffset
189"+3", "+5"
190call setCoreHalo(array, core, halo, coffset)
191array
192"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
193"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
194"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
195"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "+1.00000000", "+4.00000000", "+7.00000000", "-1.00000000", "-1.00000000"
196"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "+2.00000000", "+5.00000000", "+8.00000000", "-1.00000000", "-1.00000000"
197"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "+3.00000000", "+6.00000000", "+9.00000000", "-1.00000000", "-1.00000000"
198"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
199"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
200"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
201"-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000", "-1.00000000"
202
203
Test:
test_pm_arrayInit
Todo:
Low Priority: This generic interface can be extended to array arguments of higher ranks.
Todo:
Critical Priority: The examples of this generic interface incorrectly call the functional interface.
This must be fixed before release of the library.
Todo:
Normal Priority: The current interface requires the input core to be contiguous when it is an array.
This restriction can be lifted by either removing the contiguous attribute of the argument or adding additional lbcore, ubcore subsetting arguments to the interface.
The former offers a simple yet powerful solution.
However, a benchmark must be done to investigate the performance penalty of switching the contiguous attribute off.


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 Austin

Definition at line 1504 of file pm_arrayInit.F90.

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