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/math/base/special/README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -154,7 +154,7 @@ var fcns = special;
154
154
- <spanclass="signature">[`ceiln( x, n )`][@stdlib/math/base/special/ceiln]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest multiple of 10^n toward positive infinity.</span>
155
155
- <spanclass="signature">[`ceilsd( x, n[, b] )`][@stdlib/math/base/special/ceilsd]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest number toward positive infinity with N significant figures.</span>
156
156
- <spanclass="signature">[`cfloor( z )`][@stdlib/math/base/special/cfloor]</span><spanclass="delimiter">: </span><spanclass="description">round a double-precision complex floating-point number toward negative infinity.</span>
157
-
- <spanclass="signature">[`cfloorn( [out,] re, im, n )`][@stdlib/math/base/special/cfloorn]</span><spanclass="delimiter">: </span><spanclass="description">round a complex number to the nearest multiple of `10^n` toward negative infinity.</span>
157
+
- <spanclass="signature">[`cfloorn( z, n )`][@stdlib/math/base/special/cfloorn]</span><spanclass="delimiter">: </span><spanclass="description">round each component of a double-precision complex floating-point number to the nearest multiple of `10^n` toward negative infinity.</span>
158
158
- <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>
159
159
- <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>
160
160
- <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>
@@ -165,7 +165,7 @@ var fcns = special;
165
165
- <spanclass="signature">[`floor2( x )`][@stdlib/math/base/special/floor2]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest power of two toward negative infinity.</span>
166
166
- <spanclass="signature">[`floorb( x, n, b )`][@stdlib/math/base/special/floorb]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest multiple of b^n toward negative infinity.</span>
167
167
- <spanclass="signature">[`floorf( x )`][@stdlib/math/base/special/floorf]</span><spanclass="delimiter">: </span><spanclass="description">round a single-precision floating-point numeric value toward negative infinity.</span>
168
-
- <spanclass="signature">[`floorn( x, n )`][@stdlib/math/base/special/floorn]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest multiple of 10^n toward negative infinity.</span>
168
+
- <spanclass="signature">[`floorn( x, n )`][@stdlib/math/base/special/floorn]</span><spanclass="delimiter">: </span><spanclass="description">round a double-precision floating-point number to the nearest multiple of 10^n toward negative infinity.</span>
169
169
- <spanclass="signature">[`floorsd( x, n[, b] )`][@stdlib/math/base/special/floorsd]</span><spanclass="delimiter">: </span><spanclass="description">round a numeric value to the nearest number toward negative infinity with N significant figures.</span>
170
170
- <spanclass="signature">[`labs( x )`][@stdlib/math/base/special/labs]</span><spanclass="delimiter">: </span><spanclass="description">compute an absolute value of a signed 32-bit integer.</span>
171
171
- <spanclass="signature">[`maxabs( x, y )`][@stdlib/math/base/special/maxabs]</span><spanclass="delimiter">: </span><spanclass="description">return the maximum absolute value.</span>
@@ -70,24 +71,41 @@ In addition, the namespace contains the following multidimensional array utility
70
71
71
72
<divclass="namespace-toc">
72
73
74
+
- <spanclass="signature">[`broadcastArray( x, shape )`][@stdlib/ndarray/broadcast-array]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an ndarray to a specified shape.</span>
73
75
- <spanclass="signature">[`ndarrayCastingModes()`][@stdlib/ndarray/casting-modes]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray casting modes.</span>
76
+
- <spanclass="signature">[`ndarrayDataBuffer( x )`][@stdlib/ndarray/data-buffer]</span><spanclass="delimiter">: </span><spanclass="description">return the underlying data buffer of a provided ndarray.</span>
- <spanclass="signature">[`dispatch( fcns, types, data, nargs, nin, nout )`][@stdlib/ndarray/dispatch]</span><spanclass="delimiter">: </span><spanclass="description">create an ndarray function interface which performs multiple dispatch.</span>
79
+
- <spanclass="signature">[`ndarrayDataType( x )`][@stdlib/ndarray/dtype]</span><spanclass="delimiter">: </span><spanclass="description">return the data type of a provided ndarray.</span>
76
80
- <spanclass="signature">[`ndarrayDataTypes( [kind] )`][@stdlib/ndarray/dtypes]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray data types.</span>
77
81
- <spanclass="signature">[`ndemptyLike( x[, options] )`][@stdlib/ndarray/empty-like]</span><spanclass="delimiter">: </span><spanclass="description">create an uninitialized ndarray having the same shape and data type as a provided ndarray.</span>
78
82
- <spanclass="signature">[`ndempty( shape[, options] )`][@stdlib/ndarray/empty]</span><spanclass="delimiter">: </span><spanclass="description">create an uninitialized ndarray having a specified shape and data type.</span>
- <spanclass="signature">[`scalar2ndarray( value[, options] )`][@stdlib/ndarray/from-scalar]</span><spanclass="delimiter">: </span><spanclass="description">convert a scalar value to a zero-dimensional ndarray.</span>
80
85
- <spanclass="signature">[`ind2sub( shape, idx[, options] )`][@stdlib/ndarray/ind2sub]</span><spanclass="delimiter">: </span><spanclass="description">convert a linear index to an array of subscripts.</span>
81
86
- <spanclass="signature">[`ndarrayIndexModes()`][@stdlib/ndarray/index-modes]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray index modes.</span>
87
+
- <spanclass="signature">[`maybeBroadcastArray( x, shape )`][@stdlib/ndarray/maybe-broadcast-array]</span><spanclass="delimiter">: </span><spanclass="description">broadcast an ndarray to a specified shape if and only if the specified shape differs from the provided ndarray's shape.</span>
82
88
- <spanclass="signature">[`ndarrayMinDataType( value )`][@stdlib/ndarray/min-dtype]</span><spanclass="delimiter">: </span><spanclass="description">determine the minimum ndarray data type of the closest "kind" necessary for storing a provided scalar value.</span>
89
+
- <spanclass="signature">[`ndarrayMostlySafeCasts( [dtype] )`][@stdlib/ndarray/mostly-safe-casts]</span><spanclass="delimiter">: </span><spanclass="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast and, for floating-point data types, can be downcast.</span>
90
+
- <spanclass="signature">[`ndims( x )`][@stdlib/ndarray/ndims]</span><spanclass="delimiter">: </span><spanclass="description">return the number of ndarray dimensions.</span>
83
91
- <spanclass="signature">[`ndarrayNextDataType( [dtype] )`][@stdlib/ndarray/next-dtype]</span><spanclass="delimiter">: </span><spanclass="description">return the next larger ndarray data type of the same kind.</span>
92
+
- <spanclass="signature">[`numel( x )`][@stdlib/ndarray/numel]</span><spanclass="delimiter">: </span><spanclass="description">return the number of elements in an ndarray.</span>
93
+
- <spanclass="signature">[`ndarrayOffset( x )`][@stdlib/ndarray/offset]</span><spanclass="delimiter">: </span><spanclass="description">return the index offset specifying the underlying buffer index of the first iterated ndarray element.</span>
94
+
- <spanclass="signature">[`ndarrayOrder( x )`][@stdlib/ndarray/order]</span><spanclass="delimiter">: </span><spanclass="description">return the layout order of a provided ndarray.</span>
84
95
- <spanclass="signature">[`ndarrayOrders()`][@stdlib/ndarray/orders]</span><spanclass="delimiter">: </span><spanclass="description">list of ndarray orders.</span>
85
96
- <spanclass="signature">[`ndarrayOutputDataTypePolicies()`][@stdlib/ndarray/output-dtype-policies]</span><spanclass="delimiter">: </span><spanclass="description">list of output ndarray data type policies.</span>
86
97
- <spanclass="signature">[`ndarrayPromotionRules( [dtype1, dtype2] )`][@stdlib/ndarray/promotion-rules]</span><spanclass="delimiter">: </span><spanclass="description">return the ndarray data type with the smallest size and closest "kind" to which ndarray data types can be **safely** cast.</span>
87
98
- <spanclass="signature">[`ndarraySafeCasts( [dtype] )`][@stdlib/ndarray/safe-casts]</span><spanclass="delimiter">: </span><spanclass="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast.</span>
88
99
- <spanclass="signature">[`ndarraySameKindCasts( [dtype] )`][@stdlib/ndarray/same-kind-casts]</span><spanclass="delimiter">: </span><spanclass="description">return a list of ndarray data types to which a provided ndarray data type can be safely cast or cast within the same "kind".</span>
100
+
- <spanclass="signature">[`ndarrayShape( x )`][@stdlib/ndarray/shape]</span><spanclass="delimiter">: </span><spanclass="description">return the shape of a provided ndarray.</span>
101
+
- <spanclass="signature">[`ndsliceAssign( x, y, ...s[, options] )`][@stdlib/ndarray/slice-assign]</span><spanclass="delimiter">: </span><spanclass="description">assign element values from a broadcasted input `ndarray` to corresponding elements in an output `ndarray` view.</span>
102
+
- <spanclass="signature">[`ndsliceDimensionFrom( x, dim, start[, options] )`][@stdlib/ndarray/slice-dimension-from]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only shifted view of an input `ndarray` along a specified dimension.</span>
103
+
- <spanclass="signature">[`ndsliceDimensionTo( x, dim, stop[, options] )`][@stdlib/ndarray/slice-dimension-to]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only truncated view of an input `ndarray` along a specified dimension.</span>
104
+
- <spanclass="signature">[`ndsliceDimension( x, dim, slice[, options] )`][@stdlib/ndarray/slice-dimension]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only view of an input `ndarray` when sliced along a specified dimension.</span>
105
+
- <spanclass="signature">[`ndslice( x, ...s[, options] )`][@stdlib/ndarray/slice]</span><spanclass="delimiter">: </span><spanclass="description">return a read-only view of an input `ndarray`.</span>
106
+
- <spanclass="signature">[`ndarrayStrides( x )`][@stdlib/ndarray/strides]</span><spanclass="delimiter">: </span><spanclass="description">return the strides of a provided ndarray.</span>
89
107
- <spanclass="signature">[`sub2ind( shape, ...subscripts[, options] )`][@stdlib/ndarray/sub2ind]</span><spanclass="delimiter">: </span><spanclass="description">convert subscripts to a linear index.</span>
90
-
- <spanclass="signature">[`ndarray2array( arr )`][@stdlib/ndarray/to-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray to a generic array.</span>
108
+
- <spanclass="signature">[`ndarray2array( x )`][@stdlib/ndarray/to-array]</span><spanclass="delimiter">: </span><spanclass="description">convert an ndarray to a generic array.</span>
91
109
- <spanclass="signature">[`ndzerosLike( x[, options] )`][@stdlib/ndarray/zeros-like]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled ndarray having the same shape and data type as a provided ndarray.</span>
92
110
- <spanclass="signature">[`ndzeros( shape[, options] )`][@stdlib/ndarray/zeros]</span><spanclass="delimiter">: </span><spanclass="description">create a zero-filled ndarray having a specified shape and data type.</span>
0 commit comments