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 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 | 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 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 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 111x 96x 96x 9x 9x 96x 48x 48x 16x 16x 96x 39x 39x 96x 42x 96x 29x 29x 96x 10x 10x 96x 9x 9x 111x 15x 15x 15x 111x 4x 111x 60x 82x 22x 22x 64x 111x 62x 62x 111x 2x 2x 2x 2x 64x 111x 2x 111x 62x 62x 64x 111x 1x 1x 1x 1x 1x | /**
* @license Apache-2.0
*
* Copyright (c) 2023 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 isDataType = require( '@stdlib/ndarray/base/assert/is-data-type' );
var isNonNegativeInteger = require( '@stdlib/assert/is-nonnegative-integer' ).isPrimitive;
var isPlainObject = require( '@stdlib/assert/is-plain-object' );
var hasOwnProp = require( '@stdlib/assert/has-own-property' );
var isNonNegativeIntegerArray = require( '@stdlib/assert/is-nonnegative-integer-array' ).primitives;
var isEmptyCollection = require( '@stdlib/assert/is-empty-collection' );
var shape2strides = require( '@stdlib/ndarray/base/shape2strides' );
var emptyArray = require( '@stdlib/array/empty' );
var allocUnsafe = require( '@stdlib/buffer/alloc-unsafe' );
var resolveStr = require( '@stdlib/ndarray/base/dtype-resolve-str' );
var numel = require( '@stdlib/ndarray/base/numel' );
var ndarray = require( '@stdlib/ndarray/ctor' );
var defaults = require( '@stdlib/ndarray/defaults' );
var dtypes = require( '@stdlib/ndarray/dtypes' );
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
// VARIABLES //
var DEFAULT_DTYPE = defaults.get( 'dtypes.default' );
var DEFAULT_ORDER = defaults.get( 'order' );
// MAIN //
/**
* Creates an uninitialized ndarray having a specified shape and data type.
*
* @param {(NonNegativeIntegerArray|NonNegativeInteger)} shape - array shape
* @param {Options} [options] - options
* @param {*} [options.dtype='float64'] - data type
* @param {string} [options.order='row-major'] - array order
* @param {string} [options.mode="throw"] - specifies how to handle indices which exceed array dimensions
* @param {StringArray} [options.submode=["throw"]] - specifies how to handle subscripts which exceed array dimensions on a per dimension basis
* @throws {TypeError} first argument must be either a nonnegative integer or an array of nonnegative integers
* @throws {TypeError} options argument must be an object
* @throws {TypeError} `dtype` option must be a recognized data type
* @throws {TypeError} `order` option must be a recognized array order
* @throws {TypeError} must provide valid options
* @returns {ndarray} ndarray
*
* @example
* var getShape = require( '@stdlib/ndarray/shape' );
* var getDType = require( '@stdlib/ndarray/dtype' );
*
* var arr = empty( [ 2, 2 ], {
* 'dtype': 'float32'
* });
* // returns <ndarray>
*
* var sh = getShape( arr );
* // returns [ 2, 2 ]
*
* var dt = String( getDType( arr ) );
* // returns 'float32'
*/
function empty( shape ) {
var options;
var dtype;
var order;
var ndims;
var opts;
var buf;
var len;
var dt;
var st;
var sh;
opts = {};
if ( arguments.length > 1 ) {
options = arguments[ 1 ];
if ( !isPlainObject( options ) ) {
throw new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
}
if ( hasOwnProp( options, 'dtype' ) ) {
dtype = options.dtype;
if ( !isDataType( dtype ) ) {
throw new TypeError( format( 'invalid option. `%s` option must be one of the following: "%s". Option: `%s`.', 'dtype', join( dtypes(), '", "' ), dtype ) );
}
} else {
dtype = DEFAULT_DTYPE;
}
if ( hasOwnProp( options, 'order' ) ) {
order = options.order;
} else {
order = DEFAULT_ORDER;
}
if ( hasOwnProp( options, 'mode' ) ) {
opts.mode = options.mode;
}
if ( hasOwnProp( options, 'submode' ) ) {
opts.submode = options.submode;
}
} else {
dtype = DEFAULT_DTYPE;
order = DEFAULT_ORDER;
}
if ( isNonNegativeInteger( shape ) ) {
sh = [ shape ];
} else if ( isNonNegativeIntegerArray( shape ) || isEmptyCollection( shape ) ) { // eslint-disable-line max-len
sh = shape;
} else {
throw new TypeError( format( 'invalid argument. First argument must be either a nonnegative integer or an array of nonnegative integers. Value: `%s`.', shape ) );
}
ndims = sh.length;
if ( ndims > 0 ) {
len = numel( sh );
st = shape2strides( sh, order );
} else {
// For 0-dimensional arrays, the buffer should contain a single element...
len = 1;
st = [ 0 ];
}
dt = resolveStr( dtype );
if ( dt === 'binary' ) {
buf = allocUnsafe( len );
} else {
buf = emptyArray( len, dt );
}
return new ndarray( dtype, buf, sh, st, 0, order, opts );
}
// EXPORTS //
module.exports = empty;
|