README.md (20458B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Arrays 22 23 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] [![dependencies][dependencies-image]][dependencies-url] 24 25 > Arrays. 26 27 <section class="installation"> 28 29 ## Installation 30 31 ```bash 32 npm install @stdlib/array 33 ``` 34 35 </section> 36 37 <section class="usage"> 38 39 ## Usage 40 41 ```javascript 42 var ns = require( '@stdlib/array' ); 43 ``` 44 45 #### ns 46 47 Arrays. 48 49 ```javascript 50 var o = ns; 51 // returns {...} 52 ``` 53 54 The namespace exports the following array constructors: 55 56 <!-- <toc pattern="+(int*|float*|uint*|*buffer)"> --> 57 58 <div class="namespace-toc"> 59 60 - <span class="signature">[`ArrayBuffer( size )`][@stdlib/array/buffer]</span><span class="delimiter">: </span><span class="description">constructor which returns an object used to represent a generic, fixed-length raw binary data buffer.</span> 61 - <span class="signature">[`Float32Array()`][@stdlib/array/float32]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of single-precision floating-point numbers in the platform byte order.</span> 62 - <span class="signature">[`Float64Array()`][@stdlib/array/float64]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of double-precision floating-point numbers in the platform byte order.</span> 63 - <span class="signature">[`Int16Array()`][@stdlib/array/int16]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of twos-complement 16-bit signed integers in the platform byte order.</span> 64 - <span class="signature">[`Int32Array()`][@stdlib/array/int32]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of twos-complement 32-bit signed integers in the platform byte order.</span> 65 - <span class="signature">[`Int8Array()`][@stdlib/array/int8]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of twos-complement 8-bit signed integers in the platform byte order.</span> 66 - <span class="signature">[`SharedArrayBuffer( size )`][@stdlib/array/shared-buffer]</span><span class="delimiter">: </span><span class="description">constructor returning an object used to represent a generic, fixed-length raw binary data buffer which can be used to create views of shared memory.</span> 67 - <span class="signature">[`Uint16Array()`][@stdlib/array/uint16]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of 16-bit unsigned integers in the platform byte order.</span> 68 - <span class="signature">[`Uint32Array()`][@stdlib/array/uint32]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of 32-bit unsigned integers in the platform byte order.</span> 69 - <span class="signature">[`Uint8Array()`][@stdlib/array/uint8]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order.</span> 70 - <span class="signature">[`Uint8ClampedArray()`][@stdlib/array/uint8c]</span><span class="delimiter">: </span><span class="description">typed array constructor which returns a typed array representing an array of 8-bit unsigned integers in the platform byte order clamped to 0-255.</span> 71 72 </div> 73 74 <!-- </toc> --> 75 76 ```javascript 77 var arr = new ns.Int32Array( 5 ); 78 // returns <Int32Array>[ 0, 0, 0, 0, 0 ] 79 ``` 80 81 Alternatively, use the `typedarray` function to create a typed array of a given data type: 82 83 <!-- <toc pattern="typed"> --> 84 85 <div class="namespace-toc"> 86 87 - <span class="signature">[`typedarray()`][@stdlib/array/typed]</span><span class="delimiter">: </span><span class="description">create a typed array.</span> 88 89 </div> 90 91 <!-- </toc> --> 92 93 ```javascript 94 var arr1 = ns.typedarray( 5 ); 95 // returns <Float64Array>[ 0.0, 0.0, 0.0, 0.0, 0.0 ] 96 97 var arr2 = ns.typedarray( 5, 'uint8' ); 98 // returns <Uint8Array>[ 0, 0, 0, 0, 0 ] 99 ``` 100 101 The namespace contains functions to create arrays pre-filled with spaced values: 102 103 <!-- <toc pattern="*space"> --> 104 105 <div class="namespace-toc"> 106 107 - <span class="signature">[`datespace( start, stop[, length][, opts] )`][@stdlib/array/datespace]</span><span class="delimiter">: </span><span class="description">generate an array of linearly spaced dates.</span> 108 - <span class="signature">[`incrspace( start, stop[, increment] )`][@stdlib/array/incrspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array using a provided increment.</span> 109 - <span class="signature">[`linspace( start, stop[, length] )`][@stdlib/array/linspace]</span><span class="delimiter">: </span><span class="description">generate a linearly spaced numeric array.</span> 110 - <span class="signature">[`logspace( a, b[, length] )`][@stdlib/array/logspace]</span><span class="delimiter">: </span><span class="description">generate a logarithmically spaced numeric array.</span> 111 112 </div> 113 114 <!-- </toc> --> 115 116 You can use the following functions to retrieve a list of available data types: 117 118 <!-- <toc pattern="*dtypes"> --> 119 120 <div class="namespace-toc"> 121 122 - <span class="signature">[`arrayDataTypes()`][@stdlib/array/dtypes]</span><span class="delimiter">: </span><span class="description">list of array data types.</span> 123 - <span class="signature">[`typedarrayComplexDataTypes()`][@stdlib/array/typed-complex-dtypes]</span><span class="delimiter">: </span><span class="description">list of complex typed array data types.</span> 124 - <span class="signature">[`typedarrayDataTypes()`][@stdlib/array/typed-dtypes]</span><span class="delimiter">: </span><span class="description">list of typed array data types.</span> 125 126 </div> 127 128 <!-- </toc> --> 129 130 ```javascript 131 var DTYPES = ns.arrayDataTypes(); 132 // returns [ 'float32', 'float64', 'generic', 'int16', 'int32', 'int8', 'uint16', 'uint32', 'uint8', 'uint8c' ] 133 ``` 134 135 Furthermore, the namespace contains utility functions to retrieve a given constructor: 136 137 <!-- <toc keywords="+constructors,+constructor"> --> 138 139 <div class="namespace-toc"> 140 141 - <span class="signature">[`arrayCtors( dtype )`][@stdlib/array/ctors]</span><span class="delimiter">: </span><span class="description">array constructors.</span> 142 - <span class="signature">[`typedarrayComplexCtors( dtype )`][@stdlib/array/typed-complex-ctors]</span><span class="delimiter">: </span><span class="description">complex typed array constructors.</span> 143 - <span class="signature">[`typedarrayCtors( dtype )`][@stdlib/array/typed-ctors]</span><span class="delimiter">: </span><span class="description">typed array constructors.</span> 144 145 </div> 146 147 <!-- </toc> --> 148 149 ```javascript 150 var ctor = ns.typedarrayCtors( 'float64' ); 151 // returns <Function> 152 153 ctor = ns.typedarrayCtors( 'int' ); 154 // returns null 155 ``` 156 157 Lastly, the namespace contains various other functions for dealing with arrays, including functions to convert arrays from one data type to another or to serialize them as JSON and vice versa. 158 159 <!-- <toc ignore="+(int*|float*|uint*|*buffer)" ignore="typed" ignore="*dtypes" keywords="-constructors,-constructor"> --> 160 161 <div class="namespace-toc"> 162 163 - <span class="signature">[`Complex128Array()`][@stdlib/array/complex128]</span><span class="delimiter">: </span><span class="description">128-bit complex number array.</span> 164 - <span class="signature">[`Complex64Array()`][@stdlib/array/complex64]</span><span class="delimiter">: </span><span class="description">64-bit complex number array.</span> 165 - <span class="signature">[`convertArraySame( x, y )`][@stdlib/array/convert-same]</span><span class="delimiter">: </span><span class="description">convert an array to the same data type as a second input array.</span> 166 - <span class="signature">[`convertArray( arr, dtype )`][@stdlib/array/convert]</span><span class="delimiter">: </span><span class="description">convert an array to an array of a different data type.</span> 167 - <span class="signature">[`DataView( buffer[, byteOffset[, byteLength]] )`][@stdlib/array/dataview]</span><span class="delimiter">: </span><span class="description">constructor which returns a data view representing a provided array buffer.</span> 168 - <span class="signature">[`arrayDataType( array )`][@stdlib/array/dtype]</span><span class="delimiter">: </span><span class="description">return the data type of an array.</span> 169 - <span class="signature">[`filledarray()`][@stdlib/array/filled]</span><span class="delimiter">: </span><span class="description">create a filled array.</span> 170 - <span class="signature">[`iterator2array( iterator[, out][, mapFcn[, thisArg]] )`][@stdlib/array/from-iterator]</span><span class="delimiter">: </span><span class="description">create (or fill) an array from an iterator.</span> 171 - <span class="signature">[`arrayMinDataType( value )`][@stdlib/array/min-dtype]</span><span class="delimiter">: </span><span class="description">determine the minimum array data type of the closest "kind" necessary for storing a provided scalar value.</span> 172 - <span class="signature">[`arrayNextDataType( [dtype] )`][@stdlib/array/next-dtype]</span><span class="delimiter">: </span><span class="description">return the next larger array data type of the same kind.</span> 173 - <span class="signature">[`typedarraypool()`][@stdlib/array/pool]</span><span class="delimiter">: </span><span class="description">allocate typed arrays from a typed array memory pool.</span> 174 - <span class="signature">[`arrayPromotionRules( [dtype1, dtype2] )`][@stdlib/array/promotion-rules]</span><span class="delimiter">: </span><span class="description">return the array data type with the smallest size and closest "kind" to which array data types can be **safely** cast.</span> 175 - <span class="signature">[`reviveTypedArray( key, value )`][@stdlib/array/reviver]</span><span class="delimiter">: </span><span class="description">revive a JSON-serialized typed array.</span> 176 - <span class="signature">[`arraySafeCasts( [dtype] )`][@stdlib/array/safe-casts]</span><span class="delimiter">: </span><span class="description">return a list of array data types to which a provided array data type can be safely cast.</span> 177 - <span class="signature">[`arraySameKindCasts( [dtype] )`][@stdlib/array/same-kind-casts]</span><span class="delimiter">: </span><span class="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> 178 - <span class="signature">[`arrayShape( arr )`][@stdlib/array/shape]</span><span class="delimiter">: </span><span class="description">determine (nested) array dimensions.</span> 179 - <span class="signature">[`circarray2iterator( src[, options][, mapFcn[, thisArg]] )`][@stdlib/array/to-circular-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator which repeatedly iterates over the elements of an array-like object.</span> 180 - <span class="signature">[`array2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object, iterating from right to left.</span> 181 - <span class="signature">[`array2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object.</span> 182 - <span class="signature">[`typedarray2json( typedarray )`][@stdlib/array/to-json]</span><span class="delimiter">: </span><span class="description">return a JSON representation of a typed array.</span> 183 - <span class="signature">[`sparsearray2iteratorRight( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-sparse-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator from a sparse array-like object, iterating from right to left.</span> 184 - <span class="signature">[`sparsearray2iterator( src[, mapFcn[, thisArg]] )`][@stdlib/array/to-sparse-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from a sparse array-like object.</span> 185 - <span class="signature">[`stridedarray2iterator( N, src, stride, offset[, mapFcn[, thisArg]] )`][@stdlib/array/to-strided-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from a strided array-like object.</span> 186 - <span class="signature">[`arrayview2iteratorRight( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator-right]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object view, iterating from right to left.</span> 187 - <span class="signature">[`arrayview2iterator( src[, begin[, end]][, mapFcn[, thisArg]] )`][@stdlib/array/to-view-iterator]</span><span class="delimiter">: </span><span class="description">create an iterator from an array-like object view.</span> 188 189 </div> 190 191 <!-- </toc> --> 192 193 </section> 194 195 <!-- /.usage --> 196 197 <section class="examples"> 198 199 ## Examples 200 201 <!-- TODO: better examples --> 202 203 <!-- eslint no-undef: "error" --> 204 205 ```javascript 206 var objectKeys = require( '@stdlib/utils/keys' ); 207 var ns = require( '@stdlib/array' ); 208 209 console.log( objectKeys( ns ) ); 210 ``` 211 212 </section> 213 214 <!-- /.examples --> 215 216 217 <section class="main-repo" > 218 219 * * * 220 221 ## Notice 222 223 This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. 224 225 For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. 226 227 #### Community 228 229 [![Chat][chat-image]][chat-url] 230 231 --- 232 233 ## License 234 235 See [LICENSE][stdlib-license]. 236 237 238 ## Copyright 239 240 Copyright © 2016-2021. The Stdlib [Authors][stdlib-authors]. 241 242 </section> 243 244 <!-- /.stdlib --> 245 246 <!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --> 247 248 <section class="links"> 249 250 [npm-image]: http://img.shields.io/npm/v/@stdlib/array.svg 251 [npm-url]: https://npmjs.org/package/@stdlib/array 252 253 [test-image]: https://github.com/stdlib-js/array/actions/workflows/test.yml/badge.svg 254 [test-url]: https://github.com/stdlib-js/array/actions/workflows/test.yml 255 256 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/array/main.svg 257 [coverage-url]: https://codecov.io/github/stdlib-js/array?branch=main 258 259 [dependencies-image]: https://img.shields.io/david/stdlib-js/array.svg 260 [dependencies-url]: https://david-dm.org/stdlib-js/array/main 261 262 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg 263 [chat-url]: https://gitter.im/stdlib-js/stdlib/ 264 265 [stdlib]: https://github.com/stdlib-js/stdlib 266 267 [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors 268 269 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/array/main/LICENSE 270 271 <!-- <toc-links> --> 272 273 [@stdlib/array/complex128]: https://www.npmjs.com/package/@stdlib/array/tree/main/complex128 274 275 [@stdlib/array/complex64]: https://www.npmjs.com/package/@stdlib/array/tree/main/complex64 276 277 [@stdlib/array/convert-same]: https://www.npmjs.com/package/@stdlib/array/tree/main/convert-same 278 279 [@stdlib/array/convert]: https://www.npmjs.com/package/@stdlib/array/tree/main/convert 280 281 [@stdlib/array/dataview]: https://www.npmjs.com/package/@stdlib/array/tree/main/dataview 282 283 [@stdlib/array/dtype]: https://www.npmjs.com/package/@stdlib/array/tree/main/dtype 284 285 [@stdlib/array/filled]: https://www.npmjs.com/package/@stdlib/array/tree/main/filled 286 287 [@stdlib/array/from-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/from-iterator 288 289 [@stdlib/array/min-dtype]: https://www.npmjs.com/package/@stdlib/array/tree/main/min-dtype 290 291 [@stdlib/array/next-dtype]: https://www.npmjs.com/package/@stdlib/array/tree/main/next-dtype 292 293 [@stdlib/array/pool]: https://www.npmjs.com/package/@stdlib/array/tree/main/pool 294 295 [@stdlib/array/promotion-rules]: https://www.npmjs.com/package/@stdlib/array/tree/main/promotion-rules 296 297 [@stdlib/array/reviver]: https://www.npmjs.com/package/@stdlib/array/tree/main/reviver 298 299 [@stdlib/array/safe-casts]: https://www.npmjs.com/package/@stdlib/array/tree/main/safe-casts 300 301 [@stdlib/array/same-kind-casts]: https://www.npmjs.com/package/@stdlib/array/tree/main/same-kind-casts 302 303 [@stdlib/array/shape]: https://www.npmjs.com/package/@stdlib/array/tree/main/shape 304 305 [@stdlib/array/to-circular-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-circular-iterator 306 307 [@stdlib/array/to-iterator-right]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-iterator-right 308 309 [@stdlib/array/to-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-iterator 310 311 [@stdlib/array/to-json]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-json 312 313 [@stdlib/array/to-sparse-iterator-right]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-sparse-iterator-right 314 315 [@stdlib/array/to-sparse-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-sparse-iterator 316 317 [@stdlib/array/to-strided-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-strided-iterator 318 319 [@stdlib/array/to-view-iterator-right]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-view-iterator-right 320 321 [@stdlib/array/to-view-iterator]: https://www.npmjs.com/package/@stdlib/array/tree/main/to-view-iterator 322 323 [@stdlib/array/ctors]: https://www.npmjs.com/package/@stdlib/array/tree/main/ctors 324 325 [@stdlib/array/typed-complex-ctors]: https://www.npmjs.com/package/@stdlib/array/tree/main/typed-complex-ctors 326 327 [@stdlib/array/typed-ctors]: https://www.npmjs.com/package/@stdlib/array/tree/main/typed-ctors 328 329 [@stdlib/array/dtypes]: https://www.npmjs.com/package/@stdlib/array/tree/main/dtypes 330 331 [@stdlib/array/typed-complex-dtypes]: https://www.npmjs.com/package/@stdlib/array/tree/main/typed-complex-dtypes 332 333 [@stdlib/array/typed-dtypes]: https://www.npmjs.com/package/@stdlib/array/tree/main/typed-dtypes 334 335 [@stdlib/array/datespace]: https://www.npmjs.com/package/@stdlib/array/tree/main/datespace 336 337 [@stdlib/array/incrspace]: https://www.npmjs.com/package/@stdlib/array/tree/main/incrspace 338 339 [@stdlib/array/linspace]: https://www.npmjs.com/package/@stdlib/array/tree/main/linspace 340 341 [@stdlib/array/logspace]: https://www.npmjs.com/package/@stdlib/array/tree/main/logspace 342 343 [@stdlib/array/typed]: https://www.npmjs.com/package/@stdlib/array/tree/main/typed 344 345 [@stdlib/array/buffer]: https://www.npmjs.com/package/@stdlib/array/tree/main/buffer 346 347 [@stdlib/array/float32]: https://www.npmjs.com/package/@stdlib/array/tree/main/float32 348 349 [@stdlib/array/float64]: https://www.npmjs.com/package/@stdlib/array/tree/main/float64 350 351 [@stdlib/array/int16]: https://www.npmjs.com/package/@stdlib/array/tree/main/int16 352 353 [@stdlib/array/int32]: https://www.npmjs.com/package/@stdlib/array/tree/main/int32 354 355 [@stdlib/array/int8]: https://www.npmjs.com/package/@stdlib/array/tree/main/int8 356 357 [@stdlib/array/shared-buffer]: https://www.npmjs.com/package/@stdlib/array/tree/main/shared-buffer 358 359 [@stdlib/array/uint16]: https://www.npmjs.com/package/@stdlib/array/tree/main/uint16 360 361 [@stdlib/array/uint32]: https://www.npmjs.com/package/@stdlib/array/tree/main/uint32 362 363 [@stdlib/array/uint8]: https://www.npmjs.com/package/@stdlib/array/tree/main/uint8 364 365 [@stdlib/array/uint8c]: https://www.npmjs.com/package/@stdlib/array/tree/main/uint8c 366 367 <!-- </toc-links> --> 368 369 </section> 370 371 <!-- /.links -->