129 lines
3.5 KiB
JavaScript
129 lines
3.5 KiB
JavaScript
import { isBigNumber } from '../../utils/is.js';
|
|
import { isInteger } from '../../utils/number.js';
|
|
import { resize } from '../../utils/array.js';
|
|
import { factory } from '../../utils/factory.js';
|
|
var name = 'zeros';
|
|
var dependencies = ['typed', 'config', 'matrix', 'BigNumber'];
|
|
export var createZeros = /* #__PURE__ */factory(name, dependencies, _ref => {
|
|
var {
|
|
typed,
|
|
config,
|
|
matrix,
|
|
BigNumber
|
|
} = _ref;
|
|
|
|
/**
|
|
* Create a matrix filled with zeros. The created matrix can have one or
|
|
* multiple dimensions.
|
|
*
|
|
* Syntax:
|
|
*
|
|
* math.zeros(m)
|
|
* math.zeros(m, format)
|
|
* math.zeros(m, n)
|
|
* math.zeros(m, n, format)
|
|
* math.zeros([m, n])
|
|
* math.zeros([m, n], format)
|
|
*
|
|
* Examples:
|
|
*
|
|
* math.zeros(3) // returns [0, 0, 0]
|
|
* math.zeros(3, 2) // returns [[0, 0], [0, 0], [0, 0]]
|
|
* math.zeros(3, 'dense') // returns [0, 0, 0]
|
|
*
|
|
* const A = [[1, 2, 3], [4, 5, 6]]
|
|
* math.zeros(math.size(A)) // returns [[0, 0, 0], [0, 0, 0]]
|
|
*
|
|
* See also:
|
|
*
|
|
* ones, identity, size, range
|
|
*
|
|
* @param {...number | Array} size The size of each dimension of the matrix
|
|
* @param {string} [format] The Matrix storage format
|
|
*
|
|
* @return {Array | Matrix} A matrix filled with zeros
|
|
*/
|
|
return typed(name, {
|
|
'': function _() {
|
|
return config.matrix === 'Array' ? _zeros([]) : _zeros([], 'default');
|
|
},
|
|
// math.zeros(m, n, p, ..., format)
|
|
// TODO: more accurate signature '...number | BigNumber, string' as soon as typed-function supports this
|
|
'...number | BigNumber | string': function numberBigNumberString(size) {
|
|
var last = size[size.length - 1];
|
|
|
|
if (typeof last === 'string') {
|
|
var format = size.pop();
|
|
return _zeros(size, format);
|
|
} else if (config.matrix === 'Array') {
|
|
return _zeros(size);
|
|
} else {
|
|
return _zeros(size, 'default');
|
|
}
|
|
},
|
|
Array: _zeros,
|
|
Matrix: function Matrix(size) {
|
|
var format = size.storage();
|
|
return _zeros(size.valueOf(), format);
|
|
},
|
|
'Array | Matrix, string': function ArrayMatrixString(size, format) {
|
|
return _zeros(size.valueOf(), format);
|
|
}
|
|
});
|
|
/**
|
|
* Create an Array or Matrix with zeros
|
|
* @param {Array} size
|
|
* @param {string} [format='default']
|
|
* @return {Array | Matrix}
|
|
* @private
|
|
*/
|
|
|
|
function _zeros(size, format) {
|
|
var hasBigNumbers = _normalize(size);
|
|
|
|
var defaultValue = hasBigNumbers ? new BigNumber(0) : 0;
|
|
|
|
_validate(size);
|
|
|
|
if (format) {
|
|
// return a matrix
|
|
var m = matrix(format);
|
|
|
|
if (size.length > 0) {
|
|
return m.resize(size, defaultValue);
|
|
}
|
|
|
|
return m;
|
|
} else {
|
|
// return an Array
|
|
var arr = [];
|
|
|
|
if (size.length > 0) {
|
|
return resize(arr, size, defaultValue);
|
|
}
|
|
|
|
return arr;
|
|
}
|
|
} // replace BigNumbers with numbers, returns true if size contained BigNumbers
|
|
|
|
|
|
function _normalize(size) {
|
|
var hasBigNumbers = false;
|
|
size.forEach(function (value, index, arr) {
|
|
if (isBigNumber(value)) {
|
|
hasBigNumbers = true;
|
|
arr[index] = value.toNumber();
|
|
}
|
|
});
|
|
return hasBigNumbers;
|
|
} // validate arguments
|
|
|
|
|
|
function _validate(size) {
|
|
size.forEach(function (value) {
|
|
if (typeof value !== 'number' || !isInteger(value) || value < 0) {
|
|
throw new Error('Parameters in function zeros must be positive integers');
|
|
}
|
|
});
|
|
}
|
|
}); // TODO: zeros contains almost the same code as ones. Reuse this?
|