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

This module contains procedures and generic interfaces for computing the previous/next integer exponent for the given base that yields a number smaller/larger than the absolute input value. More...

Data Types

interface  getExpNext
 Generate the next integer exponent expNext for the specified input base and absolute value absx = abs(x) such that the condition absx <= base**expNext holds. More...
 
interface  getExpPrev
 Generate the previous integer exponent expPrev for the specified input base and absolute value absx = abs(x) such that the condition base**expPrev <= absx holds. More...
 
interface  isIntPow
 Generate and return .true. if and only if the input positive integer is a whole-number (integer) power of the specified integer base. More...
 

Variables

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

Detailed Description

This module contains procedures and generic interfaces for computing the previous/next integer exponent for the given base that yields a number smaller/larger than the absolute input value.

For a given number \(x\) and base \(b\), the next integer exponent \(p\) is defined as the smallest integer such that,

\begin{equation} b^{(p - 1)} < |x| \leq b^p ~~~ \forall x > 0 ~, \end{equation}

Note
The functionalities of this module are useful in computing the padded lengths of arrays whose auto-correlation, cross-correlation, or Fourier-Transform are to be computed using the Fast-Fourier Transform method.
See also
pm_fftpack
Test:
test_pm_mathExp


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 25, 2015, 2:21 PM, National Institute for Fusion Studies, The University of Texas Austin

Variable Documentation

◆ MODULE_NAME

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

Definition at line 50 of file pm_mathExp.F90.