pm_complexAbs::abs Interface Reference

Generate and return the component-wise absolute value of (both real and imaginary parts of) the input complex. More...

Detailed Description

Generate and return the component-wise absolute value of (both real and imaginary parts of) the input complex.

Parameters

[in]

val

: The input scalar or array of arbitrary rank of type complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128) whose elemental absolute value is to be returned.

Returns

absval : The output scalar or array of the same rank and shape as val whose real and imaginary parts are the absolute values of the corresponding real and imaginary parts of the input val.

Possible calling interfaces ⛓

use pm_complexAbs, only: abs
 
absval = abs(val) ! = (abs(val%re), abs(val%im))

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

pm_complexCompareAll
pm_complexCompareAny
pm_complexCompareLex

Example usage ⛓

program example
 
    use pm_kind, only: LK, SK
    use pm_complexAbs, only: abs
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("abs((-1., -2.))")
    call disp%show( abs((-1., -2.)) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)])")
    call disp%show( abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)]) )
    call disp%skip()
 
end program example

Example Unix compile command via Intel ifort compiler ⛓

#!/usr/bin/env sh
rm main.exe
ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example Windows Batch compile command via Intel ifort compiler ⛓

del main.exe
set PATH=..\..\..\lib;%PATH%
ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
main.exe

Example Unix / MinGW compile command via GNU gfortran compiler ⛓

#!/usr/bin/env sh
rm main.exe
gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
./main.exe

Example output ⛓

 
abs((-1., -2.))
(+1.00000000, +2.00000000)
 
 
abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)])
(+1.00000000, +2.00000000), (+3.00000000, +2.00000000), (+5.00000000, +2.00000000), (+7.00000000, +1.00000000)
 
 

Test:

test_pm_complexAbs

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 86 of file pm_complexAbs.F90.

---

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

• src/fortran/main/pm_complexAbs.F90