Skip to content

Commit 3745a55

Browse files
kgrytekgryte
committed
chore: clean-up
--- 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: passed - task: lint_repl_help status: passed - task: lint_javascript_src status: passed - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: passed - task: lint_javascript_benchmarks status: na - task: lint_python status: missing_dependencies - task: lint_r status: na - task: lint_c_src status: na - 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: passed - 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: na - 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 ---
1 parent 5a34c1c commit 3745a55

File tree

8 files changed

+28
-28
lines changed

8 files changed

+28
-28
lines changed

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ limitations under the License.
2020

2121
# Logarithm of Probability Mass Function
2222

23-
> Planck (discrete exponential) distribution logarithm of [probability mass function][pmf] (PMF).
23+
> Evaluate the logarithm of the [probability mass function][pmf] (PMF) for a Planck (discrete exponential) distribution.
2424
2525
<section class="intro">
2626

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/repl.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
{{alias}}( x, λ )
3-
Evaluates the logarithm of the probability mass function (PMF) for a
4-
Planck distribution with shape parameter `λ` at a value `x`.
3+
Evaluates the logarithm of the probability mass function (PMF) for a Planck
4+
distribution with shape parameter `λ` at a value `x`.
55

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

@@ -49,7 +49,7 @@
4949
Returns
5050
-------
5151
logpmf: Function
52-
Logarithm of probability mass function (PMF).
52+
Logarithm of the probability mass function (PMF).
5353

5454
Examples
5555
--------

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/index.d.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ interface LogPMF {
8686
}
8787

8888
/**
89-
* Planck distribution natural logarithm of probability mass function (PMF).
89+
* Evaluates the natural logarithm of the probability mass function (PMF) for a Planck distribution.
9090
*
9191
* @param x - input value
9292
* @param lambda - shape parameter

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/docs/types/test.ts‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ import logpmf = require( './index' );
2323

2424
// The function returns a number...
2525
{
26-
logpmf( 2, 0.4 ); // $ExpectType number
27-
logpmf( 1, 0.2 ); // $ExpectType number
26+
logpmf( 2.0, 0.4 ); // $ExpectType number
27+
logpmf( 1.0, 0.2 ); // $ExpectType number
2828
}
2929

3030
// The compiler throws an error if the function is provided values other than two numbers...
@@ -36,19 +36,19 @@ import logpmf = require( './index' );
3636
logpmf( {}, 0.4 ); // $ExpectError
3737
logpmf( ( x: number ): number => x, 0.2 ); // $ExpectError
3838

39-
logpmf( 0, true ); // $ExpectError
40-
logpmf( 1, false ); // $ExpectError
41-
logpmf( 0, '5' ); // $ExpectError
42-
logpmf( 1, [] ); // $ExpectError
43-
logpmf( 2, {} ); // $ExpectError
44-
logpmf( 3, ( x: number ): number => x ); // $ExpectError
39+
logpmf( 0.0, true ); // $ExpectError
40+
logpmf( 1.0, false ); // $ExpectError
41+
logpmf( 0.0, '5' ); // $ExpectError
42+
logpmf( 1.0, [] ); // $ExpectError
43+
logpmf( 2.0, {} ); // $ExpectError
44+
logpmf( 3.0, ( x: number ): number => x ); // $ExpectError
4545
}
4646

4747
// The compiler throws an error if the function is provided an unsupported number of arguments...
4848
{
4949
logpmf(); // $ExpectError
50-
logpmf( 0 ); // $ExpectError
51-
logpmf( 1, 0.3, 4 ); // $ExpectError
50+
logpmf( 0.0 ); // $ExpectError
51+
logpmf( 1.0, 0.3, 4.0 ); // $ExpectError
5252
}
5353

5454
// Attached to main export is a `factory` method which returns a function...
@@ -59,7 +59,7 @@ import logpmf = require( './index' );
5959
// The `factory` method returns a function which returns a number...
6060
{
6161
const fcn = logpmf.factory( 0.4 );
62-
fcn( 2 ); // $ExpectType number
62+
fcn( 2.0 ); // $ExpectType number
6363
}
6464

6565
// The compiler throws an error if the function returned by the `factory` method is provided an invalid argument...
@@ -77,8 +77,8 @@ import logpmf = require( './index' );
7777
{
7878
const fcn = logpmf.factory( 0.4 );
7979
fcn(); // $ExpectError
80-
fcn( 2, 0 ); // $ExpectError
81-
fcn( 2, 0, 1 ); // $ExpectError
80+
fcn( 2.0, 0.0 ); // $ExpectError
81+
fcn( 2.0, 0.0, 1.0 ); // $ExpectError
8282
}
8383

8484
// The compiler throws an error if the `factory` method is provided a value other than a number...
@@ -93,6 +93,6 @@ import logpmf = require( './index' );
9393

9494
// The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
9595
{
96-
logpmf.factory( 0, 0.2 ); // $ExpectError
97-
logpmf.factory( 0, 0.4, 8 ); // $ExpectError
96+
logpmf.factory( 0.0, 0.2 ); // $ExpectError
97+
logpmf.factory( 0.0, 0.4, 8.0 ); // $ExpectError
9898
}

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/lib/index.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
'use strict';
2020

2121
/**
22-
* Planck distribution logarithm of probability mass function (PMF).
22+
* Evaluate the logarithm of the probability mass function (PMF) for a Planck distribution.
2323
*
2424
* @module @stdlib/stats/base/dists/planck/logpmf
2525
*

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@stdlib/stats/base/dists/planck/logpmf",
33
"version": "0.0.0",
4-
"description": "Planck (discrete exponential) distribution logarithm of probability mass function (PMF).",
4+
"description": "Evaluate the logarithm of the probability mass function (PMF) for a Planck (discrete exponential) distribution.",
55
"license": "Apache-2.0",
66
"author": {
77
"name": "The Stdlib Authors",

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/test/fixtures/python/runner.py‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def gen(x, lam, name):
4343
# Examples
4444
4545
```python
46-
python> x = np.random.rand(1000) * 10
46+
python> x = np.random.rand(1000) * 10.0
4747
python> lam = np.random.rand(1000)
4848
python> gen(x, lam, "data.json")
4949
```
@@ -72,7 +72,7 @@ def gen(x, lam, name):
7272

7373
def main():
7474
"""Generate fixture data."""
75-
# Large shape paramter:
75+
# Large shape parameter:
7676
x = np.round(np.random.rand(1000) * 10.0)
7777
lam = (np.random.rand(1000) * 10.0) + 10.0
7878
gen(x, lam, "large_lambda.json")

‎lib/node_modules/@stdlib/stats/base/dists/planck/logpmf/test/test.factory.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ tape( 'the function returns a function', function test( t ) {
4949
t.end();
5050
});
5151

52-
tape( 'if provided `NaN` for any parameter, the created function returns `NaN`', function test( t ) {
52+
tape( 'if provided `NaN` for any parameter, the returned function returns `NaN`', function test( t ) {
5353
var logpmf;
5454
var y;
5555

@@ -112,7 +112,7 @@ tape( 'if provided a finite `lambda`, the function returns a function which retu
112112
t.end();
113113
});
114114

115-
tape( 'if provided a `lambda` which is nonpositive, the created function always returns `NaN`', function test( t ) {
115+
tape( 'if provided a `lambda` which is nonpositive, the returned function always returns `NaN`', function test( t ) {
116116
var logpmf;
117117
var y;
118118

@@ -135,7 +135,7 @@ tape( 'if provided a `lambda` which is nonpositive, the created function always
135135
t.end();
136136
});
137137

138-
tape( 'the created function evaluates the logpmf for `x` given small `lambda`', function test( t ) {
138+
tape( 'the returned function evaluates the logpmf for `x` given small `lambda`', function test( t ) {
139139
var expected;
140140
var logpmf;
141141
var lambda;
@@ -162,7 +162,7 @@ tape( 'the created function evaluates the logpmf for `x` given small `lambda`',
162162
t.end();
163163
});
164164

165-
tape( 'the created function evaluates the logpmf for `x` given large `lambda`', function test( t ) {
165+
tape( 'the returned function evaluates the logpmf for `x` given large `lambda`', function test( t ) {
166166
var expected;
167167
var logpmf;
168168
var lambda;

0 commit comments

Comments
 (0)