fix: require sigma be greater than zero

kgryte · kgryte · commit a1fbf4635c30 · 2026-01-16T00:53:04.000-08:00
---
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: 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: 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: passed
  - task: lint_license_headers
    status: passed
---
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/README.md
@@ -36,7 +36,7 @@ The [standard deviation][standard-deviation] for a [half-normal][half-normal-dis
 
 <!-- </equation> -->
 
-where `σ >= 0` is the scale parameter.
+where `σ > 0` is the scale parameter.
 
 </section>
 
@@ -64,7 +64,7 @@ y = stdev( 3.5 );
 // returns ~2.1098
 ```
 
-If provided `sigma < 0`, the function returns `NaN`.
+If provided `sigma <= 0`, the function returns `NaN`.
 
 ```javascript
 var y = stdev( -1.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/docs/repl.txt b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/docs/repl.txt
@@ -1,7 +1,7 @@
 {{alias}}( σ )
     Returns the standard deviation of a half-normal distribution.
 
-    If provided `σ < 0`, the function returns `NaN`.
+    If provided `σ <= 0`, the function returns `NaN`.
 
     Parameters
     ----------
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/docs/types/index.d.ts b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/docs/types/index.d.ts
@@ -23,7 +23,7 @@
 *
 * ## Notes
 *
-* -   If provided `σ < 0`, the function returns `NaN`.
+* -   If provided `σ <= 0`, the function returns `NaN`.
 *
 * @param sigma - scale parameter
 * @returns standard deviation
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/lib/main.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/lib/main.js
@@ -55,7 +55,7 @@ var SQRT1M2PI = sqrt( 1.0 - (2.0/PI) );
 * // returns NaN
 */
 function stdev( sigma ) {
-	if ( isnan( sigma ) || sigma < 0 ) {
+	if ( isnan( sigma ) || sigma <= 0 ) {
 		return NaN;
 	}
 	return sigma * SQRT1M2PI;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/src/main.c
@@ -32,7 +32,7 @@ static const double SQRT1M2PI = 0.6028102749890869; // sqrt(1 - 2/pi)
 * // returns ~1.2056
 */
 double stdlib_base_dists_halfnormal_stdev( const double sigma ) {
-	if ( stdlib_base_is_nan( sigma ) || sigma < 0.0 ) {
+	if ( stdlib_base_is_nan( sigma ) || sigma <= 0.0 ) {
 		return 0.0/0.0; // NaN
 	}
 	return sigma * SQRT1M2PI;
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/test/test.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/test/test.js
@@ -47,7 +47,7 @@ tape( 'if provided `NaN`, the function returns `NaN`', function test( t ) {
 	t.end();
 });
 
-tape( 'if provided a negative number, the function returns `NaN`', function test( t ) {
+tape( 'if provided a non-positive number, the function returns `NaN`', function test( t ) {
 	var sigma;
 
 	sigma = stdev( -1.0 );
diff --git a/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/test/test.native.js b/lib/node_modules/@stdlib/stats/base/dists/halfnormal/stdev/test/test.native.js
@@ -56,7 +56,7 @@ tape( 'if provided `NaN`, the function returns `NaN`', opts, function test( t )
 	t.end();
 });
 
-tape( 'if provided a negative number, the function returns `NaN`', opts, function test( t ) {
+tape( 'if provided a non-positive number, the function returns `NaN`', opts, function test( t ) {
 	var sigma;
 
 	sigma = stdev( -1.0 );

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*`
`24`	`24`	`* ## Notes`
`25`	`25`	`*`
`26`		-* - If provided `σ < 0`, the function returns `NaN`.
	`26`	+* - If provided `σ <= 0`, the function returns `NaN`.
`27`	`27`	`*`
`28`	`28`	`* @param sigma - scale parameter`
`29`	`29`	`* @returns standard deviation`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,7 @@ var SQRT1M2PI = sqrt( 1.0 - (2.0/PI) );`
`55`	`55`	`* // returns NaN`
`56`	`56`	`*/`
`57`	`57`	`function stdev( sigma ) {`
`58`		`- if ( isnan( sigma ) \|\| sigma < 0 ) {`
	`58`	`+ if ( isnan( sigma ) \|\| sigma <= 0 ) {`
`59`	`59`	`return NaN;`
`60`	`60`	`}`
`61`	`61`	`return sigma * SQRT1M2PI;`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ static const double SQRT1M2PI = 0.6028102749890869; // sqrt(1 - 2/pi)`
`32`	`32`	`* // returns ~1.2056`
`33`	`33`	`*/`
`34`	`34`	`double stdlib_base_dists_halfnormal_stdev( const double sigma ) {`
`35`		`- if ( stdlib_base_is_nan( sigma ) \|\| sigma < 0.0 ) {`
	`35`	`+ if ( stdlib_base_is_nan( sigma ) \|\| sigma <= 0.0 ) {`
`36`	`36`	`return 0.0/0.0; // NaN`
`37`	`37`	`}`
`38`	`38`	`return sigma * SQRT1M2PI;`