All files / falses/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) 2026 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 empty = require( '@stdlib/ndarray/base/empty' );
var fill = require( '@stdlib/ndarray/base/fill' );
 
 
// MAIN //
 
/**
* Creates an ndarray filled with `false` values and having a specified shape and data type.
*
* @param {*} dtype - data type
* @param {NonNegativeIntegerArray} shape - array shape
* @param {string} order - array order
* @throws {TypeError} first argument must be a recognized data type
* @returns {ndarray} ndarray
*
* @example
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = falses( 'bool', [ 2, 2 ], 'row-major' );
* // returns <ndarray>[ [ false, false ], [ false, false ] ]
*
* var dt = String( getDType( arr ) );
* // returns 'bool'
*/
function falses( dtype, shape, order ) {
	return fill( empty( dtype, shape, order ), false );
}
 
 
// EXPORTS //
 
module.exports = falses;