Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/ndarray-base-buffer-dtype

Return the data type of an ndarray data buffer.
https://github.com/stdlib-js/ndarray-base-buffer-dtype

array base buf buffer data dtype dtypes javascript multidimensional ndarray node node-js nodejs stdlib types util utilities utility utils

Last synced: 17 days ago
JSON representation

Return the data type of an ndarray data buffer.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# Buffer Data Type



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Return the data type of an ndarray data buffer.



## Installation



```bash

npm install @stdlib/ndarray-base-buffer-dtype

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );

```



#### dtype( buffer )



Returns the [data type][@stdlib/ndarray/dtypes] of an ndarray data [`buffer`][@stdlib/ndarray/base/buffer-ctors].



```javascript

var Float64Array = require( '@stdlib/array-float64' );

var buf = new Float64Array( 10 );



var dt = dtype( buf );

// returns 'float64'

```



If provided an ndarray data [`buffer`][@stdlib/ndarray/base/buffer-ctors] having an unknown or unsupported [data type][@stdlib/ndarray/dtypes], the function returns `null`.



```javascript

var dt = dtype( 'beep' );

// returns null

```



## Examples



```javascript

var dtypes = require( '@stdlib/ndarray-dtypes' );

var bufferCtors = require( '@stdlib/ndarray-base-buffer-ctors' );

var isFunction = require( '@stdlib/assert-is-function' );

var dtype = require( '@stdlib/ndarray-base-buffer-dtype' );



// Get a list of supported ndarray buffer data types:

var DTYPES = dtypes();



// Buffer length:

var len = 10;



// For each supported data type, create a buffer and confirm its data type...

var ctor;

var buf;

var dt;

var i;

for ( i = 0; i < DTYPES.length; i++ ) {

    ctor = bufferCtors( DTYPES[ i ] );

    if ( DTYPES[ i ] === 'binary' && isFunction( ctor.alloc ) ) {

        buf = ctor.alloc( len );

    } else {

        buf = new ctor( len );

    }

    dt = dtype( buf );

    console.log( '%s == %s => %s', DTYPES[ i ], dt, DTYPES[ i ] === dt );

}



// Try an array-like object...

buf = {

    'length': 10

};

dt = dtype( buf );

console.log( '%s == %s => %s', 'generic', dt, dt === 'generic' );

```



* * *



## Notice



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.



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].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/ndarray-base-buffer-dtype.svg

[npm-url]: https://npmjs.org/package/@stdlib/ndarray-base-buffer-dtype



[test-image]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/ndarray-base-buffer-dtype/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/ndarray-base-buffer-dtype?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/tree/deno

[deno-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/tree/umd

[umd-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/tree/esm

[esm-readme]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/ndarray-base-buffer-dtype/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/ndarray-base-buffer-dtype/main/LICENSE



[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray-dtypes



[@stdlib/ndarray/base/buffer-ctors]: https://github.com/stdlib-js/ndarray-base-buffer-ctors