pm_distNorm::getNormEntropy Interface Reference

Generate and return the entropy of the Normal distribution with the input natural logarithm of the variance. More...

Detailed Description

Generate and return the entropy of the Normal distribution with the input natural logarithm of the variance.

The entropy of the Normal distribution is defined by the following equation,

\begin{equation} \large \mathcal{H}(\sigma^2) = \frac{1}{2} \log(2\pi\sigma^2) + \frac{1}{2} \end{equation}

Parameters

[in]

logVar

: The input scalar or array of arbitrary rank and shape, of the same type and kind as the output entropy, containing the natural logarithm of the variance of the Normal distribution.

Returns

entropy : The output scalar or array of the same rank and shape as the input logVar, of,

1. type real of kind any supported by the processor (e.g., RK, RK32, RK64, or RK128),

containing the entropy of the Normal distribution.

Possible calling interfaces ⛓

use pm_distNorm, only: getNormEntropy
 
entropy = getNormEntropy(logVar)

Remarks

The procedures under discussion are pure.

The procedures under discussion are elemental.

Example usage ⛓

program example
 
    use pm_io, only: display_type
    use pm_kind, only: IK, RKS, RKD, RKH
    use pm_distNorm, only: getNormEntropy
 
    implicit none
 
    type(display_type) :: disp
    disp = display_type(file = "main.out.F90")
 
    ! Inverse variance.
 
    call disp%skip()
    call disp%show("getNormEntropy(logVar = log([1., 2., 3.]))")
    call disp%show( getNormEntropy(logVar = log([1., 2., 3.])) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getNormEntropy(logVar = log(3.3))")
    call disp%show( getNormEntropy(logVar = log(3.3)) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getNormEntropy(logVar = log(3.3_RKS))")
    call disp%show( getNormEntropy(logVar = log(3.3_RKS)) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getNormEntropy(logVar = log(3.3_RKD))")
    call disp%show( getNormEntropy(logVar = log(3.3_RKD)) )
    call disp%skip()
 
    call disp%skip()
    call disp%show("getNormEntropy(logVar = log(3.3_RKH))")
    call disp%show( getNormEntropy(logVar = log(3.3_RKH)) )
    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 ⛓

 
getNormEntropy(logVar = log([1., 2., 3.]))
+1.41893852, +1.76551211, +1.96824467
 
 
getNormEntropy(logVar = log(3.3))
+2.01589966
 
 
getNormEntropy(logVar = log(3.3_RKS))
+2.01589966
 
 
getNormEntropy(logVar = log(3.3_RKD))
+2.0158997674408901
 
 
getNormEntropy(logVar = log(3.3_RKH))
+2.01589976744089001749992841650726308
 
 

Test:

test_pm_distNorm

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, Oct 16, 2009, 11:14 AM, Michigan

Definition at line 3688 of file pm_distNorm.F90.

---

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

• src/fortran/main/pm_distNorm.F90