ParaMonte Fortran 2.0.0
Parallel Monte Carlo and Machine Learning Library
See the latest version documentation.
pm_mathLog1p Module Reference

This module contains procedures and generic interfaces for computing log(1 + x) more precisely for tiny x. More...

Data Types

interface  getLog1p
 Generate and return the expression log(1 + x) robustly (without numerical underflow). More...
 

Variables

character(*, SK), parameter MODULE_NAME = "@pm_mathLog1p"
 

Detailed Description

This module contains procedures and generic interfaces for computing log(1 + x) more precisely for tiny x.

This module is particularly useful for computing log(1 + x) when x is smaller than the computer precision of the desired real kind.
This precision is the value returned by the Fortran intrinsic epsilon() procedure.

See also
getLog1p
get1mexp
getLogAddExp
getLogSubExp
getLogSumExp


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.

Test:
test_pm_mathLog1p
Author:
Amir Shahmoradi, Thursday 1:45 AM, August 22, 2019, Dallas, TX

Variable Documentation

◆ MODULE_NAME

character(*, SK), parameter pm_mathLog1p::MODULE_NAME = "@pm_mathLog1p"

Definition at line 48 of file pm_mathLog1p.F90.