ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_matrixTrans Module Reference

This module contains abstract and concrete derived types and procedures related to various common matrix transposition operations for which there is a corresponding matrix class defined in pm_matrixClass.
More...

Data Types

interface  setMatTrans
 Generate and return the transpose of the input matrix of arbitrary type and kind using a cache-oblivious approach.
More...
 
type  trans_type
 This is a derived type for constructing concrete derived types to distinguish various procedure signatures that require different forms of transposition (Symmetric, Hermitian, ...).
More...
 
type  transHerm_type
 This is a concrete derived type whose instances are exclusively used to request Hermitian (conjugate) transpose ( \(\cdot^H\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type  transHermSkew_type
 This is a concrete derived type whose instances are exclusively used to request Skew-Hermitian transpose ( \(-\cdot^H\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type  transOrth_type
 This is a concrete derived type whose instances are exclusively used to request Orthogonal Transpose ( \(\cdot^-T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type  transSymm_type
 This is a concrete derived type whose instances are exclusively used to request Symmetric transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type  transSymmSkew_type
 This is a concrete derived type whose instances are exclusively used to request Skew-Symmetric transpose ( \(-\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type  transUnit_type
 This is a concrete derived type whose instances are exclusively used to request Unitary Transpose ( \(\cdot^{-H}\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 

Variables

character(*, SK), parameter MODULE_NAME = "@pm_matrixTrans"
 
type(trans_type), parameter trans = trans_type()
 This is a scalar parameter object of type trans_type that is exclusively used to request no transpose of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transSymm_type), parameter transSymm = transSymm_type()
 This is a scalar parameter object of type transSymm_type that is exclusively used to request Symmetric transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transHerm_type), parameter transHerm = transHerm_type()
 This is a scalar parameter object of type transHerm_type that is exclusively used to request Hermitian (conjugate) transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transOrth_type), parameter transOrth = transOrth_type()
 This is a scalar parameter object of type transOrth_type that is exclusively used to request Orthogonal Transpose ( \(\cdot^-T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transUnit_type), parameter transUnit = transUnit_type()
 This is a scalar parameter object of type transUnit_type that is exclusively used to request Unitary Transpose ( \(\cdot^{-H}\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transSymmSkew_type), parameter transSymmSkew = transSymmSkew_type()
 This is a scalar parameter object of type transSymmSkew_type that is exclusively used to request Skew-Symmetric transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 
type(transHermSkew_type), parameter transHermSkew = transHermSkew_type()
 This is a scalar parameter object of type transHermSkew_type that is exclusively used to request Skew-Hermitian transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.
More...
 

Detailed Description

This module contains abstract and concrete derived types and procedures related to various common matrix transposition operations for which there is a corresponding matrix class defined in pm_matrixClass.

There are a myriad of operations that can be applied to modify matrices, for example, matrix addition, scalar multiplication, transposition, matrix multiplication, row operations, and submatrix.
The entities and derived types of this module currently focus on operations that are required for compile-time resolution of procedures within the generic interfaces of the ParaMonte library for Linear Algebra operations.
Such procedures frequently need to work on either an Identical, Inverse, Symmetric transpose, Hermitian transpose, Orthogonal Transpose, Unitary transpose, or other forms of some of their input matrix arguments.

Transposition operation

In linear algebra, the transpose of a matrix is an operator which flips a matrix over its diagonal.
It switches the row and column indices of a given matrix \(A\) by producing another (transposed) matrix.
The transpose of a matrix was introduced in 1858 by the British mathematician Arthur Cayley.

Notation
The transpose of a given matrix \(A\) is frequently denoted by \(A^T\).
In the case of square matrices, \(A^T\) may also denote the \(T\)th power of the matrix \(A\).
To avoid a possible confusion, some use left upperscripts to denote transpose, that is, \({}^TA\).
An advantage of this notation is that no parentheses are needed when exponents are involved as \(({}^TA)^n = {}^T(A^n)\), notation \({}^TA^n\) is not ambiguous.

Definition
The transpose of a matrix \(A\) may be constructed by any one of the following methods,

  1. Reflect \(A\) over its main diagonal (which runs from top-left to bottom-right) to obtain \(A^T\).
  2. Write the rows of \(A\) as the columns of \(A^T\).
  3. Write the columns of \(A\) as the rows of \(A^T\).

Formally, the \(i\)-th row, \(j\)-th column element of \(A^T\) is the \(j\)-th row, \(i\)-th column element of \(A\),

\begin{equation} \left[\mathbf{A}^{\up{T}}\right]_{ij} = \left[\mathbf{A} \right]_{ji} ~. \end{equation}

If \(A\) is an \(m \times n\) matrix, then \(A^T\) is an \(n \times m\) matrix.

Matrix transposition types and correspondence to matrix classes:

  1. Symmetric transposition
    A square matrix whose transpose is equal to itself is called a Symmetric matrix.
    In other words, \(A\) is Symmetric if \(\mathbf{A}^{\up{T}} = \mathbf{A}\).
    The corresponding transposition is called Symmetric denoted by the operator \(\cdot^{\up{T}}\).
  2. Skew-Symmetric transposition
    A square matrix whose transpose is equal to its negative is called a Skew-Symmetric matrix In other words, \(A\) is Skew-Symmetric if \(\mathbf{A}^{\up{T}} = -\mathbf{A}\).
    The corresponding transposition is called Skew-Symmetric denoted by the operator \(-\cdot^{\up{T}}\).
  3. Hermitian transposition
    A square complex matrix whose transpose equals the matrix with every entry replaced by its complex conjugate ( \(\overline{\cdot}\)) is called a Hermitian matrix.
    In other words, \(A\) is Hermitian if \(\mathbf{A}^{\up{T}} = \overline{\mathbf{A}}\).
    The corresponding transposition is called Hermitian (Conjugate) denoted by the operator \(\cdot^{\up{H}}\).
  4. Skew-Hermitian transposition
    A square complex matrix whose transpose is equal to the negation of its complex conjugate is called a Skew-Hermitian matrix.
    In other words, \(A\) is Skew-Hermitian if \(\mathbf{A}^{\up{T}} = -{\overline{\mathbf{A}}}\).
    The corresponding transposition is called Skew-Hermitian (Skew-Conjugate) denoted by the operator \(-\cdot^{\up{H}}\).

Inversion-Transposition operation

There are also special matrix operations that mix inversion with Symmetric and Hermitian each having a corresponding matrix classes:**

  1. Orthogonal Transposition
    A square matrix whose transpose is equal to its inverse is called an Orthogonal matrix.
    In other words, \(A\) is Orthogonal if \(\mathbf{A}^{\up{T}} = \mathbf{A}^{-1}\).
    The corresponding transposition is called Orthogonal denoted by the operator \(\cdot^{\up{-T}}\).
  2. Unitary transposition
    A square complex matrix whose transpose is equal to its conjugate inverse is called a Unitary matrix.
    In other words, \(A\) is Unitary if \(\mathbf{A}^{\up{H}} = {\overline{\mathbf{A}^{-1}}}\).
    The corresponding transposition is called Unitary denoted by the operator \(\cdot^{\up{-H}}\).


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Variable Documentation

◆ MODULE_NAME

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

Definition at line 123 of file pm_matrixTrans.F90.

◆ trans

type(trans_type), parameter pm_matrixTrans::trans = trans_type()

This is a scalar parameter object of type trans_type that is exclusively used to request no transpose of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 185 of file pm_matrixTrans.F90.

◆ transHerm

type(transHerm_type), parameter pm_matrixTrans::transHerm = transHerm_type()

This is a scalar parameter object of type transHerm_type that is exclusively used to request Hermitian (conjugate) transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type
nothing


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 328 of file pm_matrixTrans.F90.

◆ transHermSkew

type(transHermSkew_type), parameter pm_matrixTrans::transHermSkew = transHermSkew_type()

This is a scalar parameter object of type transHermSkew_type that is exclusively used to request Skew-Hermitian transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 612 of file pm_matrixTrans.F90.

◆ transOrth

type(transOrth_type), parameter pm_matrixTrans::transOrth = transOrth_type()

This is a scalar parameter object of type transOrth_type that is exclusively used to request Orthogonal Transpose ( \(\cdot^-T\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 399 of file pm_matrixTrans.F90.

◆ transSymm

type(transSymm_type), parameter pm_matrixTrans::transSymm = transSymm_type()

This is a scalar parameter object of type transSymm_type that is exclusively used to request Symmetric transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 256 of file pm_matrixTrans.F90.

◆ transSymmSkew

type(transSymmSkew_type), parameter pm_matrixTrans::transSymmSkew = transSymmSkew_type()

This is a scalar parameter object of type transSymmSkew_type that is exclusively used to request Skew-Symmetric transpose ( \(\cdot^T\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 541 of file pm_matrixTrans.F90.

◆ transUnit

type(transUnit_type), parameter pm_matrixTrans::transUnit = transUnit_type()

This is a scalar parameter object of type transUnit_type that is exclusively used to request Unitary Transpose ( \(\cdot^{-H}\)) of a given matrix within an interface of a procedure of the ParaMonte library.

For example usage, see the documentation of the target procedure requiring this object.

See also
trans
transSymm
transHerm
transOrth
transUnit
transSymmSkew
transHermSkew
transSymm_type
transHerm_type
transOrth_type
transUnit_type
transSymmSkew_type
transHermSkew_type
trans_type


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:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 470 of file pm_matrixTrans.F90.