diff --git a/lib/node_modules/@stdlib/blas/ext/base/README.md b/lib/node_modules/@stdlib/blas/ext/base/README.md index 02829e614559..e983ba52d718 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/README.md +++ b/lib/node_modules/@stdlib/blas/ext/base/README.md @@ -75,7 +75,7 @@ var o = ns; - [`dcuany( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/dcuany]: cumulatively test whether at least one element in a double-precision floating-point strided array is truthy. - [`dcuevery( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/dcuevery]: cumulatively test whether every element in a double-precision floating-point strided array is truthy. - [`dcunone( N, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/dcunone]: cumulatively test whether every element in a double-precision floating-point strided array is falsy. -- [`dcusome( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/dcusome]: cumulatively test whether at least k elements in a double-precision floating-point strided array are truthy. +- [`dcusome( N, k, x, strideX, out, strideOut )`][@stdlib/blas/ext/base/dcusome]: cumulatively test whether at least `k` elements in a double-precision floating-point strided array are truthy. - [`dcusum( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusum]: calculate the cumulative sum of double-precision floating-point strided array elements. - [`dcusumkbn( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumkbn]: calculate the cumulative sum of double-precision floating-point strided array elements using an improved Kahan–Babuška algorithm. - [`dcusumkbn2( N, sum, x, strideX, y, strideY )`][@stdlib/blas/ext/base/dcusumkbn2]: calculate the cumulative sum of double-precision floating-point strided array elements using a second-order iterative Kahan–Babuška algorithm. diff --git a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts index b35c63c821ce..98e153f3c9bb 100644 --- a/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts @@ -1311,7 +1311,7 @@ interface Namespace { dcunone: typeof dcunone; /** - * Cumulatively tests whether at least k elements in a double-precision floating-point strided array are truthy. + * Cumulatively tests whether at least `k` elements in a double-precision floating-point strided array are truthy. * * @param N - number of indexed elements * @param k - minimum number of truthy elements diff --git a/lib/node_modules/@stdlib/ndarray/find-last/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/find-last/docs/types/index.d.ts index d1cf6c1a1166..387fbe27ee7b 100644 --- a/lib/node_modules/@stdlib/ndarray/find-last/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/find-last/docs/types/index.d.ts @@ -21,7 +21,7 @@ /// import { ArrayLike } from '@stdlib/types/array'; -import { ndarray, typedndarray } from '@stdlib/types/ndarray'; +import { typedndarray } from '@stdlib/types/ndarray'; /** * Returns a boolean indicating whether an element passes a test. @@ -221,7 +221,7 @@ interface FindLast { * var out = findLast.assign( x, y, isEven ); * // returns [ 6.0 ] */ - assign = typedndarray, ThisArg = unknown>( x: ndarray, out: U, predicate: Predicate, thisArg?: ThisParameterType> ): U; + assign = typedndarray, V extends typedndarray = typedndarray, ThisArg = unknown>( x: U, out: V, predicate: Predicate, thisArg?: ThisParameterType> ): V; /** * Finds the last elements which pass a test implemented by a predicate function along one or more ndarray dimensions and assigns results to a provided output ndarray. @@ -265,7 +265,7 @@ interface FindLast { * var out = findLast.assign( x, y, {}, isEven ); * // returns [ 6.0 ] */ - assign = typedndarray, V = T, ThisArg = unknown>( x: ndarray, out: U, options: AssignOptions, predicate: Predicate, thisArg?: ThisParameterType> ): U; + assign = typedndarray, V extends typedndarray = typedndarray, W = T, ThisArg = unknown>( x: U, out: V, options: AssignOptions, predicate: Predicate, thisArg?: ThisParameterType> ): V; } /** diff --git a/lib/node_modules/@stdlib/ndarray/find/docs/types/index.d.ts b/lib/node_modules/@stdlib/ndarray/find/docs/types/index.d.ts index e802779d6691..4465dd95a120 100644 --- a/lib/node_modules/@stdlib/ndarray/find/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/ndarray/find/docs/types/index.d.ts @@ -21,7 +21,7 @@ /// import { ArrayLike } from '@stdlib/types/array'; -import { ndarray, typedndarray } from '@stdlib/types/ndarray'; +import { typedndarray } from '@stdlib/types/ndarray'; /** * Returns a boolean indicating whether an element passes a test. @@ -227,7 +227,7 @@ interface Find { * var v = out.get(); * // returns 2.0 */ - assign = typedndarray, ThisArg = unknown>( x: ndarray, out: U, predicate: Predicate, thisArg?: ThisParameterType> ): U; + assign = typedndarray, V extends typedndarray = typedndarray, ThisArg = unknown>( x: U, out: V, predicate: Predicate, thisArg?: ThisParameterType> ): V; /** * Finds the first elements which pass a test implemented by a predicate function along one or more ndarray dimensions and assigns results to a provided output ndarray. @@ -271,7 +271,7 @@ interface Find { * var out = find.assign( x, y, {}, isEven ); * // returns */ - assign = typedndarray, V = T, ThisArg = unknown>( x: ndarray, out: U, options: AssignOptions, predicate: Predicate, thisArg?: ThisParameterType> ): U; + assign = typedndarray, V extends typedndarray = typedndarray, W = T, ThisArg = unknown>( x: U, out: V, options: AssignOptions, predicate: Predicate, thisArg?: ThisParameterType> ): V; } /** diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md index 5d57d67958aa..e753bb741a96 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Arcsine][arcsine-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Arcsine][arcsine-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/arcsine/logcdf' ); #### logcdf( x, a, b ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for an [arcsine][arcsine-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for an [arcsine][arcsine-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```javascript var y = logcdf( 9.0, 0.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/repl.txt index e4115e88be5a..7472d943b01d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, a, b ) - Evaluates the logarithm of the cumulative distribution function (CDF) for an - arcsine distribution with minimum support `a` and maximum support `b` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for an arcsine distribution with minimum support `a` and maximum + support `b` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/types/index.d.ts index 385792dd5ce5..8237ca5e635d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for an arcsine distribution. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for an arcsine distribution. * * @param x - input value * @returns evaluated logCDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/factory.js index 4c1664ed0fff..f3500dd4f0d9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/factory.js @@ -58,7 +58,7 @@ function factory( a, b ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for an arcsine distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for an arcsine distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/index.js index 180221209b2a..5eddb3e38ee8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Arcsine distribution logarithm of cumulative distribution function (CDF). +* Arcsine distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/arcsine/logcdf * @@ -31,7 +31,7 @@ * * var mylogcdf = logcdf.factory( 0.0, 10.0 ); * y = mylogcdf( 0.5 ); -* // returns ~-1.938 +* // returns ~-1.941 * * y = mylogcdf( 8.0 ); * // returns ~-0.35 diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/main.js index 5f7a3591e1fe..a320d03a8f59 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logcdf/lib/main.js @@ -32,7 +32,7 @@ var LN2 = require( '@stdlib/constants/float64/ln-two' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param {number} x - input value * @param {number} a - minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md index 10e3bc96ee83..6ef282b6cfeb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Arcsine][arcsine-distribution] distribution logarithm of [probability density function][pdf] (PDF). +> [Arcsine][arcsine-distribution] distribution natural logarithm of [probability density function][pdf] (PDF).
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/arcsine/logpdf' ); #### logpdf( x, a, b ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for an [arcsine][arcsine-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for an [arcsine][arcsine-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```javascript var y = logpdf( 2.0, 0.0, 4.0 ); @@ -171,7 +171,7 @@ logEachMap( 'x: %0.4f, a: %0.4f, b: %0.4f, ln(f(x;a,b)): %0.4f', x, a, b, logpdf #### stdlib_base_dists_arcsine_logpdf( x, a, b ) -Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution. +Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution. ```c double out = stdlib_base_dists_arcsine_logpdf( 2.0, 0.0, 4.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/repl.txt index 3dce85c34102..9d80523792c9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, a, b ) - Evaluates the logarithm of the probability density function (PDF) for an - arcsine distribution with minimum support `a` and maximum support `b` at a - value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for an arcsine distribution with minimum support `a` and maximum support `b` + at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/types/index.d.ts index 8cc6cc6d1d87..bcdc5ff40945 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution. * * @param x - input value * @returns evaluated logPDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/include/stdlib/stats/base/dists/arcsine/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/include/stdlib/stats/base/dists/arcsine/logpdf.h index b179844f8b9d..ff517ebed12d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/include/stdlib/stats/base/dists/arcsine/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/include/stdlib/stats/base/dists/arcsine/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. */ double stdlib_base_dists_arcsine_logpdf( const double x, const double a, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/factory.js index b2fa9c513684..25ae89b86ad3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/factory.js @@ -55,7 +55,7 @@ function factory( a, b ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/index.js index 546abf9dcbf5..2ee160dcac6c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Arcsine distribution logarithm of probability density function (PDF). +* Arcsine distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/arcsine/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/main.js index c4e52a81529f..10a28576452a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/main.js @@ -29,7 +29,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param {number} x - input value * @param {number} a - minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/native.js index 68c70f4ee4e0..5d0004167e33 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/src/main.c index a6920910f85f..a20839c29ded 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/arcsine/logpdf/src/main.c @@ -23,7 +23,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for an arcsine distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param x input value * @param a minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/README.md index 5ce15052684d..542a72b11378 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Cauchy][cauchy-distribution] distribution logarithm of probability density function (logPDF). +> [Cauchy][cauchy-distribution] distribution natural logarithm of probability density function (logPDF).
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/lib/index.js index 6bf5a296034f..8382f4fb3731 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cauchy/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Cauchy distribution logarithm of probability density function (logPDF). +* Cauchy distribution natural logarithm of probability density function (logPDF). * * @module @stdlib/stats/base/dists/cauchy/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md index 6755e4030586..4479f9b33fc1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Raised cosine][cosine-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Raised cosine][cosine-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js index 3bc332c267c4..4a754f4ede78 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Raised cosine distribution logarithm of cumulative distribution function (CDF). +* Raised cosine distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/cosine/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md index b62e4f7aef2d..fa6499af1ba4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Raised cosine][cosine-distribution] distribution logarithm of [probability density function (PDF)][pdf]. +> [Raised cosine][cosine-distribution] distribution natural logarithm of [probability density function (PDF)][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/cosine/logpdf' ); #### logpdf( x, mu, s ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). ```javascript var y = logpdf( 2.0, 0.0, 3.0 ); @@ -176,7 +176,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(f(x;µ,s)): %0.4f', x, mu, s, log #### stdlib_base_dists_cosine_logpdf( x, mu, s ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [raised cosine][cosine-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). ```c double out = stdlib_base_dists_cosine_logpdf( 2.0, 0.0, 3.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/docs/repl.txt index e00be95ff29c..fc41111a434f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, s ) - Evaluates the logarithm of the probability density function (PDF) for a - raised cosine distribution with location parameter `μ` and scale parameter - `s` at a value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a raised cosine distribution with location parameter `μ` and scale + parameter `s` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/include/stdlib/stats/base/dists/cosine/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/include/stdlib/stats/base/dists/cosine/logpdf.h index 026f27d0b3ea..e13066086ffc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/include/stdlib/stats/base/dists/cosine/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/include/stdlib/stats/base/dists/cosine/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a raised cosine distribution with parameters `mu` (location parameter) and `s` (scale parameter). +* Evaluates the natural logarithm of the probability density function (PDF) for a raised cosine distribution with parameters `mu` (location parameter) and `s` (scale parameter). */ double stdlib_base_dists_cosine_logpdf( const double x, const double mu, const double s ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/factory.js index b5a3440aa5ca..d58be7349f9b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/factory.js @@ -55,7 +55,7 @@ function factory( mu, s ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a raised cosine distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a raised cosine distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js index 62cec8e7a8ed..ad3fa6b15c19 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Raised cosine distribution logarithm of probability density function (PDF). +* Raised cosine distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/cosine/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/main.js index 96fbf03f38cc..20d4cdccb788 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/main.js @@ -30,7 +30,7 @@ var PINF = require( '@stdlib/constants/float64/pinf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/native.js index 48197797b8bf..20f22bc5d245 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/src/main.c index 70a88dd1bd7a..c4ef47f8e376 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/cosine/logpdf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a raised cosine distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/lib/index.js index dd16d78caebd..59e96b4ef7f7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Degenerate distribution logarithm of cumulative distribution function (CDF). +* Degenerate distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/degenerate/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/lib/index.js index 5d0b735234da..fdebf24716bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/degenerate/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Degenerate distribution logarithm of probability density function (logPDF). +* Degenerate distribution natural logarithm of probability density function (logPDF). * * @module @stdlib/stats/base/dists/degenerate/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/README.md index 66efe6507477..e186e880eb46 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Discrete uniform][discrete-uniform-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Discrete uniform][discrete-uniform-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/lib/index.js index 23ae83117b34..c8f85b4f5ecf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/discrete-uniform/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Discrete uniform distribution logarithm of cumulative distribution function (CDF). +* Discrete uniform distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/discrete-uniform/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/docs/types/index.d.ts index cdd4409c986c..22e3d7f2ac8f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/erlang/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for an Erlang distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for an Erlang distribution. * * @param x - input value * @returns evaluated logPDF diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/README.md index 53f4b873330d..163984731055 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Exponential][exponential-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Exponential][exponential-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/lib/index.js index 738cceb13f1f..b62663d492ad 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/exponential/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Exponential distribution logarithm of cumulative distribution function (CDF). +* Exponential distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/exponential/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/README.md index 089ed596f3d2..3145fa875829 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Fréchet][frechet-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Fréchet][frechet-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/lib/index.js index 1c9adf50d8fc..e51dd7110aa3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Fréchet distribution logarithm of the cumulative distribution function (CDF). +* Fréchet distribution natural logarithm of the cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/frechet/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/README.md index f43d6bb1c08c..996746832a4c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Fréchet][frechet-distribution] distribution logarithm of [probability density function][pdf]. +> [Fréchet][frechet-distribution] distribution natural logarithm of [probability density function][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/frechet/logpdf' ); #### logpdf( x, alpha, s, m ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Fréchet][frechet-distribution] distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Fréchet][frechet-distribution] distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. ```javascript var y = logpdf( 10.0, 2.0, 3.0, 5.0 ); @@ -193,7 +193,7 @@ logEachMap( 'x: %0.4f, α: %0.4f, s: %0.4f, m: %0.4f, ln(f(x;α,s,m)): %0.4f', x #### stdlib_base_dists_frechet_logpdf( x, alpha, s, m ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Fréchet][frechet-distribution] distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Fréchet][frechet-distribution] distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. ```c double y = stdlib_base_dists_frechet_logpdf( 10.0, 2.0, 3.0, 2.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/repl.txt index 0e4ed327c326..8714b2db875e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, α, s, m ) - Evaluates the logarithm of the probability density function (PDF) for a - Fréchet distribution with shape parameter `α`, scale parameter `s`, and - location `m`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Fréchet distribution with shape parameter `α`, scale parameter `s`, + and location `m`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/types/index.d.ts index fce1383ecab9..b50f0651528f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/include/stdlib/stats/base/dists/frechet/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/include/stdlib/stats/base/dists/frechet/logpdf.h index 0439d9908137..d54fc31ebb40 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/include/stdlib/stats/base/dists/frechet/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/include/stdlib/stats/base/dists/frechet/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. */ double stdlib_base_dists_frechet_logpdf( const double x, const double alpha, const double s, const double m ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/factory.js index 4776de0b6833..e9d97f66d7b6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/factory.js @@ -59,7 +59,7 @@ function factory( alpha, s, m ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/index.js index dc80af21909c..2d5f27748f5b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Fréchet distribution logarithm of probability density function (logpdf). +* Fréchet distribution natural logarithm of probability density function (logpdf). * * @module @stdlib/stats/base/dists/frechet/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/main.js index 9f359d6bd6e4..49bb69414b58 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/main.js @@ -29,7 +29,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * @param {number} x - input value * @param {PositiveNumber} alpha - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/native.js index a80b4c8cfe34..22f8a5a00429 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/src/main.c index a8621bc2b0a2..3f640040b0c7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/frechet/logpdf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/constants/float64/nan.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Fréchet distribution with shape `alpha`, scale `s`, and location `m` at a value `x`. * * @param x input value * @param alpha shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/README.md index 9d969c539e7a..aa6336975425 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Gamma][gamma-distribution] distribution logarithm of cumulative distribution function (CDF). +> [Gamma][gamma-distribution] distribution natural logarithm of cumulative distribution function (CDF).
diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/repl.txt index 82b62e9991cc..85d136ef88f9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, α, β ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - gamma distribution with shape parameter `α` and rate parameter `β` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a gamma distribution with shape parameter `α` and rate parameter + `β` at a value `x`. If `α < 0` or `β <= 0`, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/types/index.d.ts index 8dc55f974697..f1c5d233f247 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a gamma distribution. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a gamma distribution. * * @param x - input value * @returns evaluated logCDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/factory.js index fee0ee203f7e..b8ab92eb3233 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/factory.js @@ -62,7 +62,7 @@ function factory( alpha, beta ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a gamma distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a gamma distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/index.js index 88b44a4642d2..174bb293aa7f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Gamma distribution logarithm of cumulative distribution function (CDF). +* Gamma distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/gamma/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/main.js index 8b18ebcdecde..877af97712e6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logcdf/lib/main.js @@ -27,7 +27,7 @@ var ln = require( '@stdlib/math/base/special/ln' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * @param {number} x - input value * @param {NonNegativeNumber} alpha - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/README.md index 700aa9b6b7d0..f2feb8560cc8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Gamma][gamma-distribution] distribution logarithm of probability density function (PDF). +> [Gamma][gamma-distribution] distribution natural logarithm of probability density function (PDF).
@@ -179,7 +179,7 @@ logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, ln(f(x;α,β)): %0.4f', x, alpha, b #### stdlib_base_dists_gamma_logpdf( x, alpha, beta ) -Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. ```c double out = stdlib_base_dists_gamma_logpdf( 2.0, 0.5, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/repl.txt index 58eb8f2e7775..f99f5cda80e4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, α, β ) - Evaluates the logarithm of the probability density function (PDF) for a - gamma distribution with shape parameter `α` and rate parameter `β` at a - value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a gamma distribution with shape parameter `α` and rate parameter `β` at + a value `x`. If `α < 0` or `β <= 0`, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/types/index.d.ts index df1be37d40ea..87ae42038ff1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for a gamma distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution. * * @param x - input value * @returns evaluated logPDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/include/stdlib/stats/base/dists/gamma/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/include/stdlib/stats/base/dists/gamma/logpdf.h index d6ff0f4151be..5ffcf3d435a9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/include/stdlib/stats/base/dists/gamma/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/include/stdlib/stats/base/dists/gamma/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. */ double stdlib_base_dists_gamma_logpdf( const double x, const double alpha, const double beta ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/factory.js index f79b8f535904..79125a8cdf45 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/factory.js @@ -62,7 +62,7 @@ function factory( alpha, beta ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a gamma distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/index.js index a7233bb323a1..fb0b936e608b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Gamma distribution logarithm of probability density function (PDF). +* Gamma distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/gamma/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/main.js index c91099e25f26..38d1ce2fdd8d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/main.js @@ -30,7 +30,7 @@ var gammaDeriv = require( './gamma_p_derivative.js' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * @param {number} x - input value * @param {NonNegativeNumber} alpha - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/native.js index d8407a737e70..8df80d7c1a4f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/src/main.c index 4fa449ed4ae8..c33a15eb9d20 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/gamma/logpdf/src/main.c @@ -159,7 +159,7 @@ static double gamma_p_derivative( const double a, const double x ) { // END: gammma_p_derivative /** -* Evaluates the logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a gamma distribution with shape parameter `alpha` and rate parameter `beta` at a value `x`. * * @param x input value * @param alpha shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md index 865d37628fcb..d8c0716c8c4a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Geometric][geometric-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Geometric][geometric-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/geometric/logcdf' ); #### logcdf( x, p ) -Evaluates the logarithm of the [cumulative distribution function][cdf] for a [geometric][geometric-distribution] distribution with success probability `p`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] for a [geometric][geometric-distribution] distribution with success probability `p`. ```javascript var y = logcdf( 2.0, 0.5 ); @@ -164,7 +164,7 @@ logEachMap( 'x: %0.4f, p: %0.4f, F(x;p): %0.4f', x, p, logcdf ); #### stdlib_base_dists_geometric_logcdf( x, p ) -Evaluates the logarithm of the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability `p`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] of a [geometric][geometric-distribution] distribution with success probability `p`. ```c double out = stdlib_base_dists_geometric_logcdf( 2.0, 0.5 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/repl.txt index 6082f3724349..2a7aa182d142 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/repl.txt @@ -1,7 +1,8 @@ {{alias}}( x, p ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - geometric distribution with success probability `p` at a value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a geometric distribution with success probability `p` at a value + `x`. If provided `NaN` as any argument, the function returns `NaN`. @@ -26,7 +27,7 @@ ~-0.134 > y = {{alias}}( 2.0, 0.1 ) ~-1.306 - > y = {{alias}}( -1.0, 4.0 ) + > y = {{alias}}( -1.0, 0.4 ) -Infinity > y = {{alias}}( NaN, 0.5 ) NaN diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/types/index.d.ts index 3e6218778916..d72e5fd68b99 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/include/stdlib/stats/base/dists/geometric/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/include/stdlib/stats/base/dists/geometric/logcdf.h index c7029479bade..6aba6c6e9aee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/include/stdlib/stats/base/dists/geometric/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/include/stdlib/stats/base/dists/geometric/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (LOGCDF) for the geometric distribution with probability `p` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (LOGCDF) for the geometric distribution with probability `p` at a value `x`. */ double stdlib_base_dists_geometric_logcdf( const double x, const double p ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/factory.js index 374ff0f0d674..68f26f9bc572 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/factory.js @@ -52,7 +52,7 @@ function factory( p ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a geometric distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a geometric distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/index.js index c211e783d9ed..77a9017fe793 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Geometric distribution logarithm of cumulative distribution function (CDF). +* Geometric distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/geometric/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/main.js index 9517c05c5171..3fc0b62b091a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/main.js @@ -31,7 +31,7 @@ var PINF = require( '@stdlib/constants/float64/pinf' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. * * @param {number} x - input value * @param {Probability} p - success probability diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/native.js index aae156e44ed9..730471a5cb42 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/src/main.c index f9246b16054d..33cc964cfcf2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logcdf/src/main.c @@ -25,7 +25,7 @@ #include "stdlib/math/base/special/pow.h" /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a geometric distribution with success probability `p` at a value `x`. * * @param x input value * @param p success probability diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md index 9f6a33ba9cf2..ff21316b949c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Mass Function -> [Geometric][geometric-distribution] distribution logarithm of [probability mass function][pmf] (PMF). +> [Geometric][geometric-distribution] distribution natural logarithm of [probability mass function][pmf] (PMF).
@@ -55,7 +55,7 @@ var logpmf = require( '@stdlib/stats/base/dists/geometric/logpmf' ); #### logpmf( x, p ) -Evaluates the logarithm of the [probability mass function][pmf] (PMF) of a [geometric][geometric-distribution] distribution with success probability `0 <= p <= 1`. +Evaluates the natural logarithm of the [probability mass function][pmf] (PMF) of a [geometric][geometric-distribution] distribution with success probability `0 <= p <= 1`. ```javascript var y = logpmf( 4.0, 0.3 ); @@ -168,7 +168,7 @@ logEachMap( 'x: %d, p: %0.4f, ln( P( X = x; p ) ): %0.4f', x, p, logpmf ); #### stdlib_base_dists_geometric_logpmf( x, p ) -Evaluates the logarithm of the [probability mass function][pmf] (PMF) of the [geometric][geometric-distribution] distribution with success probability `0 <= p <= 1`. +Evaluates the natural logarithm of the [probability mass function][pmf] (PMF) of the [geometric][geometric-distribution] distribution with success probability `0 <= p <= 1`. ```c double out = stdlib_base_dists_geometric_logpmf( 4.0, 0.3 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/repl.txt index 5a9b7c923b3f..884fdea85002 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/repl.txt @@ -1,6 +1,6 @@ {{alias}}( x, p ) - Evaluates the logarithm of the probability mass function (PMF) for a + Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/types/index.d.ts index 257c929907ab..d63f344b2ac8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPMF { /** - * Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. + * Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/include/stdlib/stats/base/dists/geometric/logpmf.h b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/include/stdlib/stats/base/dists/geometric/logpmf.h index ed23b8fe5560..c2f028a8df97 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/include/stdlib/stats/base/dists/geometric/logpmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/include/stdlib/stats/base/dists/geometric/logpmf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability mass function (PMF) for the geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the probability mass function (PMF) for the geometric distribution with success probability `p` at a value `x`. */ double stdlib_base_dists_geometric_logpmf( const double x, const double p ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/factory.js index b4549df11d88..f293a8cadac2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/factory.js @@ -54,7 +54,7 @@ function factory( p ) { return logpmf; /** - * Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution. + * Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/index.js index 51177a964dbd..94fe26667e34 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Geometric distribution logarithm of probability mass function (PMF). +* Geometric distribution natural logarithm of probability mass function (PMF). * * @module @stdlib/stats/base/dists/geometric/logpmf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/main.js index 7aecd9e8c644..c3a83bd931ce 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/main.js @@ -29,7 +29,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. * * @param {number} x - input value * @param {Probability} p - success probability diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/native.js index b878bd61565a..e0f7610bf434 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/src/main.c index 6bf2faa60915..c7a6a43d5662 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/geometric/logpmf/src/main.c @@ -23,7 +23,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a geometric distribution with success probability `p` at a value `x`. * * @param x input value * @param p success probability diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/README.md index ca3b43803444..96ca1b6635d2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Gumbel][gumbel-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Gumbel][gumbel-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/gumbel/logcdf' ); #### logcdf( x, mu, beta ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta` (scale parameter). ```javascript var y = logcdf( 10.0, 0.0, 3.0 ); @@ -172,7 +172,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, β: %0.4f, ln(F(x;µ,β)): %0.4f', x, mu, beta #### stdlib_base_dists_gumbel_logcdf( x, mu, beta ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta` (scale parameter). ```c double out = stdlib_base_dists_gumbel_logcdf( 10.0, 0.0, 3.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/repl.txt index 11c57717241b..aec8e6f0359c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, β ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Gumbel distribution with location parameter `μ` and scale parameter `β` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Gumbel distribution with location parameter `μ` and scale + parameter `β` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/types/index.d.ts index f9a7b7c1da73..4bc098211718 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution. * * @param x - input value * @returns evaluated logarithm of CDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/include/stdlib/stats/base/dists/gumbel/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/include/stdlib/stats/base/dists/gumbel/logcdf.h index 4d4f68a7df80..bd739a29910c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/include/stdlib/stats/base/dists/gumbel/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/include/stdlib/stats/base/dists/gumbel/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. */ double stdlib_base_dists_gumbel_logcdf( const double x, const double mu, const double beta ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/factory.js index 824ba1361da3..e57a0c5458c9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/factory.js @@ -54,7 +54,7 @@ function factory( mu, beta ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/index.js index 6934f7412a28..b81a3e685100 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Gumbel distribution logarithm of the cumulative distribution function (CDF). +* Gumbel distribution natural logarithm of the cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/gumbel/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/main.js index ca30f76356dd..f324c6d237df 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/main.js @@ -27,7 +27,7 @@ var exp = require( '@stdlib/math/base/special/exp' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/native.js index 54f462554dd2..7cb72b708a83 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md index 1890500d4177..7f8beebc8039 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Gumbel][gumbel-distribution] distribution logarithm of [probability density function (PDF)][pdf]. +> [Gumbel][gumbel-distribution] distribution natural logarithm of [probability density function (PDF)][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/gumbel/logpdf' ); #### logpdf( x, mu, beta ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter). ```javascript var y = logpdf( 0.0, 0.0, 2.0 ); @@ -172,7 +172,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, β: %0.4f, ln(f(x;µ,β)): %0.4f', x, mu, beta #### stdlib_base_dists_gumbel_logpdf( x, mu, beta ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Gumbel][gumbel-distribution] distribution with parameters `mu` (location parameter) and `beta > 0` (scale parameter). ```c double out = stdlib_base_dists_gumbel_logpdf( 0.0, 0.0, 2.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/repl.txt index 558fb9801606..bc16448fb1a9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, β ) - Evaluates the logarithm of the probability density function (PDF) for a - Gumbel distribution with location parameter `μ` and scale parameter `β` at a - value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Gumbel distribution with location parameter `μ` and scale parameter + `β` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/types/index.d.ts index 9d804cf49e99..c4680fad6fa7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/include/stdlib/stats/base/dists/gumbel/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/include/stdlib/stats/base/dists/gumbel/logpdf.h index 347a564f7561..fda7288cfea8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/include/stdlib/stats/base/dists/gumbel/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/include/stdlib/stats/base/dists/gumbel/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. */ double stdlib_base_dists_gumbel_logpdf( const double x, const double mu, const double beta ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/factory.js index 2a1ca4c7bda2..1ee30a2a6543 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/factory.js @@ -54,7 +54,7 @@ function factory( mu, beta ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/index.js index 9eff3fb95749..f3afa5169227 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Gumbel distribution logarithm of probability density function (PDF). +* Gumbel distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/gumbel/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/main.js index 7ce0b080d7f9..43b9cf12ab94 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/main.js @@ -29,7 +29,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/native.js index 23a62d1e7a27..5f45244ae58b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/src/main.c index e19fd857687d..e4bb9d925680 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/gumbel/logpdf/src/main.c @@ -23,7 +23,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Gumbel distribution with location parameter `mu` and scale parameter `beta` at a value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/README.md index 03cdcef4bdcb..f3181e0fe638 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Half-normal][half-normal-distribution] distribution logarithm of [probability density function (PDF)][pdf]. +> [Half-normal][half-normal-distribution] distribution natural logarithm of [probability density function (PDF)][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/halfnormal/logpdf' ); #### logpdf( x, sigma ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [half-normal][half-normal-distribution] distribution with parameter `sigma` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [half-normal][half-normal-distribution] distribution with parameter `sigma` (scale parameter). ```javascript var y = logpdf( 0.8, 1.0 ); @@ -175,7 +175,7 @@ logEachMap( 'x: %0.4f, σ: %0.4f, ln(f(x;σ)): %0.4f', x, sigma, logpdf ); #### stdlib_base_dists_halfnormal_logpdf( x, sigma ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [half-normal][half-normal-distribution] distribution with parameter `sigma` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [half-normal][half-normal-distribution] distribution with parameter `sigma` (scale parameter). ```c double out = stdlib_base_dists_halfnormal_logpdf( 0.8, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/repl.txt index c3e158932916..10a2f30efd7a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( x, σ ) - Evaluates the logarithm of the probability density function (PDF) for a - half-normal distribution with scale parameter `σ` at a value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a half-normal distribution with scale parameter `σ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/types/index.d.ts index e72e44b43007..c10a227ff8ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. + * Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/include/stdlib/stats/base/dists/halfnormal/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/include/stdlib/stats/base/dists/halfnormal/logpdf.h index c4e78eb2598f..9734068ebcef 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/include/stdlib/stats/base/dists/halfnormal/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/include/stdlib/stats/base/dists/halfnormal/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. +* Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. */ double stdlib_base_dists_halfnormal_logpdf( const double x, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/factory.js index 4dd1bccda8b4..433044e3ab0a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/factory.js @@ -61,7 +61,7 @@ function factory( sigma ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/index.js index bbed01cdffc7..342296ca9e99 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Half-normal distribution logarithm of probability density function (PDF). +* Half-normal distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/halfnormal/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/main.js index 9b6372097af9..d0a9ff5be121 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/main.js @@ -36,7 +36,7 @@ var C = 0.5 * ( LN2 - LNPI ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. +* Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. * * @param {number} x - input value * @param {PositiveNumber} sigma - scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/native.js index d3b462a51429..0da5649060e9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. +* Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/src/main.c index c059080d2ad0..fce0b2e9256e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/logpdf/src/main.c @@ -27,7 +27,7 @@ static const double C = 0.5 * ( STDLIB_CONSTANT_FLOAT64_LN2 - STDLIB_CONSTANT_FLOAT64_LN_PI ); /** -* Evaluates the logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. +* Evaluates the natural logarithm of the probability density function (PDF) for a half-normal distribution with scale parameter `sigma`. * * @param x input value * @param sigma scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/cdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/invgamma/cdf/README.md index 609a79ac9505..d216dd66a7d7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/invgamma/cdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/invgamma/cdf/README.md @@ -119,6 +119,31 @@ y = mycdf( 8.0 ); +
+ +## Examples + + + +```javascript +var uniform = require( '@stdlib/random/array/uniform' ); +var logEachMap = require( '@stdlib/console/log-each-map' ); +var cdf = require( '@stdlib/stats/base/dists/invgamma/cdf' ); + +var opts = { + 'dtype': 'float64' +}; +var x = uniform( 10, 0.0, 2.0, opts ); +var alpha = uniform( 10, 0.0, 5.0, opts ); +var beta = uniform( 10, 0.0, 5.0, opts ); + +logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf ); +``` + +
+ + + * * *
@@ -204,33 +229,6 @@ int main( void ) { -* * * - -
- -## Examples - - - -```javascript -var uniform = require( '@stdlib/random/array/uniform' ); -var logEachMap = require( '@stdlib/console/log-each-map' ); -var cdf = require( '@stdlib/stats/base/dists/invgamma/cdf' ); - -var opts = { - 'dtype': 'float64' -}; -var x = uniform( 10, 0.0, 2.0, opts ); -var alpha = uniform( 10, 0.0, 5.0, opts ); -var beta = uniform( 10, 0.0, 5.0, opts ); - -logEachMap( 'x: %0.4f, α: %0.4f, β: %0.4f, F(x;α,β): %0.4f', x, alpha, beta, cdf ); -``` - -
- - -
diff --git a/lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts index de91adb09dcf..d759c90a1fed 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/invgamma/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for an inverse gamma distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for an inverse gamma distribution. * * @param x - input value * @returns evaluated logPDF diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/docs/types/index.d.ts index b882503f0cc2..80c01fe3b0a8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logcdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Kumaraswamy's double bounded distribution. * * @param x - input value * @returns evaluated logCDF diff --git a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/docs/types/index.d.ts index e913078eb7ed..f76e3d2f61da 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/kumaraswamy/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for a Kumaraswamy's double bounded distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for a Kumaraswamy's double bounded distribution. * * @param x - input value * @returns evaluated logPDF diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/README.md index 1d7e7cb0361c..ec728ee28d09 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Laplace][laplace-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Laplace][laplace-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/laplace/logcdf' ); #### logcdf( x, mu, b ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [Laplace][laplace-distribution] distribution with parameters `mu` (location parameter) and `b > 0` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [Laplace][laplace-distribution] distribution with parameters `mu` (location parameter) and `b > 0` (scale parameter). ```javascript var y = logcdf( 2.0, 0.0, 1.0 ); @@ -169,7 +169,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, b: %0.4f, ln(F(x;µ,b)): %0.4f', x, mu, b, log #### stdlib_base_dists_laplace_logcdf( x, mu, b ) -Evaluates the logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. ```c double out = stdlib_base_dists_laplace_logcdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/repl.txt index 9818b9c270c7..464d918af818 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, b ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Laplace distribution with scale parameter `b` and location parameter `μ` at - a value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Laplace distribution with scale parameter `b` and location + parameter `μ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/types/index.d.ts index a8f53b650087..b85949c42ac3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/factory.js index 9e91245d8431..023099c29cbe 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/factory.js @@ -52,7 +52,7 @@ function factory( mu, b ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Laplace distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Laplace distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js index 43bc0bc4e2ef..5b8550ff6f9f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Laplace distribution logarithm of cumulative distribution function (CDF). +* Laplace distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/laplace/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/main.js index 2a37e035c9bd..d8de9212cac7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/main.js @@ -29,7 +29,7 @@ var LNHALF = require( '@stdlib/constants/float64/ln-half' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/native.js index 6079babb249e..3410c9ad868f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/README.md index a7a1227b9ca5..8a2f3857296a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Laplace][laplace-distribution] distribution logarithm of probability density function (PDF). +> [Laplace][laplace-distribution] distribution natural logarithm of probability density function (PDF).
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/laplace/logpdf' ); #### logpdf( x, mu, b ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Laplace][laplace-distribution] distribution with parameters `mu` (location parameter) and `b > 0` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Laplace][laplace-distribution] distribution with parameters `mu` (location parameter) and `b > 0` (scale parameter). ```javascript var y = logpdf( 2.0, 0.0, 1.0 ); @@ -175,7 +175,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, b: %0.4f, ln(f(x;µ,b)): %0.4f', x, mu, b, log #### stdlib_base_dists_laplace_logpdf( x, mu, b ) -Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. ```c double out = stdlib_base_dists_laplace_logpdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/repl.txt index 493f3d182cf3..c3535e7a6827 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, b ) - Evaluates the logarithm of the probability density function (PDF) for a - Laplace distribution with scale parameter `b` and location parameter `μ` at - a value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Laplace distribution with scale parameter `b` and location parameter + `μ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/types/index.d.ts index 4c8569f1e898..25c0cb5e7624 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution. * * @param x - input value * @returns evaluated logPDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/include/stdlib/stats/base/dists/laplace/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/include/stdlib/stats/base/dists/laplace/logpdf.h index 7fe0b8719999..ff38b395b108 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/include/stdlib/stats/base/dists/laplace/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/include/stdlib/stats/base/dists/laplace/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. */ double stdlib_base_dists_laplace_logpdf( const double x, const double mu, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/factory.js index 26eb609e8dd1..7933512485c1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/factory.js @@ -58,7 +58,7 @@ function factory( mu, b ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js index 40fa12d0ba33..50c37d044281 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Laplace distribution logarithm of probability density function (PDF). +* Laplace distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/laplace/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/main.js index 75a6bdd3db12..ba992d688f68 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/main.js @@ -28,7 +28,7 @@ var ln = require( '@stdlib/math/base/special/ln' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/native.js index 32e1a1a365b5..906aa1e02357 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/src/main.c index d79ebe34d29d..bd6d72a0aba8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/laplace/logpdf/src/main.c @@ -22,7 +22,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Laplace distribution with location parameter `mu` and scale parameter `b` at a value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/ctor/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/levy/ctor/lib/main.js index c1d87763b113..d54c3ce47efc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/ctor/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/ctor/lib/main.js @@ -56,7 +56,7 @@ function levyCDF( x ) { } /** -* Evaluates the logarithm of the cumulative distribution function (CDF). +* Evaluates the natural logarithm of the cumulative distribution function (CDF). * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/README.md index 18dbbb6fc30f..de9cdb5518eb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Lévy][levy-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Lévy][levy-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/levy/logcdf' ); #### logcdf( x, mu, c ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c > 0` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c > 0` (scale parameter). ```javascript var y = logcdf( 2.0, 0.0, 1.0 ); @@ -177,7 +177,7 @@ for ( i = 0; i < 100; i++ ) { #### stdlib_base_dists_levy_logcdf( x, mu, c ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c > 0` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c > 0` (scale parameter). ```c double out = stdlib_base_dists_levy_logcdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/docs/repl.txt index 4261a2764e54..331d37c88ca0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, c ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Lévy distribution with location parameter `μ` and scale parameter `c` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Lévy distribution with location parameter `μ` and scale + parameter `c` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/include/stdlib/stats/base/dists/levy/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/include/stdlib/stats/base/dists/levy/logcdf.h index 2c0d511c472c..728dfba66e20 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/include/stdlib/stats/base/dists/levy/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/include/stdlib/stats/base/dists/levy/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. */ double stdlib_base_dists_levy_logcdf( const double x, const double mu, const double c ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/factory.js index c5fb84a9b049..d98494d35a99 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/factory.js @@ -57,7 +57,7 @@ function factory( mu, c ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Lévy distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Lévy distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js index 520c9e5e13d5..f0d2eaa1a9b5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Lévy distribution logarithm of cumulative distribution function (CDF). +* Lévy distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/levy/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/main.js index d88844a69d76..0cc35e6377c4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/main.js @@ -30,7 +30,7 @@ var ln = require( '@stdlib/math/base/special/ln' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/native.js index 85a74dd883d7..8df784f3b188 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/src/main.c index bac9fec45b89..5b700154492b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logcdf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Lévy distribution with location parameter `mu` and scale parameter `c` at value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/README.md index 8c4d5b7e667f..9f044c1cd19e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Lévy][levy-distribution] distribution logarithm of [probability density function (PDF)][pdf]. +> [Lévy][levy-distribution] distribution natural logarithm of [probability density function (PDF)][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/levy/logpdf' ); #### logpdf( x, mu, c ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Lévy][levy-distribution] distribution with parameters `mu` (location parameter) and `c` (scale parameter). ```javascript var y = logpdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/repl.txt index 40ac5f878348..55a223d8c6eb 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, c ) - Evaluates the logarithm of the probability density function (PDF) for a Lévy - distribution with location parameter `μ` and scale parameter `c` at a value - `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Lévy distribution with location parameter `μ` and scale parameter `c` + at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/types/index.d.ts index 2b27686dba1a..a58efa0443b5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the probability density function (PDF) for a Lévy distribution. +* Evaluates the natural logarithm of the probability density function (PDF) for a Lévy distribution. * * @param x - input value * @returns evaluated logPDF diff --git a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/lib/index.js index 3d2ca2d43315..32655d5ed6c0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/levy/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Lévy distribution logarithm of probability density function (PDF). +* Lévy distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/levy/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/README.md index 757be1ef87ef..584284377406 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Logistic][logistic-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Logistic][logistic-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/logistic/logcdf' ); #### logcdf( x, mu, s ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [logistic][logistic-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [logistic][logistic-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). ```javascript var y = logcdf( 2.0, 0.0, 1.0 ); @@ -182,7 +182,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(F(x;µ,s)): %0.4f', x, mu, s, log #### stdlib_base_dists_logistic_logcdf( x, mu, s ) -Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. ```c double out = stdlib_base_dists_logistic_logcdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/repl.txt index 666ef80d071d..8a1162953ef7 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, s ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - logistic distribution with location parameter `μ` and scale parameter `s` at - a value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a logistic distribution with location parameter `μ` and scale + parameter `s` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts index 30ed57d91e66..9d25655ae7c4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/docs/types/index.d.ts @@ -19,7 +19,7 @@ // TypeScript Version: 4.1 /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution. * * @param x - input value * @returns evaluated logarithm of CDF @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/include/stdlib/stats/base/dists/logistic/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/include/stdlib/stats/base/dists/logistic/logcdf.h index 64ca22d9061d..fc5127870099 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/include/stdlib/stats/base/dists/logistic/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/include/stdlib/stats/base/dists/logistic/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. */ double stdlib_base_dists_logistic_logcdf( const double x, const double mu, const double s ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/factory.js index 0925d75ae5ed..97c4e84491bc 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/factory.js @@ -54,7 +54,7 @@ function factory( mu, s ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js index fce918b6f607..6e4766da9670 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Logistic distribution logarithm of cumulative distribution function (CDF). +* Logistic distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/logistic/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/main.js index 1fef9686b17a..a8405486151c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/main.js @@ -28,7 +28,7 @@ var log1pexp = require( './log1pexp.js' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/native.js index 26f2a5bb67e8..978cc6a0b47b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/src/main.c index ed22fcb48296..6bd227e4fa3f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logcdf/src/main.c @@ -40,7 +40,7 @@ static double log1pexp( const double x ) { } /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md index 585f7a2f3ab5..c8813ca23724 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Logistic][logistic-distribution] distribution logarithm of [probability density function (PDF)][pdf]. +> [Logistic][logistic-distribution] distribution natural logarithm of [probability density function (PDF)][pdf].
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/logistic/logpdf' ); #### logpdf( x, mu, s ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [logistic][logistic-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [logistic][logistic-distribution] distribution with parameters `mu` (location parameter) and `s` (scale parameter). ```javascript var y = logpdf( 2.0, 0.0, 1.0 ); @@ -176,7 +176,7 @@ logEachMap( 'x: %0.4f, µ: %0.4f, s: %0.4f, ln(f(x;µ,s)): %0.4f', x, mu, s, log #### stdlib_base_dists_logistic_logpdf( x, mu, s ) -Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. ```c double out = stdlib_base_dists_logistic_logpdf( 2.0, 0.0, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/repl.txt index 73a2333e4b24..fd606108c055 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, μ, s ) - Evaluates the logarithm of the probability density function (PDF) for a - logistic distribution with location parameter `μ` and scale parameter `s` at - a value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a logistic distribution with location parameter `μ` and scale parameter + `s` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/types/index.d.ts index ff57c2c267d1..5a9eb659e8ee 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h index 8de6cb521f2f..2ceeea317bae 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/include/stdlib/stats/base/dists/logistic/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. */ double stdlib_base_dists_logistic_logpdf( const double x, const double mu, const double s ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/factory.js index 90514c924c9d..924f82250fe4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/factory.js @@ -59,7 +59,7 @@ function factory( mu, s ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a logistic distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js index a027e7db711c..d717a7a37c56 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Logistic distribution logarithm of probability density function (PDF). +* Logistic distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/logistic/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/main.js index 3cfa45f5b639..8cda2cff12bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/main.js @@ -32,7 +32,7 @@ var PINF = require( '@stdlib/constants/float64/pinf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param {number} x - input value * @param {number} mu - location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js index 255fe09e0e65..8f2238dfb563 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c index f753fcb9ab46..070995945516 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/logistic/logpdf/src/main.c @@ -26,7 +26,7 @@ #include "stdlib/constants/float64/pinf.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a logistic distribution with location parameter `mu` and scale parameter `s` at a value `x`. * * @param x input value * @param mu location parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md index 811000130ddb..927c247fb507 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Pareto (Type I)][pareto-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Pareto (Type I)][pareto-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js index 2d0e3e638999..4a92d2863e86 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/pareto-type1/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Pareto (Type I) distribution logarithm of cumulative distribution function (CDF). +* Pareto (Type I) distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/pareto-type1/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/planck/docs/types/index.d.ts index 05a98800cb3f..9c7487975ce6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/docs/types/index.d.ts @@ -123,7 +123,7 @@ interface Namespace { kurtosis: typeof kurtosis; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. * * @param x - input value * @param lambda - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/README.md index 0350cfd83d6f..49ee6ac79987 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> Evaluate the logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution. +> Evaluate the natural logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution.
@@ -50,7 +50,7 @@ var logcdf = require( '@stdlib/stats/base/dists/planck/logcdf' ); #### logcdf( x, lambda ) -Evaluates the logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution with shape parameter `lambda`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution with shape parameter `lambda`. ```javascript var y = logcdf( 2.0, 0.5 ); @@ -157,7 +157,7 @@ logEachMap( 'x: %0.4f, λ: %0.4f, ln(F(x;λ)): %0.4f', x, lambda, logcdf ); #### stdlib_base_dists_planck_logcdf( x, lambda ) -Evaluates the logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution with shape parameter `lambda`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] for a Planck (discrete exponential) distribution with shape parameter `lambda`. ```c double out = stdlib_base_dists_planck_logcdf( 2, 0.5 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/repl.txt index ba3408ecc8c8..cd195aa9cf3f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( x, λ ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Planck distribution with shape parameter `λ` at a value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Planck distribution with shape parameter `λ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/types/index.d.ts index 482736d67a81..948fd4e52fac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/docs/types/index.d.ts @@ -86,7 +86,7 @@ interface LogCDF { } /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. * * @param x - input value * @param lambda - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/include/stdlib/stats/base/dists/planck/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/include/stdlib/stats/base/dists/planck/logcdf.h index e8d45ca98b30..d4032d875891 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/include/stdlib/stats/base/dists/planck/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/include/stdlib/stats/base/dists/planck/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. */ double stdlib_base_dists_planck_logcdf( const double x, const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/factory.js index 75ebf64cebd9..187fe6f5eaf5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/factory.js @@ -52,7 +52,7 @@ function factory( lambda ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/index.js index e4d800b5e370..8adb180f1c10 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Evaluate the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. +* Evaluate the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. * * @module @stdlib/stats/base/dists/planck/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/main.js index 9df88d884593..07d6a5f9c0bf 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/main.js @@ -31,7 +31,7 @@ var PINF = require( '@stdlib/constants/float64/pinf' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda` at a value `x`. * * @param {number} x - input value * @param {PositiveNumber} lambda - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/native.js index 4c663a23a57b..02fc13332d6c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/src/main.c index 67bd9b0701f2..2ecf5fa6a3ac 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logcdf/src/main.c @@ -25,7 +25,7 @@ #include "stdlib/constants/float64/pinf.h" /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Planck distribution with shape parameter `lambda`. * * @param x input value * @param lambda shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md index f8eebb2dde8e..a84615216f84 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Mass Function -> Evaluate the logarithm of the [probability mass function][pmf] (PMF) for a Planck (discrete exponential) distribution. +> Evaluate the natural logarithm of the [probability mass function][pmf] (PMF) for a Planck (discrete exponential) distribution.
@@ -50,7 +50,7 @@ var logpmf = require( '@stdlib/stats/base/dists/planck/logpmf' ); #### logpmf( x, lambda ) -Evaluates the logarithm of the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`. +Evaluates the natural logarithm of the [probability mass function][pmf] (PMF) of a Planck (discrete exponential) distribution with shape parameter `lambda`. ```javascript var y = logpmf( 4.0, 0.3 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/repl.txt index 1ae67dfc813e..58fea0eb79ff 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( x, λ ) - Evaluates the logarithm of the probability mass function (PMF) for a Planck - distribution with shape parameter `λ` at a value `x`. + Evaluates the natural logarithm of the probability mass function (PMF) for a + Planck distribution with shape parameter `λ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/index.d.ts index 083155dc605e..f25349f9052d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPMF { /** - * Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`. + * Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h index 27027468b01b..6197fc930740 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/include/stdlib/stats/base/dists/planck/logpmf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. */ double stdlib_base_dists_planck_logpmf( const double x, const double lambda ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/factory.js index 9a02a76317c8..52700af7c59c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/factory.js @@ -51,7 +51,7 @@ function factory( lambda ) { return logpmf; /** - * Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution. + * Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js index d25c76b51148..8d29ba94e228 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Evaluate the logarithm of the probability mass function (PMF) for a Planck distribution. +* Evaluate the natural logarithm of the probability mass function (PMF) for a Planck distribution. * * @module @stdlib/stats/base/dists/planck/logpmf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/main.js index be92ba4b2b82..680ac5265781 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/main.js @@ -30,7 +30,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda` at a value `x`. * * @param {number} x - input value * @param {PositiveNumber} lambda - shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js index 0db31bda5c64..c63d30bfb2c8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c index 269ae7081fb3..311decef843c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. +* Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution with shape parameter `lambda`. * * @param x input value * @param lambda shape parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/README.md index d6dd06543660..d3f8bba7a29a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Rayleigh][rayleigh-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Rayleigh][rayleigh-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/rayleigh/logcdf' ); #### logcdf( x, sigma ) -Evaluates the logarithm of the [cumulative distribution function][cdf] for a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`. +Evaluates the natural logarithm of the [cumulative distribution function][cdf] for a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`. ```javascript var y = logcdf( 2.0, 3.0 ); @@ -177,7 +177,7 @@ logEachMap( 'x: %0.4f, σ: %0.4f, ln(F(x;σ)): %0.4f', x, sigma, logcdf ); #### stdlib_base_dists_rayleigh_logcdf( x, sigma ) -Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution. +Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution. ```c double out = stdlib_base_dists_rayleigh_logcdf( 2.0, 3.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/repl.txt index 2015966d0d4c..961b489cf8df 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/repl.txt @@ -1,7 +1,8 @@ {{alias}}( x, sigma ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Rayleigh distribution with scale parameter `sigma` at a value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value + `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/types/index.d.ts index 5a227f58eb79..52df090a5915 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/include/stdlib/stats/base/dists/rayleigh/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/include/stdlib/stats/base/dists/rayleigh/logcdf.h index c0ebc1f9298f..483353f22ab6 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/include/stdlib/stats/base/dists/rayleigh/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/include/stdlib/stats/base/dists/rayleigh/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. */ double stdlib_base_dists_rayleigh_logcdf( const double x, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/factory.js index 0e51ae120425..27c167e7c97c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/factory.js @@ -60,7 +60,7 @@ function factory( sigma ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/index.js index a3e3ef7fdc7a..3cc3482953d2 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Rayleigh distribution logarithm of cumulative distribution function (CDF). +* Rayleigh distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/rayleigh/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/main.js index fa36360e5122..62d2b12a15da 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/main.js @@ -33,7 +33,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @param {number} x - input value * @param {NonNegativeNumber} sigma - scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/native.js index 571f43b7454f..17cb4af7a0e9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/src/main.c index e460ad11c40b..6ab4afbec6a1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logcdf/src/main.c @@ -27,7 +27,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @param x input value * @param sigma scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/README.md index 278a49d6c768..ed8c23502a64 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Rayleigh][rayleigh-distribution] distribution logarithm of [probability density function][pdf] (PDF). +> [Rayleigh][rayleigh-distribution] distribution natural logarithm of [probability density function][pdf] (PDF).
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/rayleigh/logpdf' ); #### logpdf( x, sigma ) -Evaluates the logarithm of the [probability density function][pdf] for a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`. +Evaluates the natural logarithm of the [probability density function][pdf] for a [Rayleigh][rayleigh-distribution] distribution with scale parameter `sigma`. ```javascript var y = logpdf( 0.3, 1.0 ); @@ -178,7 +178,7 @@ logEachMap( 'x: %0.4f, σ: %0.4f, ln(f(x;σ)): %0.4f', x, sigma, logpdf ); #### stdlib_base_dists_rayleigh_logpdf( x, sigma ) -Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution. +Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution. ```c double out = stdlib_base_dists_rayleigh_logpdf( 0.3, 1.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/repl.txt index 39b4c032faf3..822e5f6bf06d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/repl.txt @@ -1,7 +1,7 @@ {{alias}}( x, sigma ) - Evaluates the logarithm of the probability density function (PDF) for a - Rayleigh distribution with scale parameter `sigma` at a value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Rayleigh distribution with scale parameter `sigma` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/types/index.d.ts index a996d0fdf268..c3cddf6e8310 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/include/stdlib/stats/base/dists/rayleigh/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/include/stdlib/stats/base/dists/rayleigh/logpdf.h index 0e2f7ba91f6c..b090a776f809 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/include/stdlib/stats/base/dists/rayleigh/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/include/stdlib/stats/base/dists/rayleigh/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. */ double stdlib_base_dists_rayleigh_logpdf( const double x, const double sigma ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/factory.js index 67d6a3fc3d25..9911152b2af4 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/factory.js @@ -59,7 +59,7 @@ function factory( sigma ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/index.js index 11e8fb18e93a..c21badd5773b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Rayleigh distribution logarithm of probability density function (PDF). +* Rayleigh distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/rayleigh/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/main.js index 29ad4c033c3c..55cf2c922f76 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/main.js @@ -30,7 +30,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @param {number} x - input value * @param {NonNegativeNumber} sigma - scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/native.js index cde8f69b8195..dea7bbface70 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/src/main.c index f8bca43bce39..cfa6d9962357 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/rayleigh/logpdf/src/main.c @@ -24,7 +24,7 @@ #include "stdlib/constants/float64/ninf.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a Rayleigh distribution with scale parameter `sigma` at a value `x`. * * @param x input value * @param sigma scale parameter diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/README.md index ab2a0ca7c793..c1a7a619b84c 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Triangular][triangular-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Triangular][triangular-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/lib/index.js index 957ff9faa694..93d8a1099cb5 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Triangular distribution logarithm of cumulative distribution function (CDF). +* Triangular distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/triangular/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md index 70ac2dc0af6f..a4a0cc7013d3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Triangular][triangular-distribution] distribution logarithm of [probability density function][pdf] (PDF). +> [Triangular][triangular-distribution] distribution natural logarithm of [probability density function][pdf] (PDF).
diff --git a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/lib/index.js index 8197fb358a61..10d9d70af836 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/triangular/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Triangular distribution logarithm of probability density function (PDF). +* Triangular distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/triangular/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/README.md index d5eebad9161e..680b7ba00808 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Uniform][uniform-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Uniform][uniform-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
@@ -55,7 +55,7 @@ var logcdf = require( '@stdlib/stats/base/dists/uniform/logcdf' ); #### logcdf( x, a, b ) -Evaluates the logarithm of the [cumulative distribution function][cdf] (CDF) for a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```javascript var y = logcdf( 9.0, 0.0, 10.0 ); @@ -175,7 +175,7 @@ for ( i = 0; i < 25; i++ ) { #### stdlib_base_dists_uniform_logcdf( x, a, b ) -Evaluates the logarithm of the [cumulative distribution function][cdf] of a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [cumulative distribution function][cdf] of a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```c double out = stdlib_base_dists_uniform_logcdf( 9.0, 0.0, 10.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/repl.txt index 8c55c288b969..e55534791044 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, a, b ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - uniform distribution with minimum support `a` and maximum support `b` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a uniform distribution with minimum support `a` and maximum + support `b` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/types/index.d.ts index a4763044c5dd..5253705c3236 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogCDF { /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/include/stdlib/stats/base/dists/uniform/logcdf.h b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/include/stdlib/stats/base/dists/uniform/logcdf.h index be36c6c59c88..55355a04a0c9 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/include/stdlib/stats/base/dists/uniform/logcdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/include/stdlib/stats/base/dists/uniform/logcdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the cumulative distribution function (logcdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (logcdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. */ double stdlib_base_dists_uniform_logcdf( const double x, const double a, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/factory.js index 933710ab1e85..a6ec62b08696 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/factory.js @@ -54,7 +54,7 @@ function factory( a, b ) { return logcdf; /** - * Evaluates the logarithm of the cumulative distribution function (CDF) for a uniform distribution. + * Evaluates the natural logarithm of the cumulative distribution function (CDF) for a uniform distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/index.js index 3ce7f919f247..58ddb6f5b201 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Uniform distribution logarithm of cumulative distribution function (CDF). +* Uniform distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/uniform/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/main.js index d7f1c1ca2831..f2ec0aa4b6fa 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/main.js @@ -28,7 +28,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param {number} x - input value * @param {number} a - minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/native.js index 75643d09927d..bc17ab037a7e 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the cumulative distribution function (logcdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (logcdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/src/main.c index 91b403ea981c..9210923dfdb3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logcdf/src/main.c @@ -22,7 +22,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param x input value * @param a minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md index 6ffef1a8eda5..4021e818264f 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Uniform][uniform-distribution] distribution logarithm of [probability density function][pdf] (PDF). +> [Uniform][uniform-distribution] distribution natural logarithm of [probability density function][pdf] (PDF).
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/uniform/logpdf' ); #### logpdf( x, a, b ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [continuous uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [continuous uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```javascript var y = logpdf( 2.0, 0.0, 4.0 ); @@ -175,7 +175,7 @@ for ( i = 0; i < 25; i++ ) { #### stdlib_base_dists_uniform_logpdf( x, a, b ) -Evaluates the logarithm of the [probability density function][pdf] of a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). +Evaluates the natural logarithm of the [probability density function][pdf] of a [uniform][uniform-distribution] distribution with parameters `a` (minimum support) and `b` (maximum support). ```c double out = stdlib_base_dists_uniform_logpdf( 2.0, 0.0, 4.0 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/repl.txt index f377f9a5359a..89a3565b95b1 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, a, b ) - Evaluates the logarithm of the probability density function (PDF) for a - uniform distribution with minimum support `a` and maximum support `b` at a - value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a uniform distribution with minimum support `a` and maximum support `b` + at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. @@ -29,7 +29,7 @@ > var y = {{alias}}( 2.0, 0.0, 4.0 ) ~-1.386 > y = {{alias}}( 5.0, 0.0, 4.0 ) - -infinity + -Infinity > y = {{alias}}( 0.25, 0.0, 1.0 ) 0.0 > y = {{alias}}( NaN, 0.0, 1.0 ) @@ -66,7 +66,7 @@ > var y = mylogPDF( 7.0 ) 0.0 > y = mylogPDF( 5.0 ) - -infinity + -Infinity See Also -------- diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/types/index.d.ts index 35adae9dd9a6..4799868e6659 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/docs/types/index.d.ts @@ -31,7 +31,7 @@ type Unary = ( x: number ) => number; */ interface LogPDF { /** - * Evaluates the logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. + * Evaluates the natural logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * ## Notes * diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/include/stdlib/stats/base/dists/uniform/logpdf.h b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/include/stdlib/stats/base/dists/uniform/logpdf.h index 78b4085cbe3c..d6924dd5dd1a 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/include/stdlib/stats/base/dists/uniform/logpdf.h +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/include/stdlib/stats/base/dists/uniform/logpdf.h @@ -27,7 +27,7 @@ extern "C" { #endif /** -* Evaluates the logarithm of the probability density function (logpdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (logpdf) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. */ double stdlib_base_dists_uniform_logpdf( const double x, const double a, const double b ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/factory.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/factory.js index f7196074a697..c22b96eaf103 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/factory.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/factory.js @@ -54,7 +54,7 @@ function factory( a, b ) { return logpdf; /** - * Evaluates the logarithm of the probability density function (PDF) for a uniform distribution. + * Evaluates the natural logarithm of the probability density function (PDF) for a uniform distribution. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js index 630f606f6d80..a351daf258d8 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Uniform distribution logarithm of probability density function (PDF). +* Uniform distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/uniform/logpdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js index 5d1b626bd988..c9b4238b3b35 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/main.js @@ -28,7 +28,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param {number} x - input value * @param {number} a - minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/native.js b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/native.js index f3f4f1ab5dd6..a3e3e2ea547b 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/native.js +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/lib/native.js @@ -26,7 +26,7 @@ var addon = require( './../src/addon.node' ); // MAIN // /** -* Evaluates the logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @private * @param {number} x - input value diff --git a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c index 0d7f74ea97ef..391213363a11 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c +++ b/lib/node_modules/@stdlib/stats/base/dists/uniform/logpdf/src/main.c @@ -22,7 +22,7 @@ #include "stdlib/math/base/special/ln.h" /** -* Evaluates the logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. +* Evaluates the natural logarithm of the probability density function (PDF) for a uniform distribution with minimum support `a` and maximum support `b` at a value `x`. * * @param x input value * @param a minimum support diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md index 49e81ac68c53..0640bbc462a0 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Cumulative Distribution Function -> [Weibull][weibull-distribution] distribution logarithm of [cumulative distribution function][cdf]. +> [Weibull][weibull-distribution] distribution natural logarithm of [cumulative distribution function][cdf].
diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/docs/repl.txt index b8c53fce36b9..af713ab0bbf3 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, k, λ ) - Evaluates the logarithm of the cumulative distribution function (CDF) for a - Weibull distribution with shape parameter `k` and scale parameter `λ` at a - value `x`. + Evaluates the natural logarithm of the cumulative distribution function + (CDF) for a Weibull distribution with shape parameter `k` and scale + parameter `λ` at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/index.js index f58ee685de2d..d21b8ac05d32 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logcdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Weibull distribution logarithm of cumulative distribution function (CDF). +* Weibull distribution natural logarithm of cumulative distribution function (CDF). * * @module @stdlib/stats/base/dists/weibull/logcdf * diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/README.md b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/README.md index 7206ca80c548..aecb39415263 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/README.md +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/README.md @@ -20,7 +20,7 @@ limitations under the License. # Logarithm of Probability Density Function -> [Weibull][weibull-distribution] distribution logarithm of [probability density function][pdf] (PDF). +> [Weibull][weibull-distribution] distribution natural logarithm of [probability density function][pdf] (PDF).
@@ -55,7 +55,7 @@ var logpdf = require( '@stdlib/stats/base/dists/weibull/logpdf' ); #### logpdf( x, k, lambda ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. ```javascript var y = logpdf( 2.0, 1.0, 0.5 ); @@ -179,7 +179,7 @@ logEachMap( 'x: %0.4f, k: %0.4f, λ: %0.4f, ln(f(x;k,λ)): %0.4f', x, k, lambda, #### stdlib_base_dists_weibull_logpdf( x, k, lambda ) -Evaluates the logarithm of the [probability density function][pdf] (PDF) for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. +Evaluates the natural logarithm of the [probability density function][pdf] (PDF) for a [Weibull][weibull-distribution] distribution with [shape parameter][shape] `k` and [scale parameter][scale] `lambda`. ```c double out = stdlib_base_dists_weibull_logpdf( 2.0, 1.0, 0.5 ); diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/docs/repl.txt index 6ff6965172c7..c37a59c00a1d 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/docs/repl.txt +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/docs/repl.txt @@ -1,8 +1,8 @@ {{alias}}( x, k, λ ) - Evaluates the logarithm of the probability density function (PDF) for a - Weibull distribution with shape parameter `k` and scale parameter `λ` at a - value `x`. + Evaluates the natural logarithm of the probability density function (PDF) + for a Weibull distribution with shape parameter `k` and scale parameter `λ` + at a value `x`. If provided `NaN` as any argument, the function returns `NaN`. diff --git a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js index a9ae1f01c69b..032e6bf7dc41 100644 --- a/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js +++ b/lib/node_modules/@stdlib/stats/base/dists/weibull/logpdf/lib/index.js @@ -19,7 +19,7 @@ 'use strict'; /** -* Weibull distribution logarithm of probability density function (PDF). +* Weibull distribution natural logarithm of probability density function (PDF). * * @module @stdlib/stats/base/dists/weibull/logpdf *