You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/array/base/README.md
+66Lines changed: 66 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -51,13 +51,24 @@ The namespace exports the following:
51
51
- <spanclass="signature">[`accessors( x )`][@stdlib/array/base/accessors]</span><spanclass="delimiter">: </span><spanclass="description">return element accessors for a provided array-like object.</span>
52
52
- <spanclass="signature">[`arraylike2object( x )`][@stdlib/array/base/arraylike2object]</span><spanclass="delimiter">: </span><spanclass="description">convert an array-like object to an object likely to have the same "shape".</span>
- <spanclass="signature">[`broadcastArray( x, inShape, outShape )`][@stdlib/array/base/broadcast-array]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an array to a specified shape.</span>
54
55
- <spanclass="signature">[`cartesianPower( x, n )`][@stdlib/array/base/cartesian-power]</span><spanclass="delimiter">: </span><spanclass="description">return the Cartesian power.</span>
55
56
- <spanclass="signature">[`cartesianProduct( x1, x2 )`][@stdlib/array/base/cartesian-product]</span><spanclass="delimiter">: </span><spanclass="description">return the Cartesian product.</span>
56
57
- <spanclass="signature">[`cartesianSquare( x )`][@stdlib/array/base/cartesian-square]</span><spanclass="delimiter">: </span><spanclass="description">return the Cartesian square.</span>
57
58
- <spanclass="signature">[`copyIndexed( x )`][@stdlib/array/base/copy-indexed]</span><spanclass="delimiter">: </span><spanclass="description">copy the elements of an indexed array-like object to a new "generic" array.</span>
58
59
- <spanclass="signature">[`copy( x )`][@stdlib/array/base/copy]</span><spanclass="delimiter">: </span><spanclass="description">copy the elements of an array-like object to a new "generic" array.</span>
59
60
- <spanclass="signature">[`filledBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled "generic" array according to a provided callback function.</span>
60
61
- <spanclass="signature">[`filled( value, len )`][@stdlib/array/base/filled]</span><spanclass="delimiter">: </span><spanclass="description">create a filled "generic" array.</span>
62
+
- <spanclass="signature">[`filled2dBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled2d-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled two-dimensional nested array according to a provided callback function.</span>
- <spanclass="signature">[`filled3dBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled3d-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled three-dimensional nested array according to a provided callback function.</span>
- <spanclass="signature">[`filled4dBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled4d-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled four-dimensional nested array according to a provided callback function.</span>
- <spanclass="signature">[`filled5dBy( len, clbk[, thisArg] )`][@stdlib/array/base/filled5d-by]</span><spanclass="delimiter">: </span><spanclass="description">create a filled five-dimensional nested array according to a provided callback function.</span>
- <spanclass="signature">[`flattenBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten-by]</span><spanclass="delimiter">: </span><spanclass="description">flatten an n-dimensional nested array according to a callback function.</span>
- <spanclass="signature">[`flatten2dBy( x, shape, colexicographic, clbk[, thisArg] )`][@stdlib/array/base/flatten2d-by]</span><spanclass="delimiter">: </span><spanclass="description">flatten a two-dimensional nested array according to a callback function.</span>
- <spanclass="signature">[`oneTo( n )`][@stdlib/array/base/one-to]</span><spanclass="delimiter">: </span><spanclass="description">generate a linearly spaced numeric array whose elements increment by 1 starting from one.</span>
76
88
- <spanclass="signature">[`ones( len )`][@stdlib/array/base/ones]</span><spanclass="delimiter">: </span><spanclass="description">create a "generic" array filled with ones.</span>
89
+
- <spanclass="signature">[`ones2d( shape )`][@stdlib/array/base/ones2d]</span><spanclass="delimiter">: </span><spanclass="description">create a two-dimensional nested array filled with ones.</span>
90
+
- <spanclass="signature">[`ones3d( shape )`][@stdlib/array/base/ones3d]</span><spanclass="delimiter">: </span><spanclass="description">create a three-dimensional nested array filled with ones.</span>
91
+
- <spanclass="signature">[`ones4d( shape )`][@stdlib/array/base/ones4d]</span><spanclass="delimiter">: </span><spanclass="description">create a four-dimensional nested array filled with ones.</span>
92
+
- <spanclass="signature">[`ones5d( shape )`][@stdlib/array/base/ones5d]</span><spanclass="delimiter">: </span><spanclass="description">create a five-dimensional nested array filled with ones.</span>
93
+
- <spanclass="signature">[`onesnd( shape )`][@stdlib/array/base/onesnd]</span><spanclass="delimiter">: </span><spanclass="description">create an n-dimensional nested array filled with ones.</span>
77
94
- <spanclass="signature">[`setter( dtype )`][@stdlib/array/base/setter]</span><spanclass="delimiter">: </span><spanclass="description">return an accessor function for setting an element in an indexed array-like object.</span>
78
95
- <spanclass="signature">[`take( x, indices )`][@stdlib/array/base/take]</span><spanclass="delimiter">: </span><spanclass="description">take elements from an array.</span>
79
96
- <spanclass="signature">[`toAccessorArray( arr )`][@stdlib/array/base/to-accessor-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an array-like object to a minimal array-like object supporting the accessor protocol.</span>
80
97
- <spanclass="signature">[`unitspace( start, stop )`][@stdlib/array/base/unitspace]</span><spanclass="delimiter">: </span><spanclass="description">generate a linearly spaced numeric array whose elements increment by 1.</span>
81
98
- <spanclass="signature">[`zeroTo( n )`][@stdlib/array/base/zero-to]</span><spanclass="delimiter">: </span><spanclass="description">generate a linearly spaced numeric array whose elements increment by 1 starting from zero.</span>
82
99
- <spanclass="signature">[`zeros( len )`][@stdlib/array/base/zeros]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled "generic" array.</span>
100
+
- <spanclass="signature">[`zeros2d( shape )`][@stdlib/array/base/zeros2d]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled two-dimensional nested array.</span>
101
+
- <spanclass="signature">[`zeros3d( shape )`][@stdlib/array/base/zeros3d]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled three-dimensional nested array.</span>
102
+
- <spanclass="signature">[`zeros4d( shape )`][@stdlib/array/base/zeros4d]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled four-dimensional nested array.</span>
103
+
- <spanclass="signature">[`zeros5d( shape )`][@stdlib/array/base/zeros5d]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled five-dimensional nested array.</span>
104
+
- <spanclass="signature">[`zerosnd( shape )`][@stdlib/array/base/zerosnd]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled n-dimensional nested array.</span>
Copy file name to clipboardExpand all lines: lib/node_modules/@stdlib/math/base/special/README.md
+3-3Lines changed: 3 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -157,7 +157,7 @@ var fcns = special;
157
157
- <spanclass="signature">[`clamp( v, min, max )`][@stdlib/math/base/special/clamp]</span><spanclass="delimiter">: </span><spanclass="description">restrict a double-precision floating-point number to a specified range.</span>
158
158
- <spanclass="signature">[`clampf( v, min, max )`][@stdlib/math/base/special/clampf]</span><spanclass="delimiter">: </span><spanclass="description">restrict a single-precision floating-point number to a specified range.</span>
159
159
- <spanclass="signature">[`cround( z )`][@stdlib/math/base/special/cround]</span><spanclass="delimiter">: </span><spanclass="description">round each component of a double-precision complex floating-point number to the nearest integer.</span>
160
-
- <spanclass="signature">[`croundn( [out,] re, im, n )`][@stdlib/math/base/special/croundn]</span><spanclass="delimiter">: </span><spanclass="description">round a complex number to the nearest multiple of `10^n`.</span>
160
+
- <spanclass="signature">[`croundn( z, n )`][@stdlib/math/base/special/croundn]</span><spanclass="delimiter">: </span><spanclass="description">round each component of a double-precision complex floating-point number to the nearest multiple of `10^n`.</span>
161
161
- <spanclass="signature">[`csignum( z )`][@stdlib/math/base/special/csignum]</span><spanclass="delimiter">: </span><spanclass="description">evaluate the signum function of a double-precision complex floating-point number.</span>
162
162
- <spanclass="signature">[`floor( x )`][@stdlib/math/base/special/floor]</span><spanclass="delimiter">: </span><spanclass="description">round a double-precision floating-point number toward negative infinity.</span>
163
163
- <spanclass="signature">[`floor10( x )`][@stdlib/math/base/special/floor10]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest power of 10 toward negative infinity.</span>
@@ -177,7 +177,7 @@ var fcns = special;
177
177
- <spanclass="signature">[`round10( x )`][@stdlib/math/base/special/round10]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest power of 10 on a linear scale.</span>
178
178
- <spanclass="signature">[`round2( x )`][@stdlib/math/base/special/round2]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest power of two on a linear scale.</span>
179
179
- <spanclass="signature">[`roundb( x, n, b )`][@stdlib/math/base/special/roundb]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest multiple of b^n on a linear scale.</span>
180
-
- <spanclass="signature">[`roundn( x, n )`][@stdlib/math/base/special/roundn]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest multiple of 10^n.</span>
180
+
- <spanclass="signature">[`roundn( x, n )`][@stdlib/math/base/special/roundn]</span><spanclass="delimiter">: </span><spanclass="description">round a double-precision floating-point number to the nearest multiple of 10^n.</span>
181
181
- <spanclass="signature">[`roundsd( x, n[, b] )`][@stdlib/math/base/special/roundsd]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest number with `n` significant figures.</span>
182
182
- <spanclass="signature">[`signum( x )`][@stdlib/math/base/special/signum]</span><spanclass="delimiter">: </span><spanclass="description">signum function.</span>
183
183
- <spanclass="signature">[`signumf( x )`][@stdlib/math/base/special/signumf]</span><spanclass="delimiter">: </span><spanclass="description">signum function.</span>
@@ -231,7 +231,7 @@ var fcns = special;
231
231
- <spanclass="signature">[`cot( x )`][@stdlib/math/base/special/cot]</span><spanclass="delimiter">: </span><spanclass="description">evaluate the cotangent of a number.</span>
232
232
- <spanclass="signature">[`coth( x )`][@stdlib/math/base/special/coth]</span><spanclass="delimiter">: </span><spanclass="description">compute the hyperbolic cotangent of a number.</span>
233
233
- <spanclass="signature">[`cphase( z )`][@stdlib/math/base/special/cphase]</span><spanclass="delimiter">: </span><spanclass="description">compute the argument of a double-precision complex floating-point number in radians.</span>
234
-
- <spanclass="signature">[`cpolar( [out,] re, im )`][@stdlib/math/base/special/cpolar]</span><spanclass="delimiter">: </span><spanclass="description">compute the absolute value and phase of a complex number.</span>
234
+
- <spanclass="signature">[`cpolar( z )`][@stdlib/math/base/special/cpolar]</span><spanclass="delimiter">: </span><spanclass="description">compute the absolute value and phase of a double-precision complex floating-point number.</span>
235
235
- <spanclass="signature">[`csch( x )`][@stdlib/math/base/special/csch]</span><spanclass="delimiter">: </span><spanclass="description">compute the hyperbolic cosecant of a number.</span>
236
236
- <spanclass="signature">[`deg2rad( x )`][@stdlib/math/base/special/deg2rad]</span><spanclass="delimiter">: </span><spanclass="description">convert an angle from degrees to radians.</span>
237
237
- <spanclass="signature">[`deg2radf( x )`][@stdlib/math/base/special/deg2radf]</span><spanclass="delimiter">: </span><spanclass="description">convert an angle from degrees to radians (single-precision).</span>
0 commit comments