Skip to content

Commit d9a5e08

Browse files
authored
docs: update namespace table of contents
PR-URL: #11114 Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com> Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 90b1d08 commit d9a5e08

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

lib/node_modules/@stdlib/complex/float32/base/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,9 @@ The namespace contains the following functions:
5858
<div class="namespace-toc">
5959

6060
- <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>
61+
- <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>
6162
- <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>
63+
- <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>
6264
- <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>
6365
- <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>
6466
- <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>
@@ -115,8 +117,12 @@ console.log( objectKeys( ns ) );
115117

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

120+
[@stdlib/complex/float32/base/add3]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add3
121+
118122
[@stdlib/complex/float32/base/identity]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/identity
119123

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

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

lib/node_modules/@stdlib/ndarray/base/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ var o = ns;
4545

4646
- <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>
4747
- <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>
48+
- <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>
4849
- <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>
4950
- <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>
5051
- <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>
@@ -110,6 +111,7 @@ var o = ns;
110111
- <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>
111112
- <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>
112113
- <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>
114+
- <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>
113115
- <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>
114116
- <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>
115117
- <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>
@@ -278,6 +280,8 @@ console.log( objectKeys( ns ) );
278280

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

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

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

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

415+
[@stdlib/ndarray/base/full]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/full
416+
411417
[@stdlib/ndarray/base/includes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/ndarray/base/includes
412418

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

0 commit comments

Comments
 (0)