time-to-botec/squiggle/node_modules/@stdlib/assert/is-float64matrix-like/lib/index.js

50 lines
1.3 KiB
JavaScript
Raw Normal View History

/**
* @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';
/**
* Test if a value is a 2-dimensional ndarray-like object whose underlying data type is `float64`.
*
* @module @stdlib/assert/is-float64matrix-like
*
* @example
* 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 bool = isFloat64MatrixLike( arr );
* // returns true
*
* bool = isFloat64MatrixLike( [] );
* // returns false
*/
// MODULES //
var isFloat64MatrixLike = require( './main.js' );
// EXPORTS //
module.exports = isFloat64MatrixLike;