README.md (2130B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2020 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # isFloat64VectorLike 22 23 > Test if a value is a 1-dimensional [ndarray][@stdlib/ndarray/ctor]-like object containing double-precision floating-point numbers. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isFloat64VectorLike = require( '@stdlib/assert/is-float64vector-like' ); 31 ``` 32 33 #### isFloat64VectorLike( value ) 34 35 Tests if a value is a 1-dimensional [ndarray][@stdlib/ndarray/ctor]-like object whose underlying data type is `float64`. 36 37 ```javascript 38 var Float64Array = require( '@stdlib/array/float64' ); 39 var ndarray = require( '@stdlib/ndarray/ctor' ); 40 41 var arr = ndarray( 'float64', new Float64Array( [ 0, 0, 0, 0 ] ), [ 4 ], [ 1 ], 0, 'row-major' ); 42 43 var bool = isFloat64VectorLike( arr ); 44 // returns true 45 ``` 46 47 </section> 48 49 <!-- /.usage --> 50 51 <section class="examples"> 52 53 ## Examples 54 55 <!-- eslint no-undef: "error" --> 56 57 ```javascript 58 var ndarray = require( '@stdlib/ndarray/ctor' ); 59 var Float64Array = require( '@stdlib/array/float64' ); 60 var isFloat64VectorLike = require( '@stdlib/assert/is-float64vector-like' ); 61 62 var buffer = new Float64Array( [ 0, 0, 0, 0 ] ); 63 var arr = ndarray( 'float64', buffer, [ 4 ], [ 1 ], 0, 'row-major' ); 64 65 var out = isFloat64VectorLike( arr ); 66 // returns true 67 68 out = isFloat64VectorLike( [ 1, 2, 3, 4 ] ); 69 // returns false 70 71 out = isFloat64VectorLike( {} ); 72 // returns false 73 74 out = isFloat64VectorLike( null ); 75 // returns false 76 ``` 77 78 </section> 79 80 <!-- /.examples --> 81 82 <section class="links"> 83 84 [@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor 85 86 </section> 87 88 <!-- /.links -->