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/README.md
+78-18Lines changed: 78 additions & 18 deletions
Original file line number
Diff line number
Diff line change
@@ -148,11 +148,31 @@ Lastly, the namespace contains various other functions for dealing with arrays,
148
148
149
149
<divclass="namespace-toc">
150
150
151
-
- <spanclass="signature">[`convertArray( arr, dtype )`][@stdlib/array/convert]</span><spanclass="delimiter">: </span><spanclass="description">convert an array to an array of a different data type.</span>
151
+
- <spanclass="signature">[`Complex128Array()`][@stdlib/array/complex128]</span><spanclass="delimiter">: </span><spanclass="description">128-bit complex number array.</span>
152
+
- <spanclass="signature">[`Complex64Array()`][@stdlib/array/complex64]</span><spanclass="delimiter">: </span><spanclass="description">64-bit complex number array.</span>
152
153
- <spanclass="signature">[`convertArraySame( x, y )`][@stdlib/array/convert-same]</span><spanclass="delimiter">: </span><spanclass="description">convert an array to the same data type as a second input array.</span>
154
+
- <spanclass="signature">[`convertArray( arr, dtype )`][@stdlib/array/convert]</span><spanclass="delimiter">: </span><spanclass="description">convert an array to an array of a different data type.</span>
155
+
- <spanclass="signature">[`DataView( buffer[, byteOffset[, byteLength]] )`][@stdlib/array/dataview]</span><spanclass="delimiter">: </span><spanclass="description">constructor which returns a data view representing a provided array buffer.</span>
153
156
- <spanclass="signature">[`arrayDataType( array )`][@stdlib/array/dtype]</span><spanclass="delimiter">: </span><spanclass="description">return the data type of an array.</span>
157
+
- <spanclass="signature">[`filledarray()`][@stdlib/array/filled]</span><spanclass="delimiter">: </span><spanclass="description">create a filled array.</span>
158
+
- <spanclass="signature">[`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create (or fill) an array from an iterator.</span>
159
+
- <spanclass="signature">[`arrayMinDataType( value )`][@stdlib/array/min-dtype]</span><spanclass="delimiter">: </span><spanclass="description">determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value.</span>
160
+
- <spanclass="signature">[`arrayNextDataType( [dtype] )`][@stdlib/array/next-dtype]</span><spanclass="delimiter">: </span><spanclass="description">return the next larger array data type of the same kind.</span>
161
+
- <spanclass="signature">[`typedarraypool()`][@stdlib/array/pool]</span><spanclass="delimiter">: </span><spanclass="description">allocate typed arrays from a typed array memory pool.</span>
162
+
- <spanclass="signature">[`arrayPromotionRules( [dtype1, dtype2] )`][@stdlib/array/promotion-rules]</span><spanclass="delimiter">: </span><spanclass="description">return the array data type with the smallest size and closest "kind" to which array data types can be **safely** cast.</span>
154
163
- <spanclass="signature">[`reviveTypedArray( key, value )`][@stdlib/array/reviver]</span><spanclass="delimiter">: </span><spanclass="description">revive a JSON-serialized typed array.</span>
164
+
- <spanclass="signature">[`arraySafeCasts( [dtype] )`][@stdlib/array/safe-casts]</span><spanclass="delimiter">: </span><spanclass="description">return a list of array data types to which a provided array data type can be safely cast.</span>
165
+
- <spanclass="signature">[`arraySameKindCasts( [dtype] )`][@stdlib/array/same-kind-casts]</span><spanclass="delimiter">: </span><spanclass="description">return a list of array data types to which a provided array data type can be safely cast or cast within the same "kind".</span>
- <spanclass="signature">[`circarray2iterator( src[, options][, mapFcn[, thisArg]] )`][@stdlib/array/to-circular-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator which repeatedly iterates over the elements of an array-like object.</span>
168
+
- <spanclass="signature">[`array2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator-right]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from an array-like object, iterating from right to left.</span>
169
+
- <spanclass="signature">[`array2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from an array-like object.</span>
155
170
- <spanclass="signature">[`typedarray2json( typedarray )`][@stdlib/array/to-json]</span><spanclass="delimiter">: </span><spanclass="description">return a JSON representation of a typed array.</span>
171
+
- <spanclass="signature">[`sparsearray2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-sparse-iterator-right]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from a sparse array-like object, iterating from right to left.</span>
172
+
- <spanclass="signature">[`sparsearray2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-sparse-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from a sparse array-like object.</span>
173
+
- <spanclass="signature">[`stridedarray2iterator( N, src, stride, offset[, mapFcn[, thisArg]] )`][@stdlib/array/to-strided-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from a strided array-like object.</span>
174
+
- <spanclass="signature">[`arrayview2iteratorRight( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator-right]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from an array-like object view, iterating from right to left.</span>
175
+
- <spanclass="signature">[`arrayview2iterator( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator]</span><spanclass="delimiter">: </span><spanclass="description">create an iterator from an array-like object view.</span>
0 commit comments