time-to-botec/js/node_modules/@stdlib/assert/is-float64vector-like/lib/main.js
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

56 lines
1.5 KiB
JavaScript

/**
* @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.
*/
'use strict';
// MODULES //
var isVectorLike = require( './../../is-vector-like' );
var isFloat64Array = require( './../../is-float64array' );
// MAIN //
/**
* Tests if a value is a 1-dimensional ndarray-like object whose underlying data type is `float64`.
*
* @param {*} v - value to test
* @returns {boolean} boolean indicating if a value is a 1-dimensional ndarray-like object whose underlying data type is `float64`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
* var ndarray = require( '@stdlib/ndarray/ctor' );
*
* var buffer = new Float64Array( [ 0, 0, 0, 0 ] );
* var arr = ndarray( 'float64', buffer, [ 4 ], [ 1 ], 0, 'row-major' );
*
* var bool = isFloat64VectorLike( arr );
* // returns true
*
* bool = isFloat64VectorLike( [] );
* // returns false
*/
function isFloat64VectorLike( v ) {
return ( isVectorLike( v ) && isFloat64Array( v.data ) );
}
// EXPORTS //
module.exports = isFloat64VectorLike;