Skip to content

Commit

Permalink
docs: update namespace table of contents
Browse files Browse the repository at this point in the history
PR-URL: #1284
Signed-off-by: stdlib-bot <[email protected]>
Co-authored-by: Philipp Burckhardt <[email protected]> 
Reviewed-by: Philipp Burckhardt <[email protected]>
  • Loading branch information
stdlib-bot and Planeshifter authored Jan 26, 2024
1 parent a4f4808 commit 322d1ca
Show file tree
Hide file tree
Showing 15 changed files with 186 additions and 0 deletions.
12 changes: 12 additions & 0 deletions lib/node_modules/@stdlib/array/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,6 +174,8 @@ Lastly, the namespace contains various other functions for dealing with arrays,
- <span class="signature">[`anansLike( x[, dtype] )`][@stdlib/array/nans-like]</span><span class="delimiter">: </span><span class="description">create an array filled with NaNs and having the same length and data type as a provided array.</span>
- <span class="signature">[`anans( length[, dtype] )`][@stdlib/array/nans]</span><span class="delimiter">: </span><span class="description">create an array filled with NaNs and having a specified length.</span>
- <span class="signature">[`arrayNextDataType( [dtype] )`][@stdlib/array/next-dtype]</span><span class="delimiter">: </span><span class="description">return the next larger array data type of the same kind.</span>
- <span class="signature">[`aoneToLike( x[, dtype] )`][@stdlib/array/one-to-like]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by `1` starting from one and having the same length and data type as a provided input array.</span>
- <span class="signature">[`aoneTo( n[, dtype] )`][@stdlib/array/one-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by `1` starting from one.</span>
- <span class="signature">[`aonesLike( x[, dtype] )`][@stdlib/array/ones-like]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having the same length and data type as a provided array.</span>
- <span class="signature">[`aones( length[, dtype] )`][@stdlib/array/ones]</span><span class="delimiter">: </span><span class="description">create an array filled with ones and having a specified length.</span>
- <span class="signature">[`typedarraypool()`][@stdlib/array/pool]</span><span class="delimiter">: </span><span class="description">allocate typed arrays from a typed array memory pool.</span>
Expand All @@ -193,6 +195,8 @@ Lastly, the namespace contains various other functions for dealing with arrays,
- <span class="signature">[`arrayview2iterator( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object view.</span>
- <span class="signature">[`complexarray()`][@stdlib/array/typed-complex]</span><span class="delimiter">: </span><span class="description">create a complex number typed array.</span>
- <span class="signature">[`realarray()`][@stdlib/array/typed-real]</span><span class="delimiter">: </span><span class="description">create a typed array.</span>
- <span class="signature">[`azeroToLike( x[, dtype] )`][@stdlib/array/zero-to-like]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by `1` starting from zero and having the same length and data type as a provided input array.</span>
- <span class="signature">[`azeroTo( n[, dtype] )`][@stdlib/array/zero-to]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array whose elements increment by `1` starting from zero.</span>
- <span class="signature">[`azerosLike( x[, dtype] )`][@stdlib/array/zeros-like]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having the same length and data type as a provided array.</span>
- <span class="signature">[`azeros( length[, dtype] )`][@stdlib/array/zeros]</span><span class="delimiter">: </span><span class="description">create a zero-filled array having a specified length.</span>

Expand Down Expand Up @@ -275,6 +279,10 @@ console.log( objectKeys( ns ) );

[@stdlib/array/next-dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/next-dtype

[@stdlib/array/one-to-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/one-to-like

[@stdlib/array/one-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/one-to

[@stdlib/array/ones-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ones-like

[@stdlib/array/ones]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/ones
Expand Down Expand Up @@ -313,6 +321,10 @@ console.log( objectKeys( ns ) );

[@stdlib/array/typed-real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/typed-real

[@stdlib/array/zero-to-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zero-to-like

[@stdlib/array/zero-to]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zero-to

[@stdlib/array/zeros-like]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zeros-like

[@stdlib/array/zeros]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/zeros
Expand Down
Loading

1 comment on commit 322d1ca

@stdlib-bot
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage Report

Package Statements Branches Functions Lines
array $\color{green}757/757$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}757/757$
$\color{green}+100.00\%$
array/base $\color{green}1419/1419$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}1419/1419$
$\color{green}+100.00\%$
array/base/assert $\color{green}87/87$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}87/87$
$\color{green}+100.00\%$
assert $\color{green}2670/2670$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}2670/2670$
$\color{green}+100.00\%$
complex/base $\color{green}69/69$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}69/69$
$\color{green}+100.00\%$
complex/base/assert $\color{green}114/114$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}114/114$
$\color{green}+100.00\%$
constants/complex128 $\color{green}72/72$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}72/72$
$\color{green}+100.00\%$
constants/complex64 $\color{green}72/72$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}72/72$
$\color{green}+100.00\%$
constants/float32 $\color{green}222/222$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}222/222$
$\color{green}+100.00\%$
constants/float64 $\color{green}652/652$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}652/652$
$\color{green}+100.00\%$
number/float32/base $\color{green}141/141$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}141/141$
$\color{green}+100.00\%$
number/float32/base/assert $\color{green}60/60$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}60/60$
$\color{green}+100.00\%$
number/float64/base $\color{green}195/195$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}195/195$
$\color{green}+100.00\%$
number/float64/base/assert $\color{green}60/60$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}60/60$
$\color{green}+100.00\%$
random/array $\color{green}375/375$
$\color{green}+100.00\%$
$\color{green}1/1$
$\color{green}+100.00\%$
$\color{green}0/0$
$\color{green}+100.00\%$
$\color{green}375/375$
$\color{green}+100.00\%$

The above coverage report was generated for the changes in this push.

Please sign in to comment.