pm_complexCompareLex Module Reference

This module contains procedures and generic interfaces for checking if a complex number is lexicographically comparable to another complex number of the same kind.
More...

Data Types
interface	operator(<)
	Generate and return .true. if the real and imaginary components of the input complex argument val1 are lexicographically less than the corresponding components of the input complex argument val2. More...
interface	operator(<=)
	Generate and return .true. if the real and imaginary components of the input complex argument val1 are lexicographically less than or equal to the corresponding components of the input complex argument val2. More...
interface	operator(>)
	Generate and return .true. if the real and imaginary components of the input complex argument val1 are lexicographically more than the corresponding components of the input complex argument val2. More...
interface	operator(>=)
	Generate and return .true. if the real and imaginary components of the input complex argument val1 are lexicographically more than or equal to the corresponding components of the input complex argument val2. More...

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

Detailed Description

This module contains procedures and generic interfaces for checking if a complex number is lexicographically comparable to another complex number of the same kind.

The two components of complex numbers are compared lexically.
For example, (1.,2.) < (1.,1.) evaluates to .false. while (1.,2.) < (2.,0.) evaluates to .true..

A lexicographical comparison is the kind of comparison generally used to sort words alphabetically in dictionaries.
It involves comparing sequentially the elements that have the same position in both ranges against each other until one element is not equivalent to the other.
The result of comparing these first non-matching elements is the result of the lexicographical comparison.

Remarks

An example of a lexicographical comparison is the intrinsic comparison of two scalar characters in the Fortran programming language.

The primary purpose of the procedures in this module is to provide a convenient set of relational operators for generic programming.
Such use cases frequently occur in various library testing scenarios.

Test:

test_pm_complexCompareLex

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 at Austin

Variable Documentation

MODULE_NAME

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

Definition at line 51 of file pm_complexCompareLex.F90.