Skip to content

Commit

Permalink
docs: fix parameter descriptions in Weibull distribution packages
Browse files Browse the repository at this point in the history
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: na
  - task: lint_javascript_tests
    status: na
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: passed
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: passed
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---
  • Loading branch information
Planeshifter committed Dec 29, 2024
1 parent 4e93083 commit b87254d
Show file tree
Hide file tree
Showing 35 changed files with 116 additions and 116 deletions.
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/array/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -821,8 +821,8 @@ interface Namespace {
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
*
* @param len - array length
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @returns output array
*
Expand Down
24 changes: 12 additions & 12 deletions lib/node_modules/@stdlib/random/array/weibull/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -138,8 +138,8 @@ interface TernaryFunction extends PRNG {
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
*
* @param len - array length
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @returns output array
*/
Expand All @@ -148,8 +148,8 @@ interface TernaryFunction extends PRNG {
/**
* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param out - output array
* @returns output array
*/
Expand All @@ -164,8 +164,8 @@ interface Random extends PRNG {
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
*
* @param len - array length
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @returns output array
*
Expand All @@ -178,8 +178,8 @@ interface Random extends PRNG {
/**
* Fills an array with pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param out - output array
* @returns output array
*
Expand All @@ -204,8 +204,8 @@ interface Random extends PRNG {
*
* - When provided distribution parameters, the returned function returns random variates drawn from the specified distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @throws must provide a valid state
* @returns function for creating arrays
Expand Down Expand Up @@ -256,8 +256,8 @@ interface Random extends PRNG {
* Returns an array containing pseudorandom numbers drawn from a Weibull distribution.
*
* @param len - array length
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @returns output array
*
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/array/weibull/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var factory = require( './factory.js' );
* @name weibull
* @type {Function}
* @param {NonNegativeInteger} len - array length
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @param {Options} [options] - options
* @param {string} [options.dtype="float64"] - output array data type
* @throws {TypeError} first argument must be a nonnegative integer
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/base/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1017,8 +1017,8 @@ interface Namespace {
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns pseudorandom number
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,8 @@ interface BinaryFunction extends PRNG {
/**
* Returns a Weibull distributed pseudorandom number.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns pseudorandom number
*/
( k: number, lambda: number ): number;
Expand All @@ -132,8 +132,8 @@ interface Random extends PRNG {
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns pseudorandom number
*
* @example
Expand All @@ -149,8 +149,8 @@ interface Random extends PRNG {
*
* - When provided `k` and `lambda`, the returned PRNG returns random variates drawn from the specified distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - function options
* @param options.prng - pseudorandom number generator which generates uniformly distributed pseudorandom numbers
* @param options.seed - pseudorandom number generator seed
Expand Down Expand Up @@ -213,8 +213,8 @@ interface Random extends PRNG {
* - If `k <= 0` or `lambda <= 0`, the function returns `NaN`.
* - If `k` or `lambda` is `NaN`, the function returns `NaN`.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns pseudorandom number
*
* @example
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/base/weibull/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ var factory = require( './factory.js' );
*
* @name weibull
* @type {PRNG}
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {NonNegativeNumber} pseudorandom number
*
* @example
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/base/weibull/lib/validate.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ var format = require( '@stdlib/string/format' );
* Validates parameters.
*
* @private
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {(Error|null)} error or null
*
* @example
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/base/weibull/lib/weibull.js
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var ln = require( '@stdlib/math/base/special/ln' );
*
* @private
* @param {PRNG} rand - PRNG for generating uniformly distributed numbers
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {NonNegativeNumber} pseudorandom number
*/
function weibull( rand, k, lambda ) {
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/streams/docs/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3641,8 +3641,8 @@ interface Namespace {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,8 +86,8 @@ declare class RandomStream extends Readable {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down Expand Up @@ -207,8 +207,8 @@ interface Constructor {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down Expand Up @@ -236,8 +236,8 @@ interface Constructor {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down Expand Up @@ -265,8 +265,8 @@ interface Constructor {
/**
* Returns a function for creating readable streams which generate pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @returns factory function
*
Expand Down Expand Up @@ -317,8 +317,8 @@ interface Constructor {
/**
* Returns an "objectMode" readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down Expand Up @@ -347,8 +347,8 @@ interface Constructor {
/**
* Returns a readable stream for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @param options - stream options
* @throws `k` must be a positive number
* @throws `lambda` must be a positive number
Expand Down
4 changes: 2 additions & 2 deletions lib/node_modules/@stdlib/random/streams/weibull/lib/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ function destroy( error ) {
* Stream constructor for generating a stream of pseudorandom numbers drawn from a Weibull distribution.
*
* @constructor
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @param {Options} [options] - stream options
* @param {boolean} [options.objectMode=false] - specifies whether the stream should operate in object mode
* @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to strings
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var RandomStream = require( './main.js' );
/**
* Returns an "objectMode" readable stream for generating pseudorandom numbers drawn from a Weibull distribution.
*
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @param {Options} [options] - stream options
* @param {(string|null)} [options.encoding=null] - specifies how `Buffer` objects should be decoded to `strings`
* @param {NonNegativeNumber} [options.highWaterMark] - specifies the maximum number of objects to store in an internal buffer before ceasing to generate additional pseudorandom numbers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -189,8 +189,8 @@ double out = stdlib_base_dists_weibull_cdf( 2.0, 1.0, 1.0 );
The function accepts the following arguments:

- **x**: `[in] double` input value.
- **k**: `[in] double` scale parameter.
- **lambda**: `[in] double` shape parameter.
- **k**: `[in] double` shape parameter.
- **lambda**: `[in] double` scale parameter.

```c
double stdlib_base_dists_weibull_cdf( const double x, const double k, const double lambda );
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ interface CDF {
* - If provided a non-positive value for `lambda` or `k`, the function returns `NaN`.
*
* @param x - input value
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns evaluated CDF
*
* @example
Expand Down Expand Up @@ -79,8 +79,8 @@ interface CDF {
/**
* Returns a function for evaluating the cumulative distribution function (CDF) for a Weibull distribution.
*
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns CDF
*
* @example
Expand All @@ -98,8 +98,8 @@ interface CDF {
* Weibull distribution cumulative distribution function (CDF).
*
* @param x - input value
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns evaluated CDF
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var pow = require( '@stdlib/math/base/special/pow' );
/**
* Returns a function for evaluating the cumulative distribution function (CDF) for a Weibull distribution.
*
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {Function} CDF
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ var pow = require( '@stdlib/math/base/special/pow' );
* Evaluates the cumulative distribution function (CDF) for a Weibull distribution with scale parameter `k` and shape parameter `lambda` at a value `x`.
*
* @param {number} x - input value
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {Probability} evaluated CDF
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ var addon = require( './../src/addon.node' );
*
* @private
* @param {number} x - input value
* @param {PositiveNumber} k - scale parameter
* @param {PositiveNumber} lambda - shape parameter
* @param {PositiveNumber} k - shape parameter
* @param {PositiveNumber} lambda - scale parameter
* @returns {Probability} evaluated CDF
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
* Evaluates the cumulative distribution function (CDF) for a Weibull distribution with scale parameter `k` and shape parameter `lambda` at a value `x`.
*
* @param x input value
* @param k scale parameter
* @param lambda shape parameter
* @param k shape parameter
* @param lambda scale parameter
* @return evaluated CDF
*
* @example
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ interface Namespace {
* Weibull distribution cumulative distribution function (CDF).
*
* @param x - input value
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns evaluated CDF
*
* @example
Expand Down Expand Up @@ -149,8 +149,8 @@ interface Namespace {
* Weibull distribution logarithm of cumulative distribution function (CDF).
*
* @param x - input value
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns evaluated logCDF
*
* @example
Expand Down Expand Up @@ -351,8 +351,8 @@ interface Namespace {
* Weibull distribution quantile function.
*
* @param p - input value
* @param k - scale parameter
* @param lambda - shape parameter
* @param k - shape parameter
* @param lambda - scale parameter
* @returns evaluated quantile function
*
* @example
Expand Down
Loading

1 comment on commit b87254d

@stdlib-bot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
random/array $\color{green}375/375$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}375/375$
$\color{green}+100.00\%$
random/array/weibull $\color{green}212/212$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}212/212$
$\color{green}+100.00\%$
random/base $\color{green}421/421$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}421/421$
$\color{green}+100.00\%$
random/base/weibull $\color{green}500/500$
$\color{green}+100.00\%$
$\color{green}55/55$
$\color{green}+100.00\%$
$\color{green}12/12$
$\color{green}+100.00\%$
$\color{green}500/500$
$\color{green}+100.00\%$
random/streams $\color{green}411/411$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}411/411$
$\color{green}+100.00\%$
random/streams/weibull $\color{green}819/819$
$\color{green}+100.00\%$
$\color{green}95/95$
$\color{green}+100.00\%$
$\color{green}15/15$
$\color{green}+100.00\%$
$\color{green}819/819$
$\color{green}+100.00\%$
stats/base/dists/weibull/cdf $\color{green}298/298$
$\color{green}+100.00\%$
$\color{green}25/25$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}298/298$
$\color{green}+100.00\%$
stats/base/dists/weibull $\color{green}177/177$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}177/177$
$\color{green}+100.00\%$
stats/base/dists/weibull/logcdf $\color{green}311/311$
$\color{green}+100.00\%$
$\color{green}28/28$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}311/311$
$\color{green}+100.00\%$
stats/base/dists/weibull/logpdf $\color{green}308/308$
$\color{green}+100.00\%$
$\color{green}35/35$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}308/308$
$\color{green}+100.00\%$
stats/base/dists/weibull/median $\color{green}197/197$
$\color{green}+100.00\%$
$\color{green}10/10$
$\color{green}+100.00\%$
$\color{green}2/2$
$\color{green}+100.00\%$
$\color{green}197/197$
$\color{green}+100.00\%$
stats/base/dists/weibull/pdf $\color{green}310/310$
$\color{green}+100.00\%$
$\color{green}36/36$
$\color{green}+100.00\%$
$\color{green}4/4$
$\color{green}+100.00\%$
$\color{green}310/310$
$\color{green}+100.00\%$
stats/base/dists/weibull/quantile $\color{green}218/218$
$\color{green}+100.00\%$
$\color{green}23/23$
$\color{green}+100.00\%$
$\color{green}3/3$
$\color{green}+100.00\%$
$\color{green}218/218$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.