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

Generate and return the objects representing the symmetric mirror subset of the input matrix subset sub with respect to the main diagonal of the matrix. More...

Detailed Description

Generate and return the objects representing the symmetric mirror subset of the input matrix subset sub with respect to the main diagonal of the matrix.

Parameters
[in]sub: The input scalar (or array of arbitrary rank and shape) of,
  1. type upp_type,
  2. type low_type,
  3. type dia_type,
  4. type uppDia_type,
  5. type lowDia_type,
  6. type uppLow_type,
  7. type uppLowDia_type,
Returns
subSymm : The output object of the same rank and shape as the input subset sub whose type represents the matrix subset corresponding to the symmetric mirror subset of the input subset sub with respect to the main diagonal of the matrix.
  1. If sub is of type upp_type, then the output subSymm is of type low_type.
  2. If sub is of type low_type, then the output subSymm is of type upp_type.
  3. If sub is of type dia_type, then the output subSymm is of type dia_type.
  4. If sub is of type uppDia_type, then the output subSymm is of type lowDia_type.
  5. If sub is of type lowDia_type, then the output subSymm is of type uppDia_type.
  6. If sub is of type uppLow_type, then the output subSymm is of type uppLow_type.
  7. If sub is of type uppLowDia_type, then the output subSymm is of type uppLowDia_type.


Possible calling interfaces ⛓

use pm_matrixSubset, only: getSubSymm
subSymm(..) = getSubSymm(sub(..))
pm_matrixSubset::getSubSymm
Generate and return the objects representing the symmetric mirror subset of the input matrix subset s...
Definition: pm_matrixSubset.F90:740
pm_matrixSubset
This module contains abstract and concrete derived types that are required for compile-time resolutio...
Definition: pm_matrixSubset.F90:39
Remarks
The procedures under discussion are pure.
The procedures under discussion are elemental.
See also
getSubComp
getSubSymm
getSubUnion


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 740 of file pm_matrixSubset.F90.

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