Generate and return .true.
if and only if a desired matrix with the specified input shape
is of the specified input packing pack
.
See pm_matrixPack for the mathematical definitions of different matrix packings.
Note that a matrix in RFP format can be either in normal (long) or transpose (wide) format.
This generic interface checks for both conditions to hold.
- Parameters
-
[in] | pack | : The input scalar constant that can be one of the following:
-
The scalar constant lfpack implying the matrix has the Rectangular Full Packing (RFP) format.
-
The scalar constant rfpack implying the matrix has the Rectangular Full Packing (RFP) format.
|
[in] | shape | : The input vector of length 2 of type integer of default kind IK, representing the shape of the desired matrix whose specific packing is to be confirmed.
This input argument can be et to the direct output of the intrinsic Fortran function shape() .
|
- Returns
itis
: The output scalar logical
of default kind LK that is .true.
if and only if the desired matrix with the specified input shape
has the specified input packing pack
.
Possible calling interfaces ⛓
Generate and return .true. if and only if a desired matrix with the specified input shape is of the s...
This module contains abstract and concrete derived types that are required for compile-time resolutio...
Example usage ⛓
12 integer(IK) :: i,
shape(
2)
13 type(display_type) :: disp
18 call disp%show(
"shape = getUnifRand(1_IK, 7_IK, 2_IK)")
22 call disp%show(
"isMatPack(rfpack, shape)")
Generate and return a scalar or a contiguous array of rank 1 of length s1 of randomly uniformly distr...
Verify the input assertion holds and if it does not, print the (optional) input message on stdout and...
Generate and return an object of type stop_type with the user-specified input attributes.
This is a generic method of the derived type display_type with pass attribute.
Generate and return the conversion of the input value to an output Fortran string,...
This module contains classes and procedures for computing various statistical quantities related to t...
This module contains classes and procedures for reporting and handling errors.
This module contains classes and procedures for input/output (IO) or generic display operations on st...
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
integer, parameter IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
type(rfpack_type), parameter rfpack
This is an object instance of class rfpack_type that is exclusively used to signify Rectangular Full ...
This module contains the generic procedures for converting values of different types and kinds to For...
Generate and return an object of type display_type.
Example Unix compile command via Intel ifort
compiler ⛓
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example Windows Batch compile command via Intel ifort
compiler ⛓
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
Example Unix / MinGW compile command via GNU gfortran
compiler ⛓
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
Example output ⛓
- Test:
- test_pm_matrixPack
Critical Priority: This generic interface must be extended to lfpack
format.
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.
-
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.
-
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, Monday March 6, 2017, 3:22 pm, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin.
Definition at line 525 of file pm_matrixPack.F90.