All files / assert/is-buffer-length-compatible-shape/lib main.js

94.44% Statements 51/54
100% Branches 1/1
0% Functions 0/1
94.44% Lines 51/54

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 551x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x       1x 1x 1x 1x 1x  
/**
* @license Apache-2.0
*
* Copyright (c) 2018 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 numel = require( '@stdlib/ndarray/base/numel' );
 
 
// MAIN //
 
/**
* Returns a boolean indicating if a buffer length is compatible with a provided shape array.
*
* @param {NonNegativeInteger} len - buffer length
* @param {NonNegativeIntegerArray} shape - array shape
* @returns {boolean} boolean indicating if a buffer length is compatible with a provided shape array
*
* @example
* var shape = [ 2, 2 ];
*
* var bool = isBufferLengthCompatibleShape( 4, shape );
* // returns true
*
* @example
* var shape = [ 2, 2 ];
*
* var bool = isBufferLengthCompatibleShape( 3, shape );
* // returns false
*/
function isBufferLengthCompatibleShape( len, shape ) { // eslint-disable-line id-length
	return ( len >= numel( shape ) );
}
 
 
// EXPORTS //
 
module.exports = isBufferLengthCompatibleShape;