pm_arrayFill::getFilled Interface Reference

Generate and return an array of the specified rank and shape of arbitrary intrinsic type and kind with all its elements initialized to the user specified value.
More...

Detailed Description

Generate and return an array of the specified rank and shape of arbitrary intrinsic type and kind with all its elements initialized to the user specified value.

Parameters

[in]	val	: The input scalar of the same type and kind as the output array, containing the initialization value for the elements of the array.
[in]	s1	: The input scalar of type integer of default kind IK, representing the size of the output array along its first dimension.
[in]	s2	: The input scalar of type integer of default kind IK, representing the size of the output array array along its second dimension. (optional. It must be present if s3 is present.)
[in]	s3	: The input scalar of type integer of default kind IK, representing the size of the output array array along its third dimension. (optional. It can be present only if s2 is present.)

Returns

array : The output scalar of,

• type character of kind any supported by the processor (e.g., SK, SKA, SKD , or SKU) of the specified length type parameter size or,
  

the output array of rank 1, 2, or 3 of shape (s1) or (s1, s2) or (s1, s2, s3), 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 array is allocated and initialized to the requested input value.

Possible calling interfaces ⛓

use pm_arrayFill, only: getFilled
 
array = getFilled(val, s1) ! array(1:s1)
array = getFilled(val, s1, s2) ! array(1:s1, 1:s2)
array = getFilled(val, s1, s2, s3) ! array(1:s1, 1:s2, 1:s3)
!

Warning

The condition 0 <= s1 must hold for the corresponding input arguments.
The condition 0 <= s2 must hold for the corresponding input arguments.
The condition 0 <= s3 must hold for the corresponding input arguments.
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

This generic interface is merely a convenient functional around the Fortran allocate statement.
There is no reason to use this generic interface in performance-critical applications.

See also

getMatInit
getCoreHalo
setCoreHalo
setResized
setRebound
setRebilled
setRefilled
getCentered
setCentered
getPadded
setPadded

Example usage ⛓

program example
 
    use pm_kind, only: LK
    use pm_kind, only: SK ! All kinds are supported.
    use pm_kind, only: IK ! All kinds are supported.
    use pm_kind, only: CK ! All kinds are supported.
    use pm_kind, only: RK ! All kinds are supported.
    use pm_io, only: display_type
    use pm_arrayFill, only: getFilled
 
    implicit none
 
    integer(IK) :: i
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%show("getFilled(0., 5)")
    call disp%show( getFilled(0., 5) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled(0.d0, 5, 4, 3)")
    call disp%show( getFilled(0.d0, 5, 4, 3) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled('AZ', 4, 5)")
    call disp%show( getFilled('AZ', 4, 5) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled(.false., 4, 5, 0)")
    call disp%show( getFilled(.false., 4, 5, 0) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled(.false., 4, 5, 1)")
    call disp%show( getFilled(.false., 4, 5, 1) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled(333, 2, 5)")
    call disp%show( getFilled(333, 2, 5) , deliml = SK_"""" )
    call disp%skip()
 
    call disp%show("getFilled((0., 1.), 5, 3)")
    call disp%show( getFilled((0., 1.), 5, 3) , 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 ⛓

getFilled(0., 5)
"+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000", "+0.00000000"
 
getFilled(0.d0, 5, 4, 3)
slice(:,:,1) = 
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
slice(:,:,2) = 
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
slice(:,:,3) = 
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
"+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000", "+0.0000000000000000"
 
getFilled('AZ', 4, 5)
"AZ", "AZ", "AZ", "AZ", "AZ"
"AZ", "AZ", "AZ", "AZ", "AZ"
"AZ", "AZ", "AZ", "AZ", "AZ"
"AZ", "AZ", "AZ", "AZ", "AZ"
 
getFilled(.false., 4, 5, 0)
 
getFilled(.false., 4, 5, 1)
slice(:,:,1) = 
"F", "F", "F", "F", "F"
"F", "F", "F", "F", "F"
"F", "F", "F", "F", "F"
"F", "F", "F", "F", "F"
 
getFilled(333, 2, 5)
"+333", "+333", "+333", "+333", "+333"
"+333", "+333", "+333", "+333", "+333"
 
getFilled((0., 1.), 5, 3)
"+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, +1.00000000", "+0.00000000, +1.00000000", "+0.00000000, +1.00000000"
"+0.00000000, +1.00000000", "+0.00000000, +1.00000000", "+0.00000000, +1.00000000"
 
 

Test:

test_pm_arrayFill

Todo:

Low Priority: This generic interface can be extended to array arguments of higher ranks.

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 132 of file pm_arrayFill.F90.

---

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

• src/fortran/main/pm_arrayFill.F90