ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
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
This module contains procedures and generic interfaces for evaluating the mathematical operator acti...
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

1program example
2
3 use pm_kind, only: SK, IK, RKH ! all intrinsic types and kinds are supported.
4 use pm_io, only: display_type
5 use pm_mathSubAdd, only: operator(.subadd.)
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(".subadd. 5")
15 call disp%show( .subadd. 5 )
16 call disp%skip()
17
18 call disp%skip()
19 call disp%show("5 .subadd. 5")
20 call disp%show( 5 .subadd. 5 )
21 call disp%skip()
22
23 call disp%skip()
24 call disp%show(".subadd. 5.")
25 call disp%show( .subadd. 5. )
26 call disp%skip()
27
28 call disp%skip()
29 call disp%show("5.d0 .subadd. 5.d0")
30 call disp%show( 5.d0 .subadd. 5.d0 )
31 call disp%skip()
32
33 call disp%skip()
34 call disp%show(".subadd. (5., -5.)")
35 call disp%show( .subadd. (5., -5.) )
36 call disp%skip()
37
38 call disp%skip()
39 call disp%show("(5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH)")
40 call disp%show( (5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH) )
41 call disp%skip()
42
43 call disp%skip()
44 call disp%show(".subadd. huge(0)")
45 call disp%show( .subadd. huge(0) )
46 call disp%skip()
47
48 call disp%skip()
49 call disp%show(".subadd. huge(0.)")
50 call disp%show( .subadd. huge(0.) )
51 call disp%skip()
52
53 call disp%skip()
54 call disp%show(".subadd. cmplx(huge(0.), huge(0.))")
55 call disp%show( .subadd. cmplx(huge(0.), huge(0.)) )
56 call disp%skip()
57
58end 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 IK
The default integer kind in the ParaMonte library: int32 in Fortran, c_int32_t in C-Fortran Interoper...
Definition: pm_kind.F90:540
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
integer, parameter RKH
The scalar integer constant of intrinsic default kind, representing the highest-precision real kind t...
Definition: pm_kind.F90:858
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
2.subadd. 5
3-5, +5
4
5
65 .subadd. 5
7+0, +10
8
9
10.subadd. 5.
11-5.00000000, +5.00000000
12
13
145.d0 .subadd. 5.d0
15+0.0000000000000000, +10.000000000000000
16
17
18.subadd. (5., -5.)
19(-5.00000000, +5.00000000), (+5.00000000, -5.00000000)
20
21
22(5._RKH, -5._RKH) .subadd. (5._RKH, -5._RKH)
23(+0.00000000000000000000000000000000000, +0.00000000000000000000000000000000000), (+10.0000000000000000000000000000000000, -10.0000000000000000000000000000000000)
24
25
26.subadd. huge(0)
27-2147483647, +2147483647
28
29
30.subadd. huge(0.)
31-0.340282347E+39, +0.340282347E+39
32
33
34.subadd. cmplx(huge(0.), huge(0.))
35(-0.340282347E+39, -0.340282347E+39), (+0.340282347E+39, +0.340282347E+39)
36
37
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.

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: