pm_mathSubAdd::operator(.subadd.) Interface Reference

Generate and return the result of applying the mathematical unary or binary operator \(\mp\) to the input argument(s). More...

Detailed Description

Generate and return the result of applying the mathematical unary or binary operator \(\mp\) to the input argument(s).

Given two input arguments ref and val, the procedures of this generic interface return an array of size 2 whose elements are [ref - val, ref + val].
If ref is missing, then an appropriate default value is used.

Parameters

[in]	ref	: The input scalar of the same type and kind as the input val, representing the reference value in the operation. (optional, default = 0.)
[in]	val	: The input scalar of type integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64), or type complex of kind any supported by the processor (e.g., CK, CK32, CK64, or CK128), or type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), representing the value upon which the operator \(\mp\) will act.

Returns

binval : The output vector of size 2 of the same type and kind as val, containing the result of the \(\mp\) operation.

Possible calling interfaces ⛓

use pm_mathSubAdd, only: operator(.subadd.)
 
binval(1:2) = .subadd. val
binval(1:2) = ref .subadd. val

Remarks

The procedures under discussion are pure.

Note

The procedures of this module offer a handy and flexible way of membership checks via operator(.inrange.).

The operator \(\mp\) performs the opposite operation of \(\mp\), that is, \(\pm = -\mp\).

See also

operator(.divmul.)
operator(.subadd.)
operator(.allin.)
operator(.anyin.)
operator(.inrange.)
operator(.anyinrange.)
operator(.allinrange.)
operator(.in.)
getMinMax
setMinMax

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK, RKH ! all intrinsic types and kinds are supported.
    use pm_io, only: display_type
    use pm_mathSubAdd, only: operator(.subadd.)
 
    implicit none
 
    type(display_type) :: disp
 
    disp = display_type(file = "main.out.F90")
 
    call disp%skip()
    call disp%show(".subadd. 5")
    call disp%show( .subadd. 5 )
    call disp%skip()
 
    call disp%skip()
    call disp%show("5 .subadd. 5")
    call disp%show( 5 .subadd. 5 )
    call disp%skip()
 
    call disp%skip()
    call disp%show(".subadd. 5.")
    call disp%show( .subadd. 5. )
    call disp%skip()
 
    call disp%skip()
    call disp%show("5.d0 .subadd. 5.d0")
    call disp%show( 5.d0 .subadd. 5.d0 )
    call disp%skip()
 
    call disp%skip()
    call disp%show(".subadd. (5., -5.)")
    call disp%show( .subadd. (5., -5.) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("(5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH)")
    call disp%show( (5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH) )
    call disp%skip()
 
    call disp%skip()
    call disp%show(".subadd. huge(0)")
    call disp%show( .subadd. huge(0) )
    call disp%skip()
 
    call disp%skip()
    call disp%show(".subadd. huge(0.)")
    call disp%show( .subadd. huge(0.) )
    call disp%skip()
 
    call disp%skip()
    call disp%show(".subadd. cmplx(huge(0.), huge(0.))")
    call disp%show( .subadd. cmplx(huge(0.), huge(0.)) )
    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 ⛓

 
.subadd. 5
-5, +5
 
 
5 .subadd. 5
+0, +10
 
 
.subadd. 5.
-5.00000000, +5.00000000
 
 
5.d0 .subadd. 5.d0
+0.0000000000000000, +10.000000000000000
 
 
.subadd. (5., -5.)
(-5.00000000, +5.00000000), (+5.00000000, -5.00000000)
 
 
(5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH)
(+0.00000000000000000000000000000000000, +0.00000000000000000000000000000000000), (+10.0000000000000000000000000000000000, -10.0000000000000000000000000000000000)
 
 
.subadd. huge(0)
-2147483647, +2147483647
 
 
.subadd. huge(0.)
-0.340282347E+39, +0.340282347E+39
 
 
.subadd. cmplx(huge(0.), huge(0.))
(-0.340282347E+39, -0.340282347E+39), (+0.340282347E+39, +0.340282347E+39)
 
 

Test:

test_pm_mathSubAdd

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, April 23, 2017, 1:36 AM, Institute for Computational Engineering and Sciences (ICES), University of Texas at Austin

Definition at line 141 of file pm_mathSubAdd.F90.

---

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

• src/fortran/main/pm_mathSubAdd.F90