# falses
> Create an [ndarray][@stdlib/ndarray/ctor] filled with `false` values and having a specified shape and [data type][@stdlib/ndarray/dtypes].
## Usage
```javascript
var falses = require( '@stdlib/ndarray/falses' );
```
#### falses( shape\[, options] )
Creates an [ndarray][@stdlib/ndarray/ctor] filled with `false` values and having a specified shape and [data type][@stdlib/ndarray/dtypes].
```javascript
var getShape = require( '@stdlib/ndarray/shape' );
var getDType = require( '@stdlib/ndarray/dtype' );
var arr = falses( [ 2, 2 ] );
// returns [ [ false, false ], [ false, false ] ]
var sh = getShape( arr );
// returns [ 2, 2 ]
var dt = String( getDType( arr ) );
// returns 'bool'
```
The specified output [ndarray][@stdlib/ndarray/ctor] shape may be either an array-like object or an integer value.
```javascript
var getShape = require( '@stdlib/ndarray/shape' );
var getDType = require( '@stdlib/ndarray/dtype' );
var arr = falses( 2 );
// returns [ false, false ]
var sh = getShape( arr );
// returns [ 2 ]
var dt = String( getDType( arr ) );
// returns 'bool'
```
The function accepts the following options:
- **dtype**: underlying [data type][@stdlib/ndarray/dtypes]. Must be a boolean or "generic" [data type][@stdlib/ndarray/dtypes]. Default: `'bool'`.
- **order**: specifies whether an [ndarray][@stdlib/ndarray/ctor] is `'row-major'` (C-style) or `'column-major'` (Fortran-style). Default: `'row-major'`.
- **mode**: specifies how to handle indices which exceed array dimensions (see [ndarray][@stdlib/ndarray/ctor]). Default: `'throw'`.
- **submode**: a mode array which specifies for each dimension how to handle subscripts which exceed array dimensions (see [ndarray][@stdlib/ndarray/ctor]). If provided fewer modes than dimensions, the constructor recycles modes using modulo arithmetic. Default: `[ options.mode ]`.
- **readonly**: boolean indicating whether an array should be **read-only**. Default: `false`.
By default, the function returns an [ndarray][@stdlib/ndarray/ctor] having a [`bool`][@stdlib/ndarray/dtypes] data type. To specify an alternative [data type][@stdlib/ndarray/dtypes], provide a `dtype` option.
```javascript
var getShape = require( '@stdlib/ndarray/shape' );
var getDType = require( '@stdlib/ndarray/dtype' );
var arr = falses( [ 2, 2 ], {
'dtype': 'generic'
});
// returns [ [ false, false ], [ false, false ] ]
var sh = getShape( arr );
// returns [ 2, 2 ]
var dt = String( getDType( arr ) );
// returns 'generic'
```
## Examples
```javascript
var ndarray2array = require( '@stdlib/ndarray/to-array' );
var falses = require( '@stdlib/ndarray/falses' );
// Specify a list of data types:
var dt = [
'bool',
'generic'
];
// Generate filled ndarrays...
var arr;
var i;
for ( i = 0; i < dt.length; i++ ) {
arr = falses( [ 2, 2 ], {
'dtype': dt[ i ]
});
console.log( ndarray2array( arr ) );
}
```
[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray/tree/main/ctor
[@stdlib/ndarray/dtypes]: https://github.com/stdlib-js/ndarray/tree/main/dtypes
[@stdlib/ndarray/array]: https://github.com/stdlib-js/ndarray/tree/main/array
[@stdlib/ndarray/falses-like]: https://github.com/stdlib-js/ndarray/tree/main/falses-like
[@stdlib/ndarray/trues]: https://github.com/stdlib-js/ndarray/tree/main/trues