zeros.js 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123
  1. import { isBigNumber } from '../../utils/is.js';
  2. import { isInteger } from '../../utils/number.js';
  3. import { resize } from '../../utils/array.js';
  4. import { factory } from '../../utils/factory.js';
  5. var name = 'zeros';
  6. var dependencies = ['typed', 'config', 'matrix', 'BigNumber'];
  7. export var createZeros = /* #__PURE__ */factory(name, dependencies, _ref => {
  8. var {
  9. typed,
  10. config,
  11. matrix,
  12. BigNumber
  13. } = _ref;
  14. /**
  15. * Create a matrix filled with zeros. The created matrix can have one or
  16. * multiple dimensions.
  17. *
  18. * Syntax:
  19. *
  20. * math.zeros(m)
  21. * math.zeros(m, format)
  22. * math.zeros(m, n)
  23. * math.zeros(m, n, format)
  24. * math.zeros([m, n])
  25. * math.zeros([m, n], format)
  26. *
  27. * Examples:
  28. *
  29. * math.zeros() // returns []
  30. * math.zeros(3) // returns [0, 0, 0]
  31. * math.zeros(3, 2) // returns [[0, 0], [0, 0], [0, 0]]
  32. * math.zeros(3, 'dense') // returns [0, 0, 0]
  33. *
  34. * const A = [[1, 2, 3], [4, 5, 6]]
  35. * math.zeros(math.size(A)) // returns [[0, 0, 0], [0, 0, 0]]
  36. *
  37. * See also:
  38. *
  39. * ones, identity, size, range
  40. *
  41. * @param {...(number|BigNumber) | Array} size The size of each dimension of the matrix
  42. * @param {string} [format] The Matrix storage format
  43. *
  44. * @return {Array | Matrix} A matrix filled with zeros
  45. */
  46. return typed(name, {
  47. '': function _() {
  48. return config.matrix === 'Array' ? _zeros([]) : _zeros([], 'default');
  49. },
  50. // math.zeros(m, n, p, ..., format)
  51. // TODO: more accurate signature '...number | BigNumber, string' as soon as typed-function supports this
  52. '...number | BigNumber | string': function numberBigNumberString(size) {
  53. var last = size[size.length - 1];
  54. if (typeof last === 'string') {
  55. var format = size.pop();
  56. return _zeros(size, format);
  57. } else if (config.matrix === 'Array') {
  58. return _zeros(size);
  59. } else {
  60. return _zeros(size, 'default');
  61. }
  62. },
  63. Array: _zeros,
  64. Matrix: function Matrix(size) {
  65. var format = size.storage();
  66. return _zeros(size.valueOf(), format);
  67. },
  68. 'Array | Matrix, string': function ArrayMatrixString(size, format) {
  69. return _zeros(size.valueOf(), format);
  70. }
  71. });
  72. /**
  73. * Create an Array or Matrix with zeros
  74. * @param {Array} size
  75. * @param {string} [format='default']
  76. * @return {Array | Matrix}
  77. * @private
  78. */
  79. function _zeros(size, format) {
  80. var hasBigNumbers = _normalize(size);
  81. var defaultValue = hasBigNumbers ? new BigNumber(0) : 0;
  82. _validate(size);
  83. if (format) {
  84. // return a matrix
  85. var m = matrix(format);
  86. if (size.length > 0) {
  87. return m.resize(size, defaultValue);
  88. }
  89. return m;
  90. } else {
  91. // return an Array
  92. var arr = [];
  93. if (size.length > 0) {
  94. return resize(arr, size, defaultValue);
  95. }
  96. return arr;
  97. }
  98. }
  99. // replace BigNumbers with numbers, returns true if size contained BigNumbers
  100. function _normalize(size) {
  101. var hasBigNumbers = false;
  102. size.forEach(function (value, index, arr) {
  103. if (isBigNumber(value)) {
  104. hasBigNumbers = true;
  105. arr[index] = value.toNumber();
  106. }
  107. });
  108. return hasBigNumbers;
  109. }
  110. // validate arguments
  111. function _validate(size) {
  112. size.forEach(function (value) {
  113. if (typeof value !== 'number' || !isInteger(value) || value < 0) {
  114. throw new Error('Parameters in function zeros must be positive integers');
  115. }
  116. });
  117. }
  118. });
  119. // TODO: zeros contains almost the same code as ones. Reuse this?