index.js (1160B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Test if a value is a 1-dimensional ndarray-like object. 23 * 24 * @module @stdlib/assert/is-vector-like 25 * 26 * @example 27 * var ndarray = require( '@stdlib/ndarray/ctor' ); 28 * var isVectorLike = require( '@stdlib/assert/is-vector-like' ); 29 * 30 * var arr = ndarray( 'generic', [ 0, 0, 0, 0 ], [ 4 ], [ 1 ], 0, 'row-major' ); 31 * var bool = isVectorLike( arr ); 32 * // returns true 33 * 34 * bool = isVectorLike( [] ); 35 * // returns false 36 */ 37 38 // MODULES // 39 40 var isVectorLike = require( './main.js' ); 41 42 43 // EXPORTS // 44 45 module.exports = isVectorLike;