README.md (1789B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 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 # isVectorLike 22 23 > Test if a value is a 1-dimensional [ndarray][@stdlib/ndarray/ctor]-like object. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isVectorLike = require( '@stdlib/assert/is-vector-like' ); 31 ``` 32 33 #### isVectorLike( value ) 34 35 Tests if a value is a 1-dimensional [ndarray][@stdlib/ndarray/ctor]-like object. 36 37 ```javascript 38 var ndarray = require( '@stdlib/ndarray/ctor' ); 39 40 var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 4 ], [ 1 ], 0, 'row-major' ); 41 var bool = isVectorLike( arr ); 42 // returns true 43 ``` 44 45 </section> 46 47 <!-- /.usage --> 48 49 <section class="examples"> 50 51 ## Examples 52 53 <!-- eslint no-undef: "error" --> 54 55 ```javascript 56 var ndarray = require( '@stdlib/ndarray/ctor' ); 57 var isVectorLike = require( '@stdlib/assert/is-vector-like' ); 58 59 var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 4 ], [ 1 ], 0, 'row-major' ); 60 var out = isVectorLike( arr ); 61 // returns true 62 63 out = isVectorLike( [ 1, 2, 3, 4 ] ); 64 // returns false 65 66 out = isVectorLike( {} ); 67 // returns false 68 69 out = isVectorLike( null ); 70 // returns false 71 ``` 72 73 </section> 74 75 <!-- /.examples --> 76 77 <section class="links"> 78 79 [@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor 80 81 </section> 82 83 <!-- /.links -->