89 lines
2.1 KiB
Markdown
89 lines
2.1 KiB
Markdown
|
<!--
|
||
|
|
|
||
|
|
@license Apache-2.0
|
||
|
|
|
||
|
|
Copyright (c) 2020 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.
|
||
|
|
|
||
|
|
-->
|
||
|
|
|
||
|
|
# isFloat64MatrixLike
|
||
|
|
|
||
|
|
> Test if a value is a 2-dimensional [ndarray][@stdlib/ndarray/ctor]-like object containing double-precision floating-point numbers.
|
||
|
|
|
||
|
|
<section class="usage">
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var isFloat64MatrixLike = require( '@stdlib/assert/is-float64matrix-like' );
|
||
|
|
```
|
||
|
|
|
||
|
|
#### isFloat64MatrixLike( value )
|
||
|
|
|
||
|
|
Tests if a value is a 2-dimensional [ndarray][@stdlib/ndarray/ctor]-like object whose underlying data type is `float64`.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
||
|
|
var ndarray = require( '@stdlib/ndarray/ctor' );
|
||
|
|
|
||
|
|
var arr = ndarray( 'float64', new Float64Array( [ 0, 0, 0, 0 ] ), [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
|
||
|
|
|
||
|
|
var bool = isFloat64MatrixLike( arr );
|
||
|
|
// returns true
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.usage -->
|
||
|
|
|
||
|
|
<section class="examples">
|
||
|
|
|
||
|
|
## Examples
|
||
|
|
|
||
|
|
<!-- eslint no-undef: "error" -->
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
var ndarray = require( '@stdlib/ndarray/ctor' );
|
||
|
|
var Float64Array = require( '@stdlib/array/float64' );
|
||
|
|
var isFloat64MatrixLike = require( '@stdlib/assert/is-float64matrix-like' );
|
||
|
|
|
||
|
|
var buffer = new Float64Array( [ 0, 0, 0, 0 ] );
|
||
|
|
var arr = ndarray( 'float64', buffer, [ 2, 2 ], [ 2, 1 ], 0, 'row-major' );
|
||
|
|
|
||
|
|
var out = isFloat64MatrixLike( arr );
|
||
|
|
// returns true
|
||
|
|
|
||
|
|
out = isFloat64MatrixLike( [ 1, 2, 3, 4 ] );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
out = isFloat64MatrixLike( {} );
|
||
|
|
// returns false
|
||
|
|
|
||
|
|
out = isFloat64MatrixLike( null );
|
||
|
|
// returns false
|
||
|
|
```
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.examples -->
|
||
|
|
|
||
|
|
<section class="links">
|
||
|
|
|
||
|
|
[@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor
|
||
|
|
|
||
|
|
</section>
|
||
|
|
|
||
|
|
<!-- /.links -->
|