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

Generate and return the complex division of the two input complex values robustly without potential overflow caused by the computing the modulus of the divisor in the denominator of the result.
More...

Detailed Description

Generate and return the complex division of the two input complex values robustly without potential overflow caused by the computing the modulus of the divisor in the denominator of the result.

Parameters
[in]dividend: The input scalar or (array of the same shape as other array-like input arguments) of type complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128), representing the numerator of the division.
[in]divisor: The input scalar or (array of the same shape as other array-like input arguments) of same type and kind as dividend, representing the denominator of the division.
Returns
quotient : The input scalar or (array of the same shape as other array-like input arguments) of same type and kind as dividend, representing the complex division result.


Possible calling interfaces

quotient = getDiv(dividend, divisor)
Generate and return the complex division of the two input complex values robustly without potential o...
This module contains procedures and generic interfaces for computing the complex division robustly wi...
Warning
The condition divisor /= (0._CKG, 0._CKG) must hold for the corresponding input arguments.
This condition is verified only if the library is built with the preprocessor macro CHECK_ENABLED=1.
The pure procedure(s) documented herein become impure when the ParaMonte library is compiled with preprocessor macro CHECK_ENABLED=1.
By default, these procedures are pure in release build and impure in debug and testing builds.
Remarks
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_kind, only: CKG => CKS ! all complex kinds are supported.
5 use pm_complexDiv, only: getDiv
6 use pm_io, only: display_type
7
8 implicit none
9
10 complex(CKG) :: dividend, divisor, quotient
11 real(CKG) :: large
12
13 type(display_type) :: disp
14 disp = display_type(file = "main.out.F90")
15
16 call disp%skip()
17 call disp%show("dividend = (-1., -2.); divisor = (+1., +2.)")
18 dividend = (-1., -2.); divisor = (+1., +2.)
19 call disp%show("quotient = getDiv(dividend, divisor)")
20 quotient = getDiv(dividend, divisor)
21 call disp%show("[quotient, dividend / divisor]")
22 call disp%show( [quotient, dividend / divisor] )
23 call disp%skip()
24
25 call disp%skip()
26 call disp%show("large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)")
27 large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)
28 call disp%show("quotient = getDiv(dividend, divisor)")
29 quotient = getDiv(dividend, divisor)
30 call disp%show("[quotient, dividend / divisor]")
31 call disp%show( [quotient, dividend / divisor] )
32 call disp%skip()
33
34end 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 CKS
The single-precision complex kind in Fortran mode. On most platforms, this is a 32-bit real kind.
Definition: pm_kind.F90:570
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
2dividend = (-1., -2.); divisor = (+1., +2.)
3quotient = getDiv(dividend, divisor)
4[quotient, dividend / divisor]
5(-1.00000000, +0.00000000), (-1.00000000, +0.00000000)
6
7
8large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)
9quotient = getDiv(dividend, divisor)
10[quotient, dividend / divisor]
11(+1.00000000, +0.00000000), (+1.00000000, +0.00000000)
12
13
Test:
test_pm_complexDiv


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 91 of file pm_complexDiv.F90.


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