From 60b11147b3f35e94120f537c232f1f2fb1254e34 Mon Sep 17 00:00:00 2001 From: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com> Date: Thu, 21 May 2026 03:03:21 +0000 Subject: [PATCH] docs: update related packages sections --- .../us-states-names-capitals/README.md | 3 -- .../@stdlib/ndarray/trues/README.md | 19 ++++++++ .../@stdlib/ndarray/vector/uint16/README.md | 46 +++++++++++++++++++ .../@stdlib/random/array/f/README.md | 7 +++ .../@stdlib/random/array/normal/README.md | 3 ++ .../@stdlib/random/base/betaprime/README.md | 3 ++ .../random/strided/bernoulli/README.md | 3 ++ lib/node_modules/@stdlib/random/t/README.md | 16 +++++++ 8 files changed, 97 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/datasets/us-states-names-capitals/README.md b/lib/node_modules/@stdlib/datasets/us-states-names-capitals/README.md index 1eba8b10751b..4e996aab64a2 100644 --- a/lib/node_modules/@stdlib/datasets/us-states-names-capitals/README.md +++ b/lib/node_modules/@stdlib/datasets/us-states-names-capitals/README.md @@ -215,7 +215,6 @@ The data files (databases) are licensed under an [Open Data Commons Public Domai - [`@stdlib/datasets/us-states-capitals`][@stdlib/datasets/us-states-capitals]: A list of US state capitals in alphabetical order according to state name. - [`@stdlib/datasets/us-states-names`][@stdlib/datasets/us-states-names]: A list of US state names in alphabetical order. -- [`@stdlib/datasets/us-states-names-capitals`][@stdlib/datasets/us-states-names-capitals]: US state names and capitals. @@ -239,8 +238,6 @@ The data files (databases) are licensed under an [Open Data Commons Public Domai [@stdlib/datasets/us-states-names]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/us-states-names -[@stdlib/datasets/us-states-names-capitals]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/datasets/us-states-names-capitals - diff --git a/lib/node_modules/@stdlib/ndarray/trues/README.md b/lib/node_modules/@stdlib/ndarray/trues/README.md index d66d0835f53e..e53c0136a620 100644 --- a/lib/node_modules/@stdlib/ndarray/trues/README.md +++ b/lib/node_modules/@stdlib/ndarray/trues/README.md @@ -157,6 +157,15 @@ for ( i = 0; i < dt.length; i++ ) {
+* * * + +## See Also + +- [`@stdlib/ndarray/array`][@stdlib/ndarray/array]: multidimensional arrays. +- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. +- [`@stdlib/ndarray/falses`][@stdlib/ndarray/falses]: create an ndarray filled with false values and having a specified shape and data type. +- [`@stdlib/ndarray/trues-like`][@stdlib/ndarray/trues-like]: create an ndarray filled with true values and having the same shape and data type as a provided ndarray. +
@@ -169,6 +178,16 @@ for ( i = 0; i < dt.length; i++ ) { [@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/dtypes + + +[@stdlib/ndarray/array]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/array + +[@stdlib/ndarray/falses]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/falses + +[@stdlib/ndarray/trues-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/trues-like + + + diff --git a/lib/node_modules/@stdlib/ndarray/vector/uint16/README.md b/lib/node_modules/@stdlib/ndarray/vector/uint16/README.md index 3fd2df7eb553..7b74bbd4f084 100644 --- a/lib/node_modules/@stdlib/ndarray/vector/uint16/README.md +++ b/lib/node_modules/@stdlib/ndarray/vector/uint16/README.md @@ -179,6 +179,24 @@ console.log( v.get() );
+* * * + +## See Also + +- [`@stdlib/ndarray/vector/float64`][@stdlib/ndarray/vector/float64]: create a double-precision floating-point vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/float32`][@stdlib/ndarray/vector/float32]: create a single-precision floating-point vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/int16`][@stdlib/ndarray/vector/int16]: create a signed 16-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/int32`][@stdlib/ndarray/vector/int32]: create a signed 32-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/int8`][@stdlib/ndarray/vector/int8]: create a signed 8-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/uint8`][@stdlib/ndarray/vector/uint8]: create an unsigned 8-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/uint32`][@stdlib/ndarray/vector/uint32]: create an unsigned 32-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/uint8c`][@stdlib/ndarray/vector/uint8c]: create a clamped unsigned 8-bit integer vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/complex128`][@stdlib/ndarray/vector/complex128]: create a double-precision complex floating-point vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/complex64`][@stdlib/ndarray/vector/complex64]: create a single-precision complex floating-point vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/bool`][@stdlib/ndarray/vector/bool]: create a boolean vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/vector/ctor`][@stdlib/ndarray/vector/ctor]: create a vector (i.e., a one-dimensional ndarray). +- [`@stdlib/ndarray/ctor`][@stdlib/ndarray/ctor]: multidimensional array constructor. +
@@ -191,6 +209,34 @@ console.log( v.get() ); [@stdlib/ndarray/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/ctor + + +[@stdlib/ndarray/vector/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float64 + +[@stdlib/ndarray/vector/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/float32 + +[@stdlib/ndarray/vector/int16]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int16 + +[@stdlib/ndarray/vector/int32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int32 + +[@stdlib/ndarray/vector/int8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/int8 + +[@stdlib/ndarray/vector/uint8]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint8 + +[@stdlib/ndarray/vector/uint32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint32 + +[@stdlib/ndarray/vector/uint8c]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/uint8c + +[@stdlib/ndarray/vector/complex128]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex128 + +[@stdlib/ndarray/vector/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/complex64 + +[@stdlib/ndarray/vector/bool]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/bool + +[@stdlib/ndarray/vector/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/vector/ctor + + + diff --git a/lib/node_modules/@stdlib/random/array/f/README.md b/lib/node_modules/@stdlib/random/array/f/README.md index 57566a409add..8bd9e7d759c3 100644 --- a/lib/node_modules/@stdlib/random/array/f/README.md +++ b/lib/node_modules/@stdlib/random/array/f/README.md @@ -358,6 +358,7 @@ logEach( '%f', x4 ); ## See Also +- [`@stdlib/random/f`][@stdlib/random/f]: generate pseudorandom numbers drawn from an F distribution. - [`@stdlib/random/base/f`][@stdlib/random/base/f]: F distributed pseudorandom numbers. @@ -376,6 +377,12 @@ logEach( '%f', x4 ); [@stdlib/array/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/float64 + + +[@stdlib/random/f]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/f + + + diff --git a/lib/node_modules/@stdlib/random/array/normal/README.md b/lib/node_modules/@stdlib/random/array/normal/README.md index 861bbecb3ef5..92e1903450dc 100644 --- a/lib/node_modules/@stdlib/random/array/normal/README.md +++ b/lib/node_modules/@stdlib/random/array/normal/README.md @@ -358,6 +358,7 @@ logEach( '%f', x4 ); ## See Also +- [`@stdlib/random/normal`][@stdlib/random/normal]: generate pseudorandom numbers drawn from a normal distribution. - [`@stdlib/random/base/normal`][@stdlib/random/base/normal]: normally distributed pseudorandom numbers. - [`@stdlib/random/strided/normal`][@stdlib/random/strided/normal]: fill a strided array with pseudorandom numbers drawn from a normal distribution. @@ -379,6 +380,8 @@ logEach( '%f', x4 ); +[@stdlib/random/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/normal + [@stdlib/random/strided/normal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/normal diff --git a/lib/node_modules/@stdlib/random/base/betaprime/README.md b/lib/node_modules/@stdlib/random/base/betaprime/README.md index 1405c3d7d7fc..11388da03436 100644 --- a/lib/node_modules/@stdlib/random/base/betaprime/README.md +++ b/lib/node_modules/@stdlib/random/base/betaprime/README.md @@ -416,6 +416,7 @@ for ( i = 0; i < 100; i++ ) { - [`@stdlib/random/array/betaprime`][@stdlib/random/array/betaprime]: create an array containing pseudorandom numbers drawn from a beta prime distribution. - [`@stdlib/random/iter/betaprime`][@stdlib/random/iter/betaprime]: create an iterator for generating pseudorandom numbers drawn from a beta prime distribution. - [`@stdlib/random/streams/betaprime`][@stdlib/random/streams/betaprime]: create a readable stream for generating pseudorandom numbers drawn from a beta prime distribution. +- [`@stdlib/random/betaprime`][@stdlib/random/betaprime]: generate pseudorandom numbers drawn from a betaprime distribution. @@ -437,6 +438,8 @@ for ( i = 0; i < 100; i++ ) { [@stdlib/random/streams/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/streams/betaprime +[@stdlib/random/betaprime]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/betaprime + diff --git a/lib/node_modules/@stdlib/random/strided/bernoulli/README.md b/lib/node_modules/@stdlib/random/strided/bernoulli/README.md index f144cd58fabf..c386e0374f8d 100644 --- a/lib/node_modules/@stdlib/random/strided/bernoulli/README.md +++ b/lib/node_modules/@stdlib/random/strided/bernoulli/README.md @@ -360,6 +360,7 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 ); ## See Also +- [`@stdlib/random/bernoulli`][@stdlib/random/bernoulli]: generate pseudorandom numbers drawn from a Bernoulli distribution. - [`@stdlib/random/base/bernoulli`][@stdlib/random/base/bernoulli]: Bernoulli distributed pseudorandom numbers. - [`@stdlib/random/array/bernoulli`][@stdlib/random/array/bernoulli]: create an array containing pseudorandom numbers drawn from a Bernoulli distribution. @@ -379,6 +380,8 @@ logEach( 'x1[%d] = %.2f; x2[%d] = %.2f', idx, x1, idx, x2 ); +[@stdlib/random/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/bernoulli + [@stdlib/random/array/bernoulli]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/bernoulli diff --git a/lib/node_modules/@stdlib/random/t/README.md b/lib/node_modules/@stdlib/random/t/README.md index 8c8121d90817..bb947549a65a 100644 --- a/lib/node_modules/@stdlib/random/t/README.md +++ b/lib/node_modules/@stdlib/random/t/README.md @@ -358,6 +358,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] );
+* * * + +## See Also + +- [`@stdlib/random/base/t`][@stdlib/random/base/t]: Student's t-distributed pseudorandom numbers. +- [`@stdlib/random/array/t`][@stdlib/random/array/t]: create an array containing pseudorandom numbers drawn from a Student's t-distribution. +- [`@stdlib/random/strided/t`][@stdlib/random/strided/t]: fill a strided array with pseudorandom numbers drawn from a Student's t distribution. +
@@ -378,6 +386,14 @@ logEach( '%f, %f, %f', arr[ 0 ], arr[ 1 ], arr[ 2 ] ); [@stdlib/ndarray/base/broadcast-shapes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/broadcast-shapes + + +[@stdlib/random/array/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/array/t + +[@stdlib/random/strided/t]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/random/strided/t + + +