pm_kind::modeli_type Type Reference

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

Inheritance diagram for pm_kind::modeli_type:

Collaboration diagram for pm_kind::modeli_type:

Public Attributes
integer(IKH)	huge
	The scalar integer of the highest kind IKH supported by the ParaMonte library, representing the largest value in the model that includes the integer data type of interest. 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 modeli_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 integer of kind any supported by the processor (e.g., IK, IK8, IK16, IK32, or IK64), or 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. modeli_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, modeli_type
class(modeln_type), allocatable :: modelNum
class(model_type), allocatable :: model
type(modeli_type) :: modelInt
 
modelInt = modeli_type(mold)
modelNum = modeli_type(mold)
model = modeli_type(mold)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

See also

model_type
modelb_type
modeln_type
modeli_type
modeli_type

Example usage ⛓

program example
 
    use pm_kind, only: SK, IK
    use pm_kind, only: modeli_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 => IKS
        type(modeli_type) :: model
        integer(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modeli_type(mold)")
                        model = modeli_type(mold)
        call disp%show("[model%digits, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%radix, model%range, model%storage_size] )
        call disp%show("model%huge")
        call disp%show( model%huge )
        call disp%skip()
    end block
 
    block
        use pm_kind, only: TKG => IKD
        type(modeli_type) :: model
        integer(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modeli_type(mold)")
                        model = modeli_type(mold)
        call disp%show("[model%digits, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%radix, model%range, model%storage_size] )
        call disp%show("model%huge")
        call disp%show( model%huge )
        call disp%skip()
    end block
 
    block
        use pm_kind, only: TKG => IKH
        type(modeli_type) :: model
        integer(TKG) :: mold
        call disp%skip()
        call disp%show("kind(mold)")
        call disp%show( kind(mold) )
        call disp%show("model = modeli_type(mold)")
                        model = modeli_type(mold)
        call disp%show("[model%digits, model%radix, model%range, model%storage_size]")
        call disp%show( [model%digits, model%radix, model%range, model%storage_size] )
        call disp%show("model%huge")
        call disp%show( model%huge )
        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 = modeli_type(mold)
[model%digits, model%radix, model%range, model%storage_size]
+31, +2, +9, +32
model%huge
+2147483647
 
 
kind(mold)
+8
model = modeli_type(mold)
[model%digits, model%radix, model%range, model%storage_size]
+63, +2, +18, +64
model%huge
+9223372036854775807
 
 
kind(mold)
+16
model = modeli_type(mold)
[model%digits, model%radix, model%range, model%storage_size]
+127, +2, +38, +128
model%huge
+170141183460469231731687303715884105727
 
 

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 at Austin

Definition at line 1615 of file pm_kind.F90.

Member Data Documentation

huge

integer(IKH) pm_kind::modeli_type::huge

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

Definition at line 1616 of file pm_kind.F90.

---

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

• src/fortran/main/pm_kind.F90