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 ⛓

use pm_complexDiv, only: getDiv
 
quotient = getDiv(dividend, divisor)

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 ⛓

program example
 
    use pm_kind, only: LK, SK
    use pm_kind, only: CKG => CKS ! all complex kinds are supported.
    use pm_complexDiv, only: getDiv
    use pm_io, only: display_type
 
    implicit none
 
    complex(CKG)    :: dividend, divisor, quotient
    real(CKG)       :: large
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show("dividend = (-1., -2.); divisor = (+1., +2.)")
                    dividend = (-1., -2.); divisor = (+1., +2.)
    call disp%show("quotient = getDiv(dividend, divisor)")
                    quotient = getDiv(dividend, divisor)
    call disp%show("[quotient, dividend / divisor]")
    call disp%show( [quotient, dividend / divisor] )
    call disp%skip()
 
    call disp%skip()
    call disp%show("large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)")
                    large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)
    call disp%show("quotient = getDiv(dividend, divisor)")
                    quotient = getDiv(dividend, divisor)
    call disp%show("[quotient, dividend / divisor]")
    call disp%show( [quotient, dividend / divisor] )
    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 ⛓

 
dividend = (-1., -2.); divisor = (+1., +2.)
quotient = getDiv(dividend, divisor)
[quotient, dividend / divisor]
(-1.00000000, +0.00000000), (-1.00000000, +0.00000000)
 
 
large = (huge(0._CKG))/2; dividend = cmplx(large, large, CKG); divisor = cmplx(large, large, CKG)
quotient = getDiv(dividend, divisor)
[quotient, dividend / divisor]
(+1.00000000, +0.00000000), (+1.00000000, +0.00000000)
 
 

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.

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

---

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

• src/fortran/main/pm_complexDiv.F90