range.js 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  1. import { factory } from '../../utils/factory.js';
  2. import { noBignumber, noMatrix } from '../../utils/noop.js';
  3. var name = 'range';
  4. var dependencies = ['typed', 'config', '?matrix', '?bignumber', 'smaller', 'smallerEq', 'larger', 'largerEq'];
  5. export var createRange = /* #__PURE__ */factory(name, dependencies, _ref => {
  6. var {
  7. typed,
  8. config,
  9. matrix,
  10. bignumber,
  11. smaller,
  12. smallerEq,
  13. larger,
  14. largerEq
  15. } = _ref;
  16. /**
  17. * Create an array from a range.
  18. * By default, the range end is excluded. This can be customized by providing
  19. * an extra parameter `includeEnd`.
  20. *
  21. * Syntax:
  22. *
  23. * math.range(str [, includeEnd]) // Create a range from a string,
  24. * // where the string contains the
  25. * // start, optional step, and end,
  26. * // separated by a colon.
  27. * math.range(start, end [, includeEnd]) // Create a range with start and
  28. * // end and a step size of 1.
  29. * math.range(start, end, step [, includeEnd]) // Create a range with start, step,
  30. * // and end.
  31. *
  32. * Where:
  33. *
  34. * - `str: string`
  35. * A string 'start:end' or 'start:step:end'
  36. * - `start: {number | BigNumber}`
  37. * Start of the range
  38. * - `end: number | BigNumber`
  39. * End of the range, excluded by default, included when parameter includeEnd=true
  40. * - `step: number | BigNumber`
  41. * Step size. Default value is 1.
  42. * - `includeEnd: boolean`
  43. * Option to specify whether to include the end or not. False by default.
  44. *
  45. * Examples:
  46. *
  47. * math.range(2, 6) // [2, 3, 4, 5]
  48. * math.range(2, -3, -1) // [2, 1, 0, -1, -2]
  49. * math.range('2:1:6') // [2, 3, 4, 5]
  50. * math.range(2, 6, true) // [2, 3, 4, 5, 6]
  51. *
  52. * See also:
  53. *
  54. * ones, zeros, size, subset
  55. *
  56. * @param {*} args Parameters describing the ranges `start`, `end`, and optional `step`.
  57. * @return {Array | Matrix} range
  58. */
  59. return typed(name, {
  60. // TODO: simplify signatures when typed-function supports default values and optional arguments
  61. // TODO: a number or boolean should not be converted to string here
  62. string: _strRange,
  63. 'string, boolean': _strRange,
  64. 'number, number': function numberNumber(start, end) {
  65. return _out(_rangeEx(start, end, 1));
  66. },
  67. 'number, number, number': function numberNumberNumber(start, end, step) {
  68. return _out(_rangeEx(start, end, step));
  69. },
  70. 'number, number, boolean': function numberNumberBoolean(start, end, includeEnd) {
  71. return includeEnd ? _out(_rangeInc(start, end, 1)) : _out(_rangeEx(start, end, 1));
  72. },
  73. 'number, number, number, boolean': function numberNumberNumberBoolean(start, end, step, includeEnd) {
  74. return includeEnd ? _out(_rangeInc(start, end, step)) : _out(_rangeEx(start, end, step));
  75. },
  76. 'BigNumber, BigNumber': function BigNumberBigNumber(start, end) {
  77. var BigNumber = start.constructor;
  78. return _out(_bigRangeEx(start, end, new BigNumber(1)));
  79. },
  80. 'BigNumber, BigNumber, BigNumber': function BigNumberBigNumberBigNumber(start, end, step) {
  81. return _out(_bigRangeEx(start, end, step));
  82. },
  83. 'BigNumber, BigNumber, boolean': function BigNumberBigNumberBoolean(start, end, includeEnd) {
  84. var BigNumber = start.constructor;
  85. return includeEnd ? _out(_bigRangeInc(start, end, new BigNumber(1))) : _out(_bigRangeEx(start, end, new BigNumber(1)));
  86. },
  87. 'BigNumber, BigNumber, BigNumber, boolean': function BigNumberBigNumberBigNumberBoolean(start, end, step, includeEnd) {
  88. return includeEnd ? _out(_bigRangeInc(start, end, step)) : _out(_bigRangeEx(start, end, step));
  89. }
  90. });
  91. function _out(arr) {
  92. if (config.matrix === 'Matrix') {
  93. return matrix ? matrix(arr) : noMatrix();
  94. }
  95. return arr;
  96. }
  97. function _strRange(str, includeEnd) {
  98. var r = _parse(str);
  99. if (!r) {
  100. throw new SyntaxError('String "' + str + '" is no valid range');
  101. }
  102. var fn;
  103. if (config.number === 'BigNumber') {
  104. if (bignumber === undefined) {
  105. noBignumber();
  106. }
  107. fn = includeEnd ? _bigRangeInc : _bigRangeEx;
  108. return _out(fn(bignumber(r.start), bignumber(r.end), bignumber(r.step)));
  109. } else {
  110. fn = includeEnd ? _rangeInc : _rangeEx;
  111. return _out(fn(r.start, r.end, r.step));
  112. }
  113. }
  114. /**
  115. * Create a range with numbers. End is excluded
  116. * @param {number} start
  117. * @param {number} end
  118. * @param {number} step
  119. * @returns {Array} range
  120. * @private
  121. */
  122. function _rangeEx(start, end, step) {
  123. var array = [];
  124. var x = start;
  125. if (step > 0) {
  126. while (smaller(x, end)) {
  127. array.push(x);
  128. x += step;
  129. }
  130. } else if (step < 0) {
  131. while (larger(x, end)) {
  132. array.push(x);
  133. x += step;
  134. }
  135. }
  136. return array;
  137. }
  138. /**
  139. * Create a range with numbers. End is included
  140. * @param {number} start
  141. * @param {number} end
  142. * @param {number} step
  143. * @returns {Array} range
  144. * @private
  145. */
  146. function _rangeInc(start, end, step) {
  147. var array = [];
  148. var x = start;
  149. if (step > 0) {
  150. while (smallerEq(x, end)) {
  151. array.push(x);
  152. x += step;
  153. }
  154. } else if (step < 0) {
  155. while (largerEq(x, end)) {
  156. array.push(x);
  157. x += step;
  158. }
  159. }
  160. return array;
  161. }
  162. /**
  163. * Create a range with big numbers. End is excluded
  164. * @param {BigNumber} start
  165. * @param {BigNumber} end
  166. * @param {BigNumber} step
  167. * @returns {Array} range
  168. * @private
  169. */
  170. function _bigRangeEx(start, end, step) {
  171. var zero = bignumber(0);
  172. var array = [];
  173. var x = start;
  174. if (step.gt(zero)) {
  175. while (smaller(x, end)) {
  176. array.push(x);
  177. x = x.plus(step);
  178. }
  179. } else if (step.lt(zero)) {
  180. while (larger(x, end)) {
  181. array.push(x);
  182. x = x.plus(step);
  183. }
  184. }
  185. return array;
  186. }
  187. /**
  188. * Create a range with big numbers. End is included
  189. * @param {BigNumber} start
  190. * @param {BigNumber} end
  191. * @param {BigNumber} step
  192. * @returns {Array} range
  193. * @private
  194. */
  195. function _bigRangeInc(start, end, step) {
  196. var zero = bignumber(0);
  197. var array = [];
  198. var x = start;
  199. if (step.gt(zero)) {
  200. while (smallerEq(x, end)) {
  201. array.push(x);
  202. x = x.plus(step);
  203. }
  204. } else if (step.lt(zero)) {
  205. while (largerEq(x, end)) {
  206. array.push(x);
  207. x = x.plus(step);
  208. }
  209. }
  210. return array;
  211. }
  212. /**
  213. * Parse a string into a range,
  214. * The string contains the start, optional step, and end, separated by a colon.
  215. * If the string does not contain a valid range, null is returned.
  216. * For example str='0:2:11'.
  217. * @param {string} str
  218. * @return {{start: number, end: number, step: number} | null} range Object containing properties start, end, step
  219. * @private
  220. */
  221. function _parse(str) {
  222. var args = str.split(':');
  223. // number
  224. var nums = args.map(function (arg) {
  225. // use Number and not parseFloat as Number returns NaN on invalid garbage in the string
  226. return Number(arg);
  227. });
  228. var invalid = nums.some(function (num) {
  229. return isNaN(num);
  230. });
  231. if (invalid) {
  232. return null;
  233. }
  234. switch (nums.length) {
  235. case 2:
  236. return {
  237. start: nums[0],
  238. end: nums[1],
  239. step: 1
  240. };
  241. case 3:
  242. return {
  243. start: nums[0],
  244. end: nums[2],
  245. step: nums[1]
  246. };
  247. default:
  248. return null;
  249. }
  250. }
  251. });