Skip to content

Commit c39d7a1

Browse files
kgrytestdlib-bot
authored andcommitted
docs: update namespace table of contents
Signed-off-by: stdlib-bot <82920195+stdlib-bot@users.noreply.github.com>
1 parent 14a2930 commit c39d7a1

File tree

10 files changed

+161
-14
lines changed

10 files changed

+161
-14
lines changed

lib/node_modules/@stdlib/_tools/eslint/rules/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ var eslint = rules;
8181
- <span class="signature">[`require-globals`][@stdlib/_tools/eslint/rules/require-globals]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing that specified global variables are explicitly required.</span>
8282
- <span class="signature">[`require-leading-slash`][@stdlib/_tools/eslint/rules/require-leading-slash]</span><span class="delimiter">: </span><span class="description">ESLint rule disallowing `require()` calls of relative paths which do not begin with a leading `./`.</span>
8383
- <span class="signature">[`require-order`][@stdlib/_tools/eslint/rules/require-order]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing a specified order of `require()` calls.</span>
84+
- <span class="signature">[`require-spaces`][@stdlib/_tools/eslint/rules/require-spaces]</span><span class="delimiter">: </span><span class="description">ESLint rule enforcing spaces in `require()` statements.</span>
8485
- <span class="signature">[`section-header-empty-lines`][@stdlib/_tools/eslint/rules/section-header-empty-lines]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce that section header comments are padded by empty lines.</span>
8586
- <span class="signature">[`section-headers`][@stdlib/_tools/eslint/rules/section-headers]</span><span class="delimiter">: </span><span class="description">ESLint rule to enforce formatting of section header comments.</span>
8687
- <span class="signature">[`ternary-condition-parentheses`][@stdlib/_tools/eslint/rules/ternary-condition-parentheses]</span><span class="delimiter">: </span><span class="description">ESLint rule requiring parentheses around ternary conditions.</span>
@@ -421,6 +422,8 @@ console.log( getKeys( rules ) );
421422

422423
[@stdlib/_tools/eslint/rules/require-order]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-order
423424

425+
[@stdlib/_tools/eslint/rules/require-spaces]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/require-spaces
426+
424427
[@stdlib/_tools/eslint/rules/section-header-empty-lines]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/section-header-empty-lines
425428

426429
[@stdlib/_tools/eslint/rules/section-headers]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/_tools/eslint/rules/section-headers

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

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,20 @@ The namespace contains the following APIs:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`base`][@stdlib/complex/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) complex number functions.</span>
49+
- <span class="signature">[`complex( real, imag[, dtype] )`][@stdlib/complex/cmplx]</span><span class="delimiter">: </span><span class="description">create a complex number.</span>
50+
- <span class="signature">[`ctors( dtype )`][@stdlib/complex/ctors]</span><span class="delimiter">: </span><span class="description">complex number constructors.</span>
51+
- <span class="signature">[`dtype( value )`][@stdlib/complex/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of a complex number.</span>
52+
- <span class="signature">[`dtypes()`][@stdlib/complex/dtypes]</span><span class="delimiter">: </span><span class="description">list of complex number data types.</span>
53+
- <span class="signature">[`float32`][@stdlib/complex/float32]</span><span class="delimiter">: </span><span class="description">single-precision complex floating-point number functions.</span>
54+
- <span class="signature">[`float64`][@stdlib/complex/float64]</span><span class="delimiter">: </span><span class="description">double-precision complex floating-point number functions.</span>
55+
- <span class="signature">[`promotionRules( [dtype1, dtype2] )`][@stdlib/complex/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the complex number data type with the smallest size and closest "kind" to which data types can be **safely** cast.</span>
56+
- <span class="signature">[`reviveComplex( key, value )`][@stdlib/complex/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized complex number.</span>
57+
58+
</div>
59+
4660
<!-- </toc> -->
4761

4862
</section>
@@ -80,6 +94,28 @@ console.log( objectKeys( ns ) );
8094

8195
<section class="links">
8296

97+
<!-- <toc-links> -->
98+
99+
[@stdlib/complex/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/base
100+
101+
[@stdlib/complex/cmplx]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/cmplx
102+
103+
[@stdlib/complex/ctors]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/ctors
104+
105+
[@stdlib/complex/dtype]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/dtype
106+
107+
[@stdlib/complex/dtypes]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/dtypes
108+
109+
[@stdlib/complex/float32]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32
110+
111+
[@stdlib/complex/float64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64
112+
113+
[@stdlib/complex/promotion-rules]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/promotion-rules
114+
115+
[@stdlib/complex/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/reviver
116+
117+
<!-- </toc-links> -->
118+
83119
</section>
84120

85121
<!-- /.links -->

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,19 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`base`][@stdlib/complex/float32/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) single-precision complex floating-point number functions.</span>
49+
- <span class="signature">[`conj( z )`][@stdlib/complex/float32/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a single-precision complex floating-point number.</span>
50+
- <span class="signature">[`Complex64( real, imag )`][@stdlib/complex/float32/ctor]</span><span class="delimiter">: </span><span class="description">64-bit complex number.</span>
51+
- <span class="signature">[`imag( z )`][@stdlib/complex/float32/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a single-precision complex floating-point number.</span>
52+
- <span class="signature">[`parseComplex64( str )`][@stdlib/complex/float32/parse]</span><span class="delimiter">: </span><span class="description">parse a string representation of a 64-bit complex number.</span>
53+
- <span class="signature">[`real( z )`][@stdlib/complex/float32/real]</span><span class="delimiter">: </span><span class="description">return the real component of a single-precision complex floating-point number.</span>
54+
- <span class="signature">[`reim( z )`][@stdlib/complex/float32/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a single-precision complex floating-point number.</span>
55+
- <span class="signature">[`reviveComplex64( key, value )`][@stdlib/complex/float32/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized 64-bit complex number.</span>
56+
57+
</div>
58+
4659
<!-- </toc> -->
4760

4861
</section>
@@ -90,6 +103,22 @@ console.log( objectKeys( ns ) );
90103

91104
<!-- <toc-links> -->
92105

106+
[@stdlib/complex/float32/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base
107+
108+
[@stdlib/complex/float32/conj]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/conj
109+
110+
[@stdlib/complex/float32/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/ctor
111+
112+
[@stdlib/complex/float32/imag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/imag
113+
114+
[@stdlib/complex/float32/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/parse
115+
116+
[@stdlib/complex/float32/real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/real
117+
118+
[@stdlib/complex/float32/reim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/reim
119+
120+
[@stdlib/complex/float32/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/reviver
121+
93122
<!-- </toc-links> -->
94123

95124
</section>

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <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>
49+
- <span class="signature">[`assert`][@stdlib/complex/float32/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) single-precision complex floating-point number assertion functions.</span>
50+
- <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>
51+
52+
</div>
53+
4654
<!-- </toc> -->
4755

4856
</section>
@@ -90,6 +98,12 @@ console.log( objectKeys( ns ) );
9098

9199
<!-- <toc-links> -->
92100

101+
[@stdlib/complex/float32/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/add
102+
103+
[@stdlib/complex/float32/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert
104+
105+
[@stdlib/complex/float32/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/mul
106+
93107
<!-- </toc-links> -->
94108

95109
</section>

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

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are equal.</span>
49+
- <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float32/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are not equal.</span>
50+
- <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are the same value.</span>
51+
- <span class="signature">[`isSameValue( z1, z2 )`][@stdlib/complex/float32/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test whether two single-precision complex floating-point numbers are the same value.</span>
52+
53+
</div>
54+
4655
<!-- </toc> -->
4756

4857
</section>
@@ -90,6 +99,14 @@ console.log( objectKeys( ns ) );
9099

91100
<!-- <toc-links> -->
92101

102+
[@stdlib/complex/float32/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-equal
103+
104+
[@stdlib/complex/float32/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-not-equal
105+
106+
[@stdlib/complex/float32/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-same-value-zero
107+
108+
[@stdlib/complex/float32/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float32/base/assert/is-same-value
109+
93110
<!-- </toc-links> -->
94111

95112
</section>

lib/node_modules/@stdlib/complex/float64/README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,19 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`base`][@stdlib/complex/float64/base]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) double-precision complex floating-point number functions.</span>
49+
- <span class="signature">[`conj( z )`][@stdlib/complex/float64/conj]</span><span class="delimiter">: </span><span class="description">return the complex conjugate of a double-precision complex floating-point number.</span>
50+
- <span class="signature">[`Complex128( real, imag )`][@stdlib/complex/float64/ctor]</span><span class="delimiter">: </span><span class="description">128-bit complex number.</span>
51+
- <span class="signature">[`imag( z )`][@stdlib/complex/float64/imag]</span><span class="delimiter">: </span><span class="description">return the imaginary component of a double-precision complex floating-point number.</span>
52+
- <span class="signature">[`parseComplex128( str )`][@stdlib/complex/float64/parse]</span><span class="delimiter">: </span><span class="description">parse a string representation of a 128-bit complex number.</span>
53+
- <span class="signature">[`real( z )`][@stdlib/complex/float64/real]</span><span class="delimiter">: </span><span class="description">return the real component of a double-precision complex floating-point number.</span>
54+
- <span class="signature">[`reim( z )`][@stdlib/complex/float64/reim]</span><span class="delimiter">: </span><span class="description">return the real and imaginary components of a double-precision complex floating-point number.</span>
55+
- <span class="signature">[`reviveComplex128( key, value )`][@stdlib/complex/float64/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized 128-bit complex number.</span>
56+
57+
</div>
58+
4659
<!-- </toc> -->
4760

4861
</section>
@@ -90,6 +103,22 @@ console.log( objectKeys( ns ) );
90103

91104
<!-- <toc-links> -->
92105

106+
[@stdlib/complex/float64/base]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base
107+
108+
[@stdlib/complex/float64/conj]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/conj
109+
110+
[@stdlib/complex/float64/ctor]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/ctor
111+
112+
[@stdlib/complex/float64/imag]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/imag
113+
114+
[@stdlib/complex/float64/parse]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/parse
115+
116+
[@stdlib/complex/float64/real]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/real
117+
118+
[@stdlib/complex/float64/reim]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/reim
119+
120+
[@stdlib/complex/float64/reviver]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/reviver
121+
93122
<!-- </toc-links> -->
94123

95124
</section>

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,14 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`add( z1, z2 )`][@stdlib/complex/float64/base/add]</span><span class="delimiter">: </span><span class="description">add two double-precision complex floating-point numbers.</span>
49+
- <span class="signature">[`assert`][@stdlib/complex/float64/base/assert]</span><span class="delimiter">: </span><span class="description">base (i.e., lower-level) double-precision complex floating-point number assertion functions.</span>
50+
- <span class="signature">[`mul( z1, z2 )`][@stdlib/complex/float64/base/mul]</span><span class="delimiter">: </span><span class="description">multiply two double-precision complex floating-point numbers.</span>
51+
52+
</div>
53+
4654
<!-- </toc> -->
4755

4856
</section>
@@ -90,6 +98,12 @@ console.log( objectKeys( ns ) );
9098

9199
<!-- <toc-links> -->
92100

101+
[@stdlib/complex/float64/base/add]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/add
102+
103+
[@stdlib/complex/float64/base/assert]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert
104+
105+
[@stdlib/complex/float64/base/mul]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/mul
106+
93107
<!-- </toc-links> -->
94108

95109
</section>

lib/node_modules/@stdlib/complex/float64/base/assert/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ The namespace contains the following functions:
4343

4444
<!-- <toc pattern="*"> -->
4545

46+
<div class="namespace-toc">
47+
48+
- <span class="signature">[`isEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are equal.</span>
49+
- <span class="signature">[`isNotEqual( z1, z2 )`][@stdlib/complex/float64/base/assert/is-not-equal]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are not equal.</span>
50+
- <span class="signature">[`isSameValueZero( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value-zero]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are the same value.</span>
51+
- <span class="signature">[`isSameValue( z1, z2 )`][@stdlib/complex/float64/base/assert/is-same-value]</span><span class="delimiter">: </span><span class="description">test whether two double-precision complex floating-point numbers are the same value.</span>
52+
53+
</div>
54+
4655
<!-- </toc> -->
4756

4857
</section>
@@ -90,6 +99,14 @@ console.log( objectKeys( ns ) );
9099

91100
<!-- <toc-links> -->
92101

102+
[@stdlib/complex/float64/base/assert/is-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-equal
103+
104+
[@stdlib/complex/float64/base/assert/is-not-equal]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-not-equal
105+
106+
[@stdlib/complex/float64/base/assert/is-same-value-zero]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-same-value-zero
107+
108+
[@stdlib/complex/float64/base/assert/is-same-value]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/complex/float64/base/assert/is-same-value
109+
93110
<!-- </toc-links> -->
94111

95112
</section>

0 commit comments

Comments
 (0)