ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
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))
Generate and return the component-wise absolute value of (both real and imaginary parts of) the input...
This module contains procedures and generic interfaces for performing element-wise comparison of the ...
Remarks
The procedures under discussion are pure.
The procedures under discussion are elemental.
See also
pm_complexCompareAll
pm_complexCompareAny
pm_complexCompareLex


Example usage

1program example
2
3 use pm_kind, only: LK, SK
4 use pm_complexAbs, only: abs
5 use pm_io, only: display_type
6
7 implicit none
8
9 type(display_type) :: disp
10
11 disp = display_type(file = "main.out.F90")
12
13 call disp%skip()
14 call disp%show("abs((-1., -2.))")
15 call disp%show( abs((-1., -2.)) )
16 call disp%skip()
17
18 call disp%skip()
19 call disp%show("abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)])")
20 call disp%show( abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)]) )
21 call disp%skip()
22
23end program example
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11726
This is a generic method of the derived type display_type with pass attribute.
Definition: pm_io.F90:11508
This module contains classes and procedures for input/output (IO) or generic display operations on st...
Definition: pm_io.F90:252
type(display_type) disp
This is a scalar module variable an object of type display_type for general display.
Definition: pm_io.F90:11393
This module defines the relevant Fortran kind type-parameters frequently used in the ParaMonte librar...
Definition: pm_kind.F90:268
integer, parameter LK
The default logical kind in the ParaMonte library: kind(.true.) in Fortran, kind(....
Definition: pm_kind.F90:541
integer, parameter SK
The default character kind in the ParaMonte library: kind("a") in Fortran, c_char in C-Fortran Intero...
Definition: pm_kind.F90:539
Generate and return an object of type display_type.
Definition: pm_io.F90:10282

Example Unix compile command via Intel ifort compiler
1#!/usr/bin/env sh
2rm main.exe
3ifort -fpp -standard-semantics -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example Windows Batch compile command via Intel ifort compiler
1del main.exe
2set PATH=..\..\..\lib;%PATH%
3ifort /fpp /standard-semantics /O3 /I:..\..\..\include main.F90 ..\..\..\lib\libparamonte*.lib /exe:main.exe
4main.exe

Example Unix / MinGW compile command via GNU gfortran compiler
1#!/usr/bin/env sh
2rm main.exe
3gfortran -cpp -ffree-line-length-none -O3 -Wl,-rpath,../../../lib -I../../../inc main.F90 ../../../lib/libparamonte* -o main.exe
4./main.exe

Example output
1
2abs((-1., -2.))
3(+1.00000000, +2.00000000)
4
5
6abs([(-1., -2.), (-3., +2.), (+5., -2.), (+7., +1.)])
7(+1.00000000, +2.00000000), (+3.00000000, +2.00000000), (+5.00000000, +2.00000000), (+7.00000000, +1.00000000)
8
9
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.

Author:
Amir Shahmoradi, September 1, 2017, 12:00 AM, Institute for Computational Engineering and Sciences (ICES), The University of Texas at Austin

Definition at line 86 of file pm_complexAbs.F90.


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