132 lines
2.9 KiB
Markdown
132 lines
2.9 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# Bytes per Element
|
||
|
|
|
||
|
|
> Return the number of bytes per element provided an underlying [array data type][@stdlib/ndarray/dtypes].
|
||
|
|
|
||
|
|
<!-- 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 bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### bytesPerElement( dtype )
|
||
|
|
|
||
|
|
Returns the number of bytes per element provided an underlying [array data type][@stdlib/ndarray/dtypes].
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var nbytes = bytesPerElement( 'float64' );
|
||
|
|
// returns 8
|
||
|
|
|
||
|
|
nbytes = bytesPerElement( 'generic' );
|
||
|
|
// returns null
|
||
|
|
```
|
||
|
|
|
||
|
|
If provided an unknown or unsupported data type, the function returns `null`.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var nbytes = bytesPerElement( 'foobar' );
|
||
|
|
// returns null
|
||
|
|
```
|
||
|
|
|
||
|
|
</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 bytesPerElement = require( '@stdlib/ndarray/base/bytes-per-element' );
|
||
|
|
|
||
|
|
var dtypes;
|
||
|
|
var nbytes;
|
||
|
|
var i;
|
||
|
|
|
||
|
|
dtypes = [
|
||
|
|
'float64',
|
||
|
|
'float32',
|
||
|
|
'int8',
|
||
|
|
'uint8',
|
||
|
|
'uint8c',
|
||
|
|
'int16',
|
||
|
|
'uint16',
|
||
|
|
'int32',
|
||
|
|
'uint32',
|
||
|
|
'binary',
|
||
|
|
'generic',
|
||
|
|
'foobar'
|
||
|
|
];
|
||
|
|
|
||
|
|
for ( i = 0; i < dtypes.length; i++ ) {
|
||
|
|
nbytes = bytesPerElement( dtypes[ i ] );
|
||
|
|
nbytes = ( nbytes ) ? nbytes+' bytes' : 'null';
|
||
|
|
console.log( '%s => %s', dtypes[ i ], nbytes );
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
</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">
|
||
|
|
|
||
|
|
[@stdlib/ndarray/dtypes]: https://www.npmjs.com/package/@stdlib/ndarray/tree/main/dtypes
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|