Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ var logcdf = require( '@stdlib/stats/base/dists/lognormal/logcdf' );

#### logcdf( x, mu, sigma )

Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [lognormal][lognormal-distribution] distribution with parameters `mu` (mean) and `sigma` (standard deviation).
Evaluates the natural logarithm of the [cumulative distribution function][cdf] (CDF) for a [lognormal][lognormal-distribution] distribution with parameters `mu` (location parameter) and `sigma` (scale parameter).

```javascript
var y = logcdf( 2.0, 0.0, 1.0 );
Expand Down Expand Up @@ -83,7 +83,7 @@ y = logcdf( 10.0, 8.0, 0.0 );

#### logcdf.factory( mu, sigma )

Returns a `function` for evaluating the [cumulative distribution function][cdf] (CDF) of a [lognormal][lognormal-distribution] distribution with parameters `mu` (mean) and `sigma` (standard deviation).
Returns a `function` for evaluating the [cumulative distribution function][cdf] (CDF) of a [lognormal][lognormal-distribution] distribution with parameters `mu` (location parameter) and `sigma` (scale parameter).

```javascript
var mylogcdf = logcdf.factory( 10.0, 2.0 );
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

{{alias}}( x, μ, σ )
Evaluates the natural logarithm of the cumulative distribution function
(CDF) for a lognormal distribution with mean `μ` and standard deviation `σ`
at a value `x`.
(CDF) for a lognormal distribution with location parameter `μ` and scale
parameter `σ` at a value `x`.

If provided `NaN` as any argument, the function returns `NaN`.

Expand All @@ -17,7 +17,7 @@
Location parameter.

σ: number
Standard deviation.
Scale parameter.

Returns
-------
Expand All @@ -37,7 +37,7 @@
> y = {{alias}}( 0.0, 0.0, NaN )
NaN

// Negative standard deviation:
// Negative scale parameter:
> y = {{alias}}( 2.0, 0.0, -1.0 )
NaN

Expand All @@ -50,16 +50,16 @@

{{alias}}.factory( μ, σ )
Returns a function for evaluating the natural logarithm of the cumulative
distribution function (CDF) of a lognormal distribution with mean `μ` and
standard deviation `σ`.
distribution function (CDF) of a lognormal distribution with location
parameter `μ` and scale parameter `σ`.

Parameters
----------
μ: number
Location parameter.

σ: number
Standard deviation.
Scale parameter.

Returns
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,15 @@ type Unary = ( x: number ) => number;
*/
interface LogCDF {
/**
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with mean `mu` and standard deviation `sigma` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma` at a value `x`.
*
* ## Notes
*
* - If provided `sigma < 0`, the function returns `NaN`.
*
* @param x - input value
* @param mu - mean
* @param sigma - standard deviation
* @param mu - location parameter
* @param sigma - scale parameter
* @returns logarithm of cumulative distribution function
*
* @example
Expand All @@ -63,7 +63,7 @@ interface LogCDF {
* // returns NaN
*
* @example
* // Negative standard deviation:
* // Negative scale parameter:
* var y = logcdf( 2.0, 0.0, -1.0 );
* // returns NaN
*
Expand All @@ -78,10 +78,10 @@ interface LogCDF {
( x: number, mu: number, sigma: number ): number;

/**
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution.
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma`.
*
* @param mu - mean
* @param sigma - standard deviation
* @param mu - location parameter
* @param sigma - scale parameter
* @returns logcdf
*
* @example
Expand All @@ -99,8 +99,8 @@ interface LogCDF {
* Lognormal distribution natural logarithm of cumulative distribution function (CDF).
*
* @param x - input value
* @param mu - mean
* @param sigma - standard deviation
* @param mu - location parameter
* @param sigma - scale parameter
* @returns evaluated logcdf
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,10 +31,10 @@ var NINF = require( '@stdlib/constants/float64/ninf' );
// MAIN //

/**
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution.
* Returns a function for evaluating the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma`.
*
* @param {number} mu - mean
* @param {NonNegativeNumber} sigma - standard deviation
* @param {number} mu - location parameter
* @param {NonNegativeNumber} sigma - scale parameter
* @returns {Function} logcdf
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,11 @@ var NINF = require( '@stdlib/constants/float64/ninf' );
// MAIN //

/**
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with mean `mu` and standard deviation `sigma` at a value `x`.
* Evaluates the natural logarithm of the cumulative distribution function (CDF) for a lognormal distribution with location parameter `mu` and scale parameter `sigma` at a value `x`.
*
* @param {number} x - input value
* @param {number} mu - mean
* @param {NonNegativeNumber} sigma - standard deviation
* @param {number} mu - location parameter
* @param {NonNegativeNumber} sigma - scale parameter
* @returns {number} logarithm of cumulative distribution function
*
* @example
Expand All @@ -56,7 +56,7 @@ var NINF = require( '@stdlib/constants/float64/ninf' );
* // returns NaN
*
* @example
* // Negative standard deviation:
* // Negative scale parameter:
* var y = logcdf( 2.0, 0.0, -1.0 );
* // returns NaN
*
Expand Down