@stdlib/random-iter 0.2.1 → 0.2.2

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2024 The Stdlib Authors.
+Copyright (c) 2016-2026 The Stdlib Authors.

package/README.md

@@ -127,10 +127,43 @@ The namespace contains the following functions for creating iterator protocol-co
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var objectKeys = require( '@stdlib/utils-keys' );
-var ns = require( '@stdlib/random-iter' );
-
-console.log( objectKeys( ns ) );
+var roundn = require( '@stdlib/math-base-special-roundn' );
+var mean = require( '@stdlib/stats-strided-mean' );
+var iter = require( '@stdlib/random-iter' );
+
+var initialPrice = 100.0;
+var currentPrice = initialPrice;
+var numDays = 30;
+var volatility = 0.02; // 2% daily volatility
+
+// Create iterator for random price movements:
+var priceIter = iter.normal( 0.0, volatility );
+var prices = [ initialPrice ];
+var dailyReturns = [];
+
+// Simulate price movements:
+var change;
+var i;
+for ( i = 0; i < numDays; i++ ) {
+    change = priceIter.next().value;
+    currentPrice *= ( 1.0 + change );
+    prices.push( roundn( currentPrice, -2 ) );
+    dailyReturns.push( change * 100.0 );
+}
+
+// Calculate summary statistics:
+var totalReturn = ( ( currentPrice - initialPrice ) / initialPrice ) * 100.0;
+var avgReturn = mean( numDays, dailyReturns, 1 );
+
+// Print results:
+console.log( 'Stock Price Simulation Results:' );
+console.log( '-------------------------------' );
+console.log( 'Initial Price: $%d', initialPrice );
+console.log( 'Final Price: $%d', roundn( currentPrice, -2 ) );
+console.log( 'Total Return: %d%', roundn( totalReturn, -2 ) );
+console.log( 'Average Daily Return: %d%', roundn( avgReturn, -2 ) );
+console.log( '\nPrice History:' );
+console.log( prices.join( ' → ' ) );
 ```
 
 </section>
@@ -171,7 +204,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2026. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -184,8 +217,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/random-iter.svg
 [npm-url]: https://npmjs.org/package/@stdlib/random-iter
 
-[test-image]: https://github.com/stdlib-js/random-iter/actions/workflows/test.yml/badge.svg?branch=v0.2.1
-[test-url]: https://github.com/stdlib-js/random-iter/actions/workflows/test.yml?query=branch:v0.2.1
+[test-image]: https://github.com/stdlib-js/random-iter/actions/workflows/test.yml/badge.svg?branch=v0.2.2
+[test-url]: https://github.com/stdlib-js/random-iter/actions/workflows/test.yml?query=branch:v0.2.2
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/random-iter/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/random-iter?branch=main
@@ -197,8 +230,8 @@ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 -->
 
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+[chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg
+[chat-url]: https://stdlib.zulipchat.com
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 

package/docs/types/index.d.ts

@@ -457,6 +457,7 @@ interface Namespace {
 	*
 	* @param alpha - shape parameter
 	* @param s - rate parameter
+	* @param m - location parameter
 	* @param options - function options
 	* @throws `alpha` must be a positive number
 	* @throws `s` must be a positive number
@@ -465,7 +466,7 @@ interface Namespace {
 	* @returns iterator
 	*
 	* @example
-	* var iter = ns.frechet( 2.0, 5.0 );
+	* var iter = ns.frechet( 2.0, 5.0, 3.0 );
 	*
 	* var r = iter.next().value;
 	* // returns <number>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/random-iter",
-  "version": "0.2.1",
+  "version": "0.2.2",
   "description": "Pseudorandom number generator iterators.",
   "license": "Apache-2.0",
   "author": {
@@ -44,7 +44,7 @@
     "@stdlib/random-iter-erlang": "^0.2.1",
     "@stdlib/random-iter-exponential": "^0.2.1",
     "@stdlib/random-iter-f": "^0.2.1",
-    "@stdlib/random-iter-frechet": "^0.2.1",
+    "@stdlib/random-iter-frechet": "^0.2.2",
     "@stdlib/random-iter-gamma": "^0.2.1",
     "@stdlib/random-iter-geometric": "^0.2.1",
     "@stdlib/random-iter-gumbel": "^0.2.1",
@@ -71,7 +71,7 @@
     "@stdlib/random-iter-triangular": "^0.2.1",
     "@stdlib/random-iter-uniform": "^0.2.1",
     "@stdlib/random-iter-weibull": "^0.2.1",
-    "@stdlib/utils-define-read-only-property": "^0.2.1"
+    "@stdlib/utils-define-read-only-property": "^0.2.2"
   },
   "devDependencies": {},
   "engines": {