pm_matrixCopy Module Reference

This module contains procedures and generic interfaces relevant to copying (diagonal or upper/lower triangular) subsets of matrices of arbitrary intrinsic types and kinds from one matrix of arbitrary shape and packing format to another matrix of arbitrary shape and packing format.
More...

Data Types
interface	getMatCopy
	Generate and return a copy of a desired subset of the input source matrix of arbitrary shape (:) or (:,:) to the target subset of the output destin matrix of arbitrary shape (:) or (:,:). More...
interface	setMatCopy
	Copy a desired subset of the input source matrix of arbitrary shape (:) or (:,:) to the target subset of the output destin matrix of arbitrary shape (:) or (:,:). More...

Variables
character(*, SK), parameter	MODULE_NAME = "@pm_matrixCopy"

Detailed Description

This module contains procedures and generic interfaces relevant to copying (diagonal or upper/lower triangular) subsets of matrices of arbitrary intrinsic types and kinds from one matrix of arbitrary shape and packing format to another matrix of arbitrary shape and packing format.

The generic interfaces of this module are a shortcut for copying subsets of matrices and paste to another existing one.
While writing the loop is simple, such patterns occur frequently.
These generic interfaces offer a clean fast solution for copying subsets of matrices and pasting them to other matrices with arbitrary packing formats.

The following guidelines describe the various existing methods within the ParaMonte library for copying subsets of matrices.

• Use the generic interface setMatCopy(destin(:,:), source(:,:), subset = dia) to copy the diagonal elements of a rectangular subset of a matrix and paste it into the diagonal elements of a rectangular subset of another matrix.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), uppDia, doff) to copy the diagonal and upper triangular elements of a rectangular subset of a matrix and paste it into the diagonal and upper triangular elements of a rectangular subset of another matrix.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), lowDia, doff) to copy the diagonal and lower triangular elements of a rectangular subset of a matrix and paste it into the diagonal and lower triangular elements of a rectangular subset of another matrix.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), uppLow, doff) to copy the upper and lower triangular elements of a rectangular subset of a matrix and paste it into the upper and lower triangular elements of a rectangular subset of another matrix.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), uppDia, operation, doff) to copy the transpose of the diagonal and upper triangular elements of a rectangular subset of a matrix and paste it into the diagonal and lower triangular elements of a rectangular subset of another matrix.
  The argument operation can be either transSymm or transHerm.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), lowDia, operation, doff) to copy the transpose of the diagonal and lower triangular elements of a rectangular subset of a matrix and paste it into the diagonal and upper triangular elements of a rectangular subset of another matrix.
  The argument operation can be either transSymm or transHerm.
  
  
  
  
• Use the generic interface setMatCopy(destin(:,:), source(:,:), uppLow, operation, doff) to copy the transpose of the upper and lower triangular elements of a rectangular subset of a matrix and paste it into the lower and upper triangular elements of a rectangular subset of another matrix.
  The argument operation can be either transSymm or transHerm.
  
  
  
  

BLAS/LAPACK equivalent:

The procedures under discussion combine, modernize, and extend the interface and functionalities of Version 3.11 of BLAS/LAPACK routine(s): SLACPY, DLACPY, CLACPY, ZLACPY, CTPTTF, DTPTTF, STPTTF, ZTPTTF, CTRTTF, DTRTTF, STRTTF, ZTRTTF, CTFTTP, DTFTTP, STFTTP, ZTFTTP,, CTFTTR, DTFTTR, STFTTR, ZTFTTR.
In particular copying of subsets of character, integer, logical, as well as complex and real matrices are implemented as part of this module.
Furthermore, operations on the subset data to copy (such as symmetric transpose) are also implemented.

See also

pm_arrayCopy
pm_matrixCopy

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, Friday 1:54 AM, April 21, 2017, Institute for Computational Engineering and Sciences (ICES), The University of Texas, Austin, TX

Variable Documentation

MODULE_NAME

character(*, SK), parameter pm_matrixCopy::MODULE_NAME = "@pm_matrixCopy"

Definition at line 130 of file pm_matrixCopy.F90.