pm_kind::modelr_type Type Reference

This is the abstract derived type for creating objects of class modelr_type that contain the characteristics of the processor representation model used for the requested integer data object.
More...

Inheritance diagram for pm_kind::modelr_type:

Collaboration diagram for pm_kind::modelr_type:

Public Attributes
real(RKH)	epsilon
	The scalar real of the highest kind RKH supported by the ParaMonte library, whose value is almost negligible compared with the value 1.0 in the model that includes the real data type of interest, that is \(b^{1-p}\) as detailed in the real data model of model_type. More...
real(RKHR)	huge
	The scalar real of the highest kind RKHR supported by the ParaMonte library, representing the largest value in the model that includes the real data type of interest. More...
integer(IK)	maxexponent
	The scalar integer of default kind IK, representing the maximum exponent in the model that includes the real data type of interest. This corresponds to \(e_{max}\) in the model set for the real data type detailed in model_type. More...
integer(IK)	minexponent
	The scalar integer of default kind IK, representing the minimum exponent in the model that includes the real data type of interest. This corresponds to \(e_{min}\) in the model set for the real data type detailed in model_type. More...
integer(IK)	precision
	The scalar integer of default kind IK, representing the equivalent decimal precision (number of digits after the decimal point) in the model representing real numbers with the same type parameter value as the real data type of interest. The value is int((p - 1) * log10(b)) + k where k is 1 if b is an integral power of 10 and 0 otherwise. The meaning of the real data type model parameters are detailed in model_type. More...
real(RKHR)	tiny
	The scalar real of the highest kind RKHR supported by the ParaMonte library, representing the smallest positive number \(b^{e_min} - 1\) in the model that includes the real data type of interest. The meaning of the real data type model parameters are detailed in model_type. More...
Public Attributes inherited from pm_kind::modeln_type
integer(IK)	digits
	The scalar integer of default kind IK, whose value is the number of significant bit digits in the model that includes the numeric data type of interest, that is q or p in the integer and real models detailed in model_type. More...
integer(IK)	radix
	The scalar integer of default kind IK, whose value is the base in the model that includes the numeric data of interest, that is r or b in the integer and real models detailed in model_type. More...
integer(IK)	range
	The scalar integer of default kind IK, holding the equivalent decimal exponent range in the models representing integer or real data type of interest. The value is int(log10(huge)) for integer data type and int(min(log10(huge), -log10(tiny))) for real data type, where huge and tiny are the largest and smallest positive numbers in the corresponding model. More...
Public Attributes inherited from pm_kind::model_type
integer(IK)	kind
	The scalar integer of default kind IK, representing the processor-dependent kind type-parameter of data type of interest. More...
integer(IK)	storage_size
	The scalar integer of default kind IK, whose value is the size, in bits, that would be taken in memory by a scalar of the same type and kind as the data type of interest. More...

Detailed Description

This is the abstract derived type for creating objects of class modelr_type that contain the characteristics of the processor representation model used for the requested integer data object.

See the documentations of model_type for details of model sets for supported data types.

Parameters

[in]

mold

: The input scalar or array of arbitrary rank of either type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128), whose type and kind will determine the characteristics of the output model object. The specific value of the input mold is irrelevant and ignored.

Returns

model : The output scalar or array of type,

1. modelr_type,
   

containing the characteristics of the processor representation model used for the input data entity.

Possible calling interfaces ⛓

use pm_kind, only: model_type, modeln_type, modelr_type
type(modeln_type), allocatable :: modelNum
class(model_type), allocatable :: model
type(modelr_type) :: modelReal
 
modelReal = modelr_type(mold)
modelNum = modelr_type(mold)
model = modelr_type(mold)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

model_type
modeln_type
modeli_type
modelb_type
modelr_type

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_kind, only: modelr_type
    use pm_io, only: display_type
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    block
        use pm_kind, only: TKG => RKS
        type(modelr_type) :: model
        real(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modelr_type(mold)")
                        model = modelr_type(mold)
        call disp%show("[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size] )
        call disp%show("[model%epsilon, model%huge, model%tiny]")
        call disp%show( [model%epsilon, model%huge, model%tiny] )
        call disp%skip()
    end block
 
    block
        use pm_kind, only: TKG => RKD
        type(modelr_type) :: model
        real(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modelr_type(mold)")
                        model = modelr_type(mold)
        call disp%show("[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size] )
        call disp%show("[model%epsilon, model%huge, model%tiny]")
        call disp%show( [model%epsilon, model%huge, model%tiny] )
        call disp%skip()
    end block
 
    block
        use pm_kind, only: TKG => RKH
        type(modelr_type) :: model
        real(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modelr_type(mold)")
                        model = modelr_type(mold)
        call disp%show("[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size] )
        call disp%show("[model%epsilon, model%huge, model%tiny]")
        call disp%show( [model%epsilon, model%huge, model%tiny] )
        call disp%skip()
    end block
 
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 ⛓

 
kind(mold)
+4
model = modelr_type(mold)
[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]
+24, +128, -125, +6, +2, +37, +32
[model%epsilon, model%huge, model%tiny]
+0.119209289550781250000000000000000000E-6, +0.340282346638528859811704183484516925E+39, +0.117549435082228750796873653722224568E-37
 
 
kind(mold)
+8
model = modelr_type(mold)
[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]
+53, +1024, -1021, +15, +2, +307, +64
[model%epsilon, model%huge, model%tiny]
+0.222044604925031308084726333618164062E-15, +0.179769313486231570814527423731704357E+309, +0.222507385850720138309023271733240406E-307
 
 
kind(mold)
+16
model = modelr_type(mold)
[model%digits, model%maxexponent, model%minexponent, model%precision, model%radix, model%range, model%storage_size]
+113, +16384, -16381, +33, +2, +4931, +128
[model%epsilon, model%huge, model%tiny]
+0.192592994438723585305597794258492732E-33, +0.118973149535723176508575932662800702E+4933, +0.336210314311209350626267781732175260E-4931
 
 

Test:

test_pm_kind

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, 11:35 PM, Institute for Computational Engineering and Sciences (ICES), The University of Texas Austin

Definition at line 1746 of file pm_kind.F90.

Member Data Documentation

epsilon

real(RKH) pm_kind::modelr_type::epsilon

The scalar real of the highest kind RKH supported by the ParaMonte library, whose value is almost negligible compared with the value 1.0 in the model that includes the real data type of interest, that is \(b^{1-p}\) as detailed in the real data model of model_type.

Note

EPSILON makes it easy to select a delta for algorithms (such as root locators) that search until the calculation is within delta of an estimate.
If delta is too small (smaller than the decimal resolution of the data type), the algorithm might never halt.
By scaling the value returned by EPSILON to the estimate, you obtain a delta that ensures search termination.

Definition at line 1747 of file pm_kind.F90.

huge

real(RKHR) pm_kind::modelr_type::huge

The scalar real of the highest kind RKHR supported by the ParaMonte library, representing the largest value in the model that includes the real data type of interest.

Definition at line 1754 of file pm_kind.F90.

maxexponent

integer(IK) pm_kind::modelr_type::maxexponent

The scalar integer of default kind IK, representing the maximum exponent in the model that includes the real data type of interest.
This corresponds to \(e_{max}\) in the model set for the real data type detailed in model_type.

Definition at line 1756 of file pm_kind.F90.

minexponent

integer(IK) pm_kind::modelr_type::minexponent

The scalar integer of default kind IK, representing the minimum exponent in the model that includes the real data type of interest.
This corresponds to \(e_{min}\) in the model set for the real data type detailed in model_type.

Definition at line 1758 of file pm_kind.F90.

precision

integer(IK) pm_kind::modelr_type::precision

The scalar integer of default kind IK, representing the equivalent decimal precision (number of digits after the decimal point) in the model representing real numbers with the same type parameter value as the real data type of interest.
The value is int((p - 1) * log10(b)) + k where k is 1 if b is an integral power of 10 and 0 otherwise.
The meaning of the real data type model parameters are detailed in model_type.

Definition at line 1760 of file pm_kind.F90.

tiny

real(RKHR) pm_kind::modelr_type::tiny

The scalar real of the highest kind RKHR supported by the ParaMonte library, representing the smallest positive number \(b^{e_min} - 1\) in the model that includes the real data type of interest.
The meaning of the real data type model parameters are detailed in model_type.

Definition at line 1764 of file pm_kind.F90.

---

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

• src/fortran/main/pm_kind.F90