129 lines
3.1 KiB
Markdown
129 lines
3.1 KiB
Markdown
<!--
|
|
|
|
@license Apache-2.0
|
|
|
|
Copyright (c) 2018 The Stdlib Authors.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
|
|
-->
|
|
|
|
# Convert
|
|
|
|
> Convert an array to an array of a different data type.
|
|
|
|
<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
|
|
|
|
<section class="intro">
|
|
|
|
</section>
|
|
|
|
<!-- /.intro -->
|
|
|
|
<!-- Package usage documentation. -->
|
|
|
|
<section class="usage">
|
|
|
|
## Usage
|
|
|
|
```javascript
|
|
var convertArray = require( '@stdlib/array/convert' );
|
|
```
|
|
|
|
#### convertArray( arr, dtype )
|
|
|
|
Converts an `array` to an array of a different data type.
|
|
|
|
```javascript
|
|
var arr = [ 1.0, 2.0, 3.0 ];
|
|
var out = convertArray( arr, 'float32' );
|
|
// returns <Float32Array>[ 1.0, 2.0, 3.0 ]
|
|
```
|
|
|
|
The function supports the following data types:
|
|
|
|
- `float32`: single-precision floating-point numbers.
|
|
- `float64`: double-precision floating-point numbers.
|
|
- `generic`: values of any type.
|
|
- `int16`: signed 16-bit integers.
|
|
- `int32`: signed 32-bit integers.
|
|
- `int8`: signed 8-bit integers.
|
|
- `uint16`: unsigned 16-bit integers.
|
|
- `uint32`: unsigned 32-bit integers.
|
|
- `uint8`: unsigned 8-bit integers.
|
|
- `uint8c`: unsigned clamped 8-bit integers.
|
|
|
|
</section>
|
|
|
|
<!-- /.usage -->
|
|
|
|
<!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="notes">
|
|
|
|
</section>
|
|
|
|
<!-- /.notes -->
|
|
|
|
<!-- Package usage examples. -->
|
|
|
|
<section class="examples">
|
|
|
|
## Examples
|
|
|
|
<!-- eslint no-undef: "error" -->
|
|
|
|
```javascript
|
|
var dtypes = require( '@stdlib/array/dtypes' );
|
|
var randu = require( '@stdlib/random/base/randu' );
|
|
var floor = require( '@stdlib/math/base/special/floor' );
|
|
var convertArray = require( '@stdlib/array/convert' );
|
|
|
|
// Create a generic array:
|
|
var arr = [];
|
|
var i;
|
|
for ( i = 0; i < 5; i++ ) {
|
|
arr.push( floor( randu()*1.0e25 ) - 5.0e24 );
|
|
}
|
|
|
|
// Get a list of array data types:
|
|
var DTYPES = dtypes();
|
|
|
|
// Convert the generic array to each array data type:
|
|
var out;
|
|
for ( i = 0; i < DTYPES.length; i++ ) {
|
|
out = convertArray( arr, DTYPES[ i ] );
|
|
console.log( out );
|
|
}
|
|
```
|
|
|
|
</section>
|
|
|
|
<!-- /.examples -->
|
|
|
|
<!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="references">
|
|
|
|
</section>
|
|
|
|
<!-- /.references -->
|
|
|
|
<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
|
|
|
|
<section class="links">
|
|
|
|
</section>
|
|
|
|
<!-- /.links -->
|