@stdlib/assert-is-float64array

What is @stdlib/assert-is-float64array?

The @stdlib/assert-is-float64array npm package is used to check if a value is a Float64Array. This is useful for validating data types in JavaScript, especially when working with numerical computations and ensuring that the data structures are as expected.

What are @stdlib/assert-is-float64array's main functionalities?

Check if a value is a Float64Array

This feature allows you to check if a given value is a Float64Array. The function returns true if the value is a Float64Array and false otherwise.

const isFloat64Array = require('@stdlib/assert-is-float64array');

const arr = new Float64Array(10);
console.log(isFloat64Array(arr)); // true

const notArr = [1, 2, 3];
console.log(isFloat64Array(notArr)); // false

Other packages similar to @stdlib/assert-is-float64array

is-typedarray

The is-typedarray package provides a function to check if a value is a typed array, including Float64Array. It is more general than @stdlib/assert-is-float64array as it can check for various types of typed arrays, not just Float64Array.

typedarray-to-buffer

The typedarray-to-buffer package is used to convert a typed array to a Buffer. While it does not directly check if a value is a Float64Array, it is often used in conjunction with type-checking packages to handle typed arrays in Node.js.

arraybuffer-to-buffer

The arraybuffer-to-buffer package converts ArrayBuffer instances to Buffer instances. Similar to typedarray-to-buffer, it is used in scenarios where handling and validating typed arrays is necessary.

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!

isFloat64Array

Test if a value is a Float64Array.

Installation

npm install @stdlib/assert-is-float64array

Usage

var isFloat64Array = require( '@stdlib/assert-is-float64array' );

isFloat64Array( value )

Tests if a value is a Float64Array.

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

var bool = isFloat64Array( new Float64Array( 10 ) );
// returns true

bool = isFloat64Array( [] );
// returns false

Examples

var Int8Array = require( '@stdlib/array-int8' );
var Uint8Array = require( '@stdlib/array-uint8' );
var Uint8ClampedArray = require( '@stdlib/array-uint8c' );
var Int16Array = require( '@stdlib/array-int16' );
var Uint16Array = require( '@stdlib/array-uint16' );
var Int32Array = require( '@stdlib/array-int32' );
var Uint32Array = require( '@stdlib/array-uint32' );
var Float32Array = require( '@stdlib/array-float32' );
var Float64Array = require( '@stdlib/array-float64' );
var isFloat64Array = require( '@stdlib/assert-is-float64array' );

var bool = isFloat64Array( new Float64Array( 10 ) );
// returns true

bool = isFloat64Array( new Int8Array( 10 ) );
// returns false

bool = isFloat64Array( new Uint8Array( 10 ) );
// returns false

bool = isFloat64Array( new Uint8ClampedArray( 10 ) );
// returns false

bool = isFloat64Array( new Int16Array( 10 ) );
// returns false

bool = isFloat64Array( new Uint16Array( 10 ) );
// returns false

bool = isFloat64Array( new Int32Array( 10 ) );
// returns false

bool = isFloat64Array( new Uint32Array( 10 ) );
// returns false

bool = isFloat64Array( new Float32Array( 10 ) );
// returns false

bool = isFloat64Array( new Array( 10 ) );
// returns false

bool = isFloat64Array( {} );
// returns false

bool = isFloat64Array( null );
// returns false

---

See Also

• @stdlib/assert-is-float32array: test if a value is a Float32Array.

---

Notice

This package is part of 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, see the main project repository.

Community

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Changelog

0.2.0 (2024-02-14)

<section class="commits">

Commits

<details>

• dea49e0 - docs: use single quotes in require calls instead of backticks (by Philipp Burckhardt)

</details> </section> <!-- /.commits --> <section class="contributors">

Contributors

A total of 1 person contributed to this release. Thank you to this contributor:

• Philipp Burckhardt

</section> <!-- /.contributors --> </section> <!-- /.release --> <section class="release" id="v0.1.1">