Package 'nakagami'

Title: Functions for the Nakagami Distribution
Description: Density, distribution function, quantile function and random generation for the Nakagami distribution of Nakagami (1960) <doi:10.1016/B978-0-08-009306-2.50005-4>.
Authors: Jonas Moss [aut, cre]
Maintainer: Jonas Moss <[email protected]>
License: MIT + file LICENSE
Version: 1.0.0
Built: 2025-01-31 02:53:15 UTC
Source: https://github.com/jonasmoss/nakagami

Help Index


The Nakagami Density

Description

Density, distribution function, quantile function and random generation for the Nakagami distribution with parameters shape and scale.

Usage

dnaka(x, shape, scale, log = FALSE)

pnaka(q, shape, scale, lower.tail = TRUE, log.p = FALSE)

qnaka(p, shape, scale, lower.tail = TRUE, log.p = FALSE)

rnaka(n, shape, scale)

Arguments

x, q

vector of quantiles.

shape

vector of positive shape parameters.

scale

vector of positive scale parameters.

log, log.p

logical; if TRUE, probabilities p are given as log(p).

lower.tail

logical; if TRUE (default), probabilities are P[Xx]P[X \le x] otherwise, P[X>x]P[X > x].

p

vector of probabilities.

n

number of observations. If length(n) > 1, the length is taken to be the number required.

Details

The Nakagami distribution (Nakagami, 1960) with shape mm and scale Ω\Omega has density

2mm/Γ(m)Ωmx(2m1)e(m/Ωx2)2m^m/{\Gamma(m)\Omega^m} x^(2m-1)e^(-m/\Omega x^2)

for x0x \ge 0, m>0m > 0 and Ω>0\Omega > 0.

If YY is Gamma distributed with shape=mshape = m and rate=m/Ωrate = m/\Omega then X=YX = \sqrt Y is Nakagami distributed with shape=mshape = m and scale=Ωscale = \Omega.

Sometimes, specifically in radio channels modeling, the parameter mm is constrained to m1/2m \ge 1/2, but the density is defined for any m>0m > 0 (Kolar et al., 2004).

Value

dnaka gives the density, pnaka gives the distribution function, qnaka gives the quantile function and rnaka generates random deviates.

The length of the result is determined by n for rnaka, and is the maximum of the lengths of the numerical arguments for the other functions.

The numerical arguments other than n are recycled to the length of the result.

References

Nakagami, N. 1960. "The M-Distribution, a General Formula of Intensity of Rapid Fading." In Statistical Methods in Radio Wave Propagation: Proceedings of a Symposium Held at the University of California, edited by William C. Hoffman, 3-36. Permagon Press.

Kolar, R., Jirik, R., & Jan, J. (2004). Estimator comparison of the Nakagami-m parameter and its application in echocardiography. Radioengineering, 13(1), 8-12.

See Also

The Gamma distribution is closed related to the Nakgami distribution.


Suppress object length incompatibility warnings

Description

Suppress object length incompatibility warnings

Usage

suppress_olw(expr)

Arguments

expr

expression to be evaluated.