Skip to content

docs: update namespace table of contents #11114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Planeshifter merged 1 commit into from
Mar 24, 2026
Merged

docs: update namespace table of contents #11114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/complex/float32/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,9 @@ The namespace contains the following functions:
<div class="namespace-toc">

- <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float32/base/add]</span><span class="delimiter">: </span><span class="description">add two single-precision complex floating-point numbers.</span>
- <span class="signature">[`add3( z1, z2, z3 )`][@stdlib/complex/float32/base/add3]</span><span class="delimiter">: </span><span class="description">compute the sum of three single-precision complex floating-point numbers.</span>
- <span class="signature">[`identity( z )`][@stdlib/complex/float32/base/identity]</span><span class="delimiter">: </span><span class="description">evaluate the identity function of a single-precision complex floating-point number.</span>
- <span class="signature">[`muladd( alpha, x, y )`][@stdlib/complex/float32/base/mul-add]</span><span class="delimiter">: </span><span class="description">perform a multiply-add operation involving three single-precision complex floating-point numbers.</span>
- <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float32/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two single-precision complex floating-point numbers.</span>
- <span class="signature">[`neg( z )`][@stdlib/complex/float32/base/neg]</span><span class="delimiter">: </span><span class="description">negate a single-precision complex floating-point number.</span>
- <span class="signature">[`scale( alpha, c )`][@stdlib/complex/float32/base/scale]</span><span class="delimiter">: </span><span class="description">scale a single-precision complex floating-point number by a real-valued single-precision floating-point scalar constant.</span>
Expand Down Expand Up @@ -115,8 +117,12 @@ console.log( objectKeys( ns ) );

[@stdlib/complex/float32/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add

[@stdlib/complex/float32/base/add3]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add3

[@stdlib/complex/float32/base/identity]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/identity

[@stdlib/complex/float32/base/mul-add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul-add

[@stdlib/complex/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul

[@stdlib/complex/float32/base/neg]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/neg
Expand Down
6 changes: 6 additions & 0 deletions lib/node_modules/@stdlib/ndarray/base/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ var o = ns;

- <span class="signature">[`anyBy( arrays, predicate[, thisArg] )`][@stdlib/ndarray/base/any-by]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an ndarray passes a test implemented by a predicate function.</span>
- <span class="signature">[`any( arrays )`][@stdlib/ndarray/base/any]</span><span class="delimiter">: </span><span class="description">test whether at least one element in an ndarray is truthy.</span>
- <span class="signature">[`assignScalar( arrays )`][@stdlib/ndarray/base/assign-scalar]</span><span class="delimiter">: </span><span class="description">assign a scalar value to every element of an output ndarray.</span>
- <span class="signature">[`assign( arrays )`][@stdlib/ndarray/base/assign]</span><span class="delimiter">: </span><span class="description">assign elements in an input ndarray to elements in an output ndarray.</span>
- <span class="signature">[`atleastnd( ndims, arrays )`][@stdlib/ndarray/base/atleastnd]</span><span class="delimiter">: </span><span class="description">convert a list of values (scalars and/or ndarrays) to ndarrays having at least a specified number of dimensions.</span>
- <span class="signature">[`binaryInputCastingDataType( idtype1, idtype2, odtype, policy )`][@stdlib/ndarray/base/binary-input-casting-dtype]</span><span class="delimiter">: </span><span class="description">resolve the casting data type for an input ndarray provided to a binary function.</span>
Expand Down Expand Up @@ -110,6 +111,7 @@ var o = ns;
- <span class="signature">[`array2ndarray( buf, order )`][@stdlib/ndarray/base/from-array]</span><span class="delimiter">: </span><span class="description">convert an array to a one-dimensional ndarray.</span>
- <span class="signature">[`scalar2ndarrayLike( x, value )`][@stdlib/ndarray/base/from-scalar-like]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray having the same data type as a provided ndarray.</span>
- <span class="signature">[`scalar2ndarray( value, dtype, order )`][@stdlib/ndarray/base/from-scalar]</span><span class="delimiter">: </span><span class="description">convert a scalar value to a zero-dimensional ndarray.</span>
- <span class="signature">[`full( value, dtype, shape, order )`][@stdlib/ndarray/base/full]</span><span class="delimiter">: </span><span class="description">create an ndarray filled with a specified value and having a specified shape and data type.</span>
- <span class="signature">[`includes( arrays )`][@stdlib/ndarray/base/includes]</span><span class="delimiter">: </span><span class="description">test whether an ndarray contains a specified value.</span>
- <span class="signature">[`ind( idx, max, mode )`][@stdlib/ndarray/base/ind]</span><span class="delimiter">: </span><span class="description">return an index given an index mode.</span>
- <span class="signature">[`ind2sub( shape, strides, offset, order, idx, mode )`][@stdlib/ndarray/base/ind2sub]</span><span class="delimiter">: </span><span class="description">convert a linear index to an array of subscripts.</span>
Expand Down Expand Up @@ -278,6 +280,8 @@ console.log( objectKeys( ns ) );

[@stdlib/ndarray/base/any]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/any

[@stdlib/ndarray/base/assign-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign-scalar

[@stdlib/ndarray/base/assign]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/assign

[@stdlib/ndarray/base/atleastnd]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/atleastnd
Expand Down Expand Up @@ -408,6 +412,8 @@ console.log( objectKeys( ns ) );

[@stdlib/ndarray/base/from-scalar]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/from-scalar

[@stdlib/ndarray/base/full]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/full

[@stdlib/ndarray/base/includes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/includes

[@stdlib/ndarray/base/ind]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/ind
Expand Down