Readme update

--- 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 ---
yuvi-mittal · Jan 28, 2025 · add5e31 · add5e31
1 parent a68fff2
commit add5e31
Show file tree

Hide file tree

Showing 6 changed files with 97 additions and 96 deletions.
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/README.md
@@ -148,7 +148,7 @@ for ( i = 0; i < lambda.length; i++ ) {
 
 #### stdlib_base_dists_planck_stdev( lambda )
 
-Evaluates the standard deviation for an planck distribution.
+Returns the standard deviation of a Planck distribution with shape parameter `λ`.
 
 ```c
 double out = stdlib_base_dists_planck_stdev( 0.1 );
@@ -180,6 +180,7 @@ double stdlib_base_dists_planck_stdev( const double lambda );
 <section class="examples">
 
 ### Examples
+
 ```c
 #include "stdlib/stats/base/dists/planck/stdev.h"
 #include <stdlib.h>

diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.js
@@ -21,7 +21,7 @@
 // MODULES //
 
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
 var Float64Array = require( '@stdlib/array/float64' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var pkg = require( './../package.json' ).name;
@@ -39,7 +39,7 @@ bench( pkg, function benchmark( b ) {
 	len = 100;
 	lambda = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		lambda[ i ] = ( randu() * 10.0 ) + 1.0;
+		lambda[ i ] = uniform(0.1, 11);
 	}
 
 	b.tic();

diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/benchmark/benchmark.native.js
@@ -22,7 +22,7 @@
 
 var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench' );
-var randu = require( '@stdlib/random/base/randu' );
+var uniform = require( '@stdlib/random/base/uniform' );
 var Float64Array = require( '@stdlib/array/float64' );
 var isnan = require( '@stdlib/math/base/assert/is-nan' );
 var tryRequire = require( '@stdlib/utils/try-require' );
@@ -39,7 +39,7 @@ var opts = {
 
 // MAIN //
 
-bench( pkg+'::native', opts , function benchmark( b ) {
+bench( pkg+'::native', opts, function benchmark( b ) {
 	var lambda;
 	var len;
 	var y;
@@ -48,7 +48,7 @@ bench( pkg+'::native', opts , function benchmark( b ) {
 	len = 100;
 	lambda = new Float64Array( len );
 	for ( i = 0; i < len; i++ ) {
-		lambda[ i ] = ( randu() * 10.0 ) + 1.0;
+		lambda[ i ] = uniform(0.1, 11);
 	}
 
 	b.tic();

diff --git a/...ules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h b/...ules/@stdlib/stats/base/dists/planck/stdev/include/stdlib/stats/base/dists/planck/stdev.h
@@ -27,7 +27,7 @@ extern "C" {
 #endif
 
 /**
-* Evaluates the standard deviation (stdev) for an planck distribution with shape parameter lambda.
+* Returns the standard deviation of a Planck distribution with shape parameter `λ`.
 */
 double stdlib_base_dists_planck_stdev( const double lambda );
 

diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/manifest.json
@@ -1,91 +1,91 @@
 {
-    "options": {
+  "options": {
+    "task": "build",
+    "wasm": false
+  },
+  "fields": [
+    {
+      "field": "src",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "include",
+      "resolve": true,
+      "relative": true
+    },
+    {
+      "field": "libraries",
+      "resolve": false,
+      "relative": false
+    },
+    {
+      "field": "libpath",
+      "resolve": true,
+      "relative": false
+    }
+  ],
+  "confs": [
+    {
       "task": "build",
-      "wasm": false
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/napi/unary",
+        "@stdlib/math/base/assert/is-nan",
+        "@stdlib/math/base/special/abs",
+        "@stdlib/math/base/special/expm1",
+        "@stdlib/math/base/special/sqrt",
+        "@stdlib/math/base/special/exp",
+        "@stdlib/constants/float64/pi"
+      ]
+    },
+    {
+      "task": "benchmark",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/assert/is-nan",
+        "@stdlib/math/base/special/abs",
+        "@stdlib/math/base/special/expm1",
+        "@stdlib/math/base/special/sqrt",
+        "@stdlib/math/base/special/exp",
+        "@stdlib/constants/float64/pi"
+      ]
     },
-    "fields": [
-      {
-        "field": "src",
-        "resolve": true,
-        "relative": true
-      },
-      {
-        "field": "include",
-        "resolve": true,
-        "relative": true
-      },
-      {
-        "field": "libraries",
-        "resolve": false,
-        "relative": false
-      },
-      {
-        "field": "libpath",
-        "resolve": true,
-        "relative": false
-      }
-    ],
-    "confs": [
-      {
-        "task": "build",
-        "wasm": false,
-        "src": [
-          "./src/main.c"
-        ],
-        "include": [
-          "./include"
-        ],
-        "libraries": [],
-        "libpath": [],
-        "dependencies": [
-          "@stdlib/math/base/napi/unary",
-          "@stdlib/math/base/assert/is-nan",
-          "@stdlib/math/base/special/abs",
-          "@stdlib/math/base/special/expm1",
-          "@stdlib/math/base/special/sqrt",
-          "@stdlib/math/base/special/exp",
-          "@stdlib/constants/float64/pi"
-        ]
-      },
-      {
-        "task": "benchmark",
-        "wasm": false,
-        "src": [
-          "./src/main.c"
-        ],
-        "include": [
-          "./include"
-        ],
-        "libraries": [],
-        "libpath": [],
-        "dependencies": [
-          "@stdlib/math/base/assert/is-nan",
-          "@stdlib/math/base/special/abs",
-          "@stdlib/math/base/special/expm1",
-          "@stdlib/math/base/special/sqrt",
-          "@stdlib/math/base/special/exp",
-          "@stdlib/constants/float64/pi"
-        ]
-      },
-      {
-        "task": "examples",
-        "wasm": false,
-        "src": [
-          "./src/main.c"
-        ],
-        "include": [
-          "./include"
-        ],
-        "libraries": [],
-        "libpath": [],
-        "dependencies": [
-          "@stdlib/math/base/assert/is-nan",
-          "@stdlib/math/base/special/abs",
-          "@stdlib/math/base/special/expm1",
-          "@stdlib/math/base/special/sqrt",
-          "@stdlib/math/base/special/exp",
-          "@stdlib/constants/float64/pi"
-        ]
-      }
-    ]
-  }
+    {
+      "task": "examples",
+      "wasm": false,
+      "src": [
+        "./src/main.c"
+      ],
+      "include": [
+        "./include"
+      ],
+      "libraries": [],
+      "libpath": [],
+      "dependencies": [
+        "@stdlib/math/base/assert/is-nan",
+        "@stdlib/math/base/special/abs",
+        "@stdlib/math/base/special/expm1",
+        "@stdlib/math/base/special/sqrt",
+        "@stdlib/math/base/special/exp",
+        "@stdlib/constants/float64/pi"
+      ]
+    }
+  ]
+}
diff --git a/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c b/lib/node_modules/@stdlib/stats/base/dists/planck/stdev/src/main.c
@@ -23,7 +23,7 @@
 #include "stdlib/math/base/special/sqrt.h"
 
 /**
-* Evaluates the standard deviation of a Planck distribution given a shape parameter `lambda`.
+*  Returns the standard deviation of a Planck distribution with shape parameter `λ`.
 *
 * @param lambda    shape parameter
 * @return          standard deviation
-Original file line number
+Diff line change
@@ Expand Up / @@ -27,7 +27,7 @@ extern "C" { @@
     #endif
     /**
-    * Evaluates the standard deviation (stdev) for an planck distribution with shape parameter lambda.
+    * Returns the standard deviation of a Planck distribution with shape parameter `λ`.
     */
     double stdlib_base_dists_planck_stdev( const double lambda );
@@ Expand Down @@