@sheetxl/formulas 0.7.26 → 0.7.28-beta.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (165) hide show
  1. package/README.md +136 -12
  2. package/browser/cjs/1XrWGMP3GmsQOMIX.cjs +1 -0
  3. package/browser/cjs/49_x589Na12sizKK.cjs +1 -0
  4. package/browser/cjs/4nReftSsKWmnRdtf.cjs +1 -0
  5. package/browser/cjs/507hQYooKKjnRzsZ.cjs +1 -0
  6. package/browser/cjs/BAxVLKkxFgI6cXnR.cjs +1 -0
  7. package/browser/cjs/BK0SCfN_VZYqBxoQ.cjs +1 -0
  8. package/browser/cjs/Btc0Nzu40VYOpzLX.cjs +1 -0
  9. package/browser/cjs/C9C-pr-T_ThweQX9.cjs +1 -0
  10. package/browser/cjs/CJYewYJ5Z3iojl7J.cjs +1 -0
  11. package/browser/cjs/CRx1WvmgBjT8WVyB.cjs +1 -0
  12. package/browser/cjs/CV4KQsHluMqo1I2Q.cjs +1 -0
  13. package/browser/cjs/CXlzsh_WHCOsErJ1.cjs +1 -0
  14. package/browser/cjs/CpJJh4UnFl1_qFui.cjs +1 -0
  15. package/browser/cjs/CrZlUtdX1h2RUnCP.cjs +1 -0
  16. package/browser/cjs/D8-KovdJ0LjxqCe2.cjs +1 -0
  17. package/browser/cjs/DCIlWcGDrp-5PDoA.cjs +1 -0
  18. package/browser/cjs/DDnGLOLTqLFsdUDS.cjs +1 -0
  19. package/browser/cjs/DG2kqsWRUtVugjay.cjs +1 -0
  20. package/browser/cjs/DM7-R_ltoLbA9jde.cjs +1 -0
  21. package/browser/cjs/DNKyaSruDogoBd2H.cjs +1 -0
  22. package/browser/cjs/Du4jBiFxRIF1OjD4.cjs +1 -0
  23. package/browser/cjs/EeOVMRq7TuptFKTc.cjs +1 -0
  24. package/browser/cjs/Kvn916ebqGc4t6hv.cjs +1 -0
  25. package/browser/cjs/aONv0Ys3C8xmnaR8.cjs +1 -0
  26. package/browser/cjs/index.cjs +1 -6
  27. package/browser/cjs/z_rZE1OHFPpdGBh4.cjs +1 -0
  28. package/browser/esm/B00UnPvEAkPkBES0.mjs +21 -0
  29. package/browser/esm/BMOy-29kM8QKSXAA.mjs +316 -0
  30. package/browser/esm/BTwaInIwOYixmjEI.mjs +23 -0
  31. package/browser/esm/BVcAlvEdsM6nrdMi.mjs +24 -0
  32. package/browser/esm/BbAe5bgfHEREMZHH.mjs +96 -0
  33. package/browser/esm/BbxTHuwQRw9Q2Yk4.mjs +382 -0
  34. package/browser/esm/BdWPkyDEfOSORikD.mjs +28 -0
  35. package/browser/esm/CDHIW0fz5goCgqWd.mjs +123 -0
  36. package/browser/esm/CHIg7-M9TGMfmdss.mjs +105 -0
  37. package/browser/esm/CT2Mx78hoGrtXGGc.mjs +37 -0
  38. package/browser/esm/CzY0HOXVgv9HM917.mjs +13 -0
  39. package/browser/esm/D--3bRsKlG0pbw1W.mjs +111 -0
  40. package/browser/esm/D85giwE9k8tjVhRt.mjs +319 -0
  41. package/browser/esm/DCo9qXQklIlMDf1F.mjs +12 -0
  42. package/browser/esm/DXCZWZ7sM3_YT_1j.mjs +146 -0
  43. package/browser/esm/D_-1XUpmS6dtfCBh.mjs +119 -0
  44. package/browser/esm/Dft0O81rt55l5ZPx.mjs +22 -0
  45. package/browser/esm/Dpe3qlV_AVenWc7u.mjs +14 -0
  46. package/browser/esm/FN6OQFCYtpPy-ZGy.mjs +17 -0
  47. package/browser/esm/FNQCkMr4-0zUGiVT.mjs +860 -0
  48. package/browser/esm/YndGL8daSV3kCBM7.mjs +138 -0
  49. package/browser/esm/index.mjs +13173 -13
  50. package/browser/esm/lm5NLBN11iNAiJh_.mjs +28 -0
  51. package/browser/esm/oPZX92aKdMLlSZpq.mjs +15 -0
  52. package/browser/esm/tq8bbbAwRbbuTwtH.mjs +173 -0
  53. package/browser/esm/zTYqn0nYRbk30lHy.mjs +144 -0
  54. package/licenses/dependencies.txt +92 -1
  55. package/node/esm/B00UnPvEAkPkBES0.mjs +21 -0
  56. package/node/esm/B1fcULoMBcva83xT.mjs +14 -0
  57. package/node/esm/BMOy-29kM8QKSXAA.mjs +316 -0
  58. package/node/esm/BTwaInIwOYixmjEI.mjs +23 -0
  59. package/node/esm/BVcAlvEdsM6nrdMi.mjs +24 -0
  60. package/node/esm/BX7yXzCInSe9fUVy.mjs +28 -0
  61. package/node/esm/BbAe5bgfHEREMZHH.mjs +96 -0
  62. package/node/esm/BbxTHuwQRw9Q2Yk4.mjs +382 -0
  63. package/node/esm/BdWPkyDEfOSORikD.mjs +28 -0
  64. package/node/esm/BhgO3MAcneYe97dY.mjs +13 -0
  65. package/node/esm/CDHIW0fz5goCgqWd.mjs +123 -0
  66. package/node/esm/CHIg7-M9TGMfmdss.mjs +105 -0
  67. package/node/esm/CT2Mx78hoGrtXGGc.mjs +37 -0
  68. package/node/esm/D--3bRsKlG0pbw1W.mjs +111 -0
  69. package/node/esm/D8J2HQnvcmSMPRoj.mjs +319 -0
  70. package/node/esm/DCo9qXQklIlMDf1F.mjs +12 -0
  71. package/node/esm/DXCZWZ7sM3_YT_1j.mjs +146 -0
  72. package/node/esm/DXEtJwyiQ0VV4Hhd.mjs +15 -0
  73. package/node/esm/D_-1XUpmS6dtfCBh.mjs +119 -0
  74. package/node/esm/Dft0O81rt55l5ZPx.mjs +22 -0
  75. package/node/esm/FN6OQFCYtpPy-ZGy.mjs +17 -0
  76. package/node/esm/FNQCkMr4-0zUGiVT.mjs +860 -0
  77. package/node/esm/YndGL8daSV3kCBM7.mjs +138 -0
  78. package/node/esm/index.mjs +11091 -13
  79. package/node/esm/tq8bbbAwRbbuTwtH.mjs +173 -0
  80. package/node/esm/zTYqn0nYRbk30lHy.mjs +144 -0
  81. package/package.json +4 -3
  82. package/resources/contents.json +14 -0
  83. package/resources/locales/contents.json +9 -0
  84. package/resources/locales/de/functions.json +298 -0
  85. package/types/index.d.ts +4 -17
  86. package/types/src/.generated/decl/database/Database.decl.d.ts +4 -0
  87. package/types/src/.generated/decl/dateTime/Date.decl.d.ts +4 -0
  88. package/types/src/.generated/decl/engineering/Bessel.decl.d.ts +4 -0
  89. package/types/src/.generated/decl/engineering/Bitwise.decl.d.ts +4 -0
  90. package/types/src/.generated/decl/engineering/Convert.decl.d.ts +4 -0
  91. package/types/src/.generated/decl/engineering/Engineering.decl.d.ts +4 -0
  92. package/types/src/.generated/decl/engineering/Error.decl.d.ts +4 -0
  93. package/types/src/.generated/decl/engineering/Imaginary.decl.d.ts +4 -0
  94. package/types/src/.generated/decl/information/Information.decl.d.ts +4 -0
  95. package/types/src/.generated/decl/japanese/Date.decl.d.ts +4 -0
  96. package/types/src/.generated/decl/japanese/Text.decl.d.ts +4 -0
  97. package/types/src/.generated/decl/logical/Logical.decl.d.ts +4 -0
  98. package/types/src/.generated/decl/lookupReference/GroupBy.decl.d.ts +4 -0
  99. package/types/src/.generated/decl/lookupReference/PivotBy.decl.d.ts +4 -0
  100. package/types/src/.generated/decl/lookupReference/Reference.decl.d.ts +4 -0
  101. package/types/src/.generated/decl/mathTrig/Math.decl.d.ts +4 -0
  102. package/types/src/.generated/decl/mathTrig/Trig.decl.d.ts +4 -0
  103. package/types/src/.generated/decl/operators/Operators.decl.d.ts +4 -0
  104. package/types/src/.generated/decl/statistical/Distribution.decl.d.ts +4 -0
  105. package/types/src/.generated/decl/statistical/Statistical.decl.d.ts +4 -0
  106. package/types/src/.generated/decl/testing/Testing.decl.d.ts +4 -0
  107. package/types/src/.generated/decl/text/Text.decl.d.ts +4 -0
  108. package/types/src/.generated/decl/thai/Text.decl.d.ts +4 -0
  109. package/types/src/.generated/decl/web/FilterXML.decl.d.ts +4 -0
  110. package/types/src/.generated/decl/web/Web.decl.d.ts +4 -0
  111. package/types/src/.generated/desc/database/Database.desc.d.ts +4 -0
  112. package/types/src/.generated/desc/dateTime/Date.desc.d.ts +4 -0
  113. package/types/src/.generated/desc/engineering/Bessel.desc.d.ts +4 -0
  114. package/types/src/.generated/desc/engineering/Bitwise.desc.d.ts +4 -0
  115. package/types/src/.generated/desc/engineering/Convert.desc.d.ts +4 -0
  116. package/types/src/.generated/desc/engineering/Engineering.desc.d.ts +4 -0
  117. package/types/src/.generated/desc/engineering/Error.desc.d.ts +4 -0
  118. package/types/src/.generated/desc/engineering/Imaginary.desc.d.ts +4 -0
  119. package/types/src/.generated/desc/information/Information.desc.d.ts +4 -0
  120. package/types/src/.generated/desc/japanese/Date.desc.d.ts +4 -0
  121. package/types/src/.generated/desc/japanese/Text.desc.d.ts +4 -0
  122. package/types/src/.generated/desc/logical/Logical.desc.d.ts +4 -0
  123. package/types/src/.generated/desc/lookupReference/GroupBy.desc.d.ts +4 -0
  124. package/types/src/.generated/desc/lookupReference/PivotBy.desc.d.ts +4 -0
  125. package/types/src/.generated/desc/lookupReference/Reference.desc.d.ts +4 -0
  126. package/types/src/.generated/desc/mathTrig/Math.desc.d.ts +4 -0
  127. package/types/src/.generated/desc/mathTrig/Trig.desc.d.ts +4 -0
  128. package/types/src/.generated/desc/operators/Operators.desc.d.ts +4 -0
  129. package/types/src/.generated/desc/statistical/Distribution.desc.d.ts +4 -0
  130. package/types/src/.generated/desc/statistical/Statistical.desc.d.ts +4 -0
  131. package/types/src/.generated/desc/testing/Testing.desc.d.ts +4 -0
  132. package/types/src/.generated/desc/text/Text.desc.d.ts +4 -0
  133. package/types/src/.generated/desc/thai/Text.desc.d.ts +4 -0
  134. package/types/src/.generated/desc/web/FilterXML.desc.d.ts +4 -0
  135. package/types/src/.generated/desc/web/Web.desc.d.ts +4 -0
  136. package/types/src/.generated/index.d.ts +7 -0
  137. package/types/src/_utils/AggregateIFS.d.ts +39 -0
  138. package/types/src/_utils/Consts.d.ts +14 -0
  139. package/types/src/_utils/Errors.d.ts +33 -0
  140. package/types/src/_utils/ReduceIf.d.ts +26 -0
  141. package/types/src/database/Database.d.ts +86 -0
  142. package/types/src/dateTime/Date.d.ts +139 -0
  143. package/types/src/engineering/Bessel.d.ts +26 -0
  144. package/types/src/engineering/Bitwise.d.ts +101 -0
  145. package/types/src/engineering/Convert.d.ts +9 -0
  146. package/types/src/engineering/Engineering.d.ts +14 -0
  147. package/types/src/engineering/Error.d.ts +25 -0
  148. package/types/src/engineering/Imaginary.d.ts +155 -0
  149. package/types/src/information/Information.d.ts +166 -0
  150. package/types/src/japanese/Date.d.ts +15 -0
  151. package/types/src/japanese/Text.d.ts +8 -0
  152. package/types/src/logical/Logical.d.ts +133 -0
  153. package/types/src/lookupReference/GroupBy.d.ts +19 -0
  154. package/types/src/lookupReference/PivotBy.d.ts +24 -0
  155. package/types/src/lookupReference/Reference.d.ts +296 -0
  156. package/types/src/mathTrig/Math.d.ts +430 -0
  157. package/types/src/mathTrig/Trig.d.ts +107 -0
  158. package/types/src/operators/Operators.d.ts +107 -0
  159. package/types/src/statistical/Distribution.d.ts +858 -0
  160. package/types/src/statistical/Statistical.d.ts +165 -0
  161. package/types/src/testing/Testing.d.ts +28 -0
  162. package/types/src/text/Text.d.ts +312 -0
  163. package/types/src/thai/Text.d.ts +8 -0
  164. package/types/src/web/FilterXML.d.ts +8 -0
  165. package/types/src/web/Web.d.ts +11 -0
@@ -0,0 +1,430 @@
1
+ import { IRange, Scalar, IReferenceRange, AcceptError, AcceptRefError, Repeating, Omittable } from '@sheetxl/primitives';
2
+ /**
3
+ * @summary Returns the absolute value of a number, a number without its sign.
4
+ * @param number is the real number for which you want the absolute value.
5
+ */
6
+ export declare function ABS(number: number): number;
7
+ /**
8
+ * @summary Returns an aggregate in a list or database.
9
+ * @param functionNum The function to use: 1-19.
10
+ * @param options The options for the aggregate: 0-7.
11
+ * @param array The ranges to aggregate.
12
+ * @param KOrRest If functionNum is 14-19, this is the k value. Otherwise, this is the first of the ranges to aggregate.
13
+ *
14
+ * @remarks
15
+ * | functionNum | Function |
16
+ * |--------------|-----------------|
17
+ * | 1 | AVERAGE |
18
+ * | 2 | COUNT |
19
+ * | 3 | COUNTA |
20
+ * | 4 | MAX |
21
+ * | 5 | MIN |
22
+ * | 6 | PRODUCT |
23
+ * | 7 | STDEV |
24
+ * | 8 | STDEVP |
25
+ * | 9 | SUM |
26
+ * | 10 | VAR |
27
+ * | 11 | VARP |
28
+ * | 12 | MEDIAN |
29
+ * | 13 | MODE.SNGL |
30
+ * | 14 | LARGE |
31
+ * | 15 | SMALL |
32
+ * | 16 | PERCENTILE.INC |
33
+ * | 17 | QUARTILE.INC |
34
+ * | 18 | PERCENTILE.EXC |
35
+ * | 19 | QUARTILE.EXC |
36
+ *
37
+ * | options | Behavior |
38
+ * |---------|-------------------------------------------------------|
39
+ * | 0 | Ignore nested SUBTOTAL and AGGREGATE functions |
40
+ * | 1 | Ignore hidden rows, nested SUBTOTAL and AGGREGATE |
41
+ * | 2 | Ignore error values, nested SUBTOTAL and AGGREGATE |
42
+ * | 3 | Ignore hidden rows, errors, nested SUBTOTAL/AGGREGATE |
43
+ * | 4 | Ignore nothing |
44
+ * | 5 | Ignore hidden rows |
45
+ * | 6 | Ignore error values |
46
+ * | 7 | Ignore hidden rows and error values |
47
+ *
48
+ * Note: nested SUBTOTAL/AGGREGATE calls within ref ranges are not excluded
49
+ * from the calculation in this implementation. This matches the behavior of
50
+ * most spreadsheet engines but differs from Excel in edge cases where
51
+ * SUBTOTAL results appear within the referenced range.
52
+ */
53
+ export declare function AGGREGATE(functionNum: number, options: number, array: AcceptRefError<IRange>, ...KOrRest: AcceptRefError<IRange>[]): Scalar;
54
+ /**
55
+ * @summary Converts a Roman numeral to Arabic.
56
+ * @param text is the Roman numeral you want to convert.
57
+ */
58
+ export declare function ARABIC(text: string): number;
59
+ /**
60
+ * @summary Converts a number into a text representation with the given radix (base).
61
+ * @param number is the number that you want to convert.
62
+ * @param radix is the base Radix that you want to convert the number into.
63
+ * @param minLength is the minimum length of the returned string.
64
+ */
65
+ export declare function BASE(number: number, radix: number, minLength?: number): string | number;
66
+ /**
67
+ * @summary Rounds a number up, to the nearest multiple of significance.
68
+ * @param number is the value you want to round.
69
+ * @param significance is the multiple to which you want to round.
70
+ * @category Compatibility
71
+ */
72
+ export declare function CEILING(number: number, significance: number): number;
73
+ /**
74
+ * @name CEILING.MATH
75
+ * @summary Rounds a number up, to the nearest integer or to the nearest multiple of significance.
76
+ * @param number is the real number you want to round.
77
+ * @param significance when given and nonzero this function will round away from zero.
78
+ */
79
+ export declare function CEILING_MATH(number: number, significance?: Omittable<number>, mode?: number): number;
80
+ /**
81
+ * @name CEILING.PRECISE
82
+ * @summary Rounds a number up to the nearest integer or to the nearest multiple of significance.
83
+ * @param number is the real number you want to round.
84
+ * @param significance is the multiple to which you want to round.
85
+ * @category Compatibility
86
+ */
87
+ export declare function CEILING_PRECISE(number: number, significance?: Omittable<number>): number;
88
+ /**
89
+ * @name ECMA.CEILING
90
+ * @summary Rounds a number up, to the nearest multiple of significance.
91
+ * @param number is the value you want to round.
92
+ * @param significance is the multiple to which you want to round.
93
+ * @category Compatibility
94
+ */
95
+ export declare function ECMA_CEILING(number: number, significance: number): number;
96
+ /**
97
+ * @summary Returns the number of combinations for a given number of items.
98
+ * @param number is the total number of items.
99
+ * @param numberChosen is the number of items in each combination.
100
+ */
101
+ export declare function COMBIN(number: number, numberChosen: number): number;
102
+ /**
103
+ * @summary Returns the number of combinations with repetitions for a given number of items.
104
+ * @param number is the total number of items.
105
+ * @param numberChosen is the number of items in each combination.
106
+ */
107
+ export declare function COMBINA(number: number, numberChosen: number): number;
108
+ /**
109
+ * @summary Converts a text representation of a number in a given base into a decimal number.
110
+ * @param number is the number that you want to convert.
111
+ * @param radix is the base Radix of the number you are converting.
112
+ */
113
+ export declare function DECIMAL(number: string, radix: number): number;
114
+ /**
115
+ * @summary Converts radians to degrees.
116
+ * @param angle is the angle in radians that you want to convert.
117
+ */
118
+ export declare function DEGREES(angle: number): number;
119
+ /**
120
+ * @summary Rounds a positive number up and negative number down to the nearest even integer.
121
+ * @param number is the value to round.
122
+ */
123
+ export declare function EVEN(number: number): number;
124
+ /**
125
+ * @summary Returns e raised to the power of a given number.
126
+ * @param number is the exponent applied to the base e. The constant e equals 2.71828182845904, the base of the natural logarithm.
127
+ */
128
+ export declare function EXP(number: number): number;
129
+ /**
130
+ * @summary Returns the factorial of a number, equal to 1*2*3*...* Number.
131
+ * @param number is the nonnegative number you want the factorial for.
132
+ */
133
+ export declare function FACT(number: number): number;
134
+ /**
135
+ * @summary Returns the double factorial of a number.
136
+ * @param number is the value for which to return the double factorial.
137
+ */
138
+ export declare function FACTDOUBLE(number: number): number;
139
+ /**
140
+ * @summary Rounds a number down to the nearest multiple of significance.
141
+ * @param number is the real number you want to round.
142
+ * @param significance is the multiple to which you want to round. Number and Significance must either both be positive or both be negative.
143
+ * @category Compatibility
144
+ */
145
+ export declare function FLOOR(number: number, significance: number): number;
146
+ /**
147
+ * @name FLOOR.MATH
148
+ * @summary Rounds a number down, to the nearest integer or to the nearest multiple of significance.
149
+ * @param number is the real number you want to round.
150
+ * @param significance is the multiple to which you want to round.
151
+ * @param mode when given and nonzero this function will round towards zero.
152
+ */
153
+ export declare function FLOOR_MATH(number: number, significance?: Omittable<number>, mode?: Omittable<number>): Scalar;
154
+ /**
155
+ * @name FLOOR.PRECISE
156
+ * @summary Rounds a number down to the nearest integer or to the nearest multiple of significance.
157
+ * @param number is the real number you want to round.
158
+ * @param significance is the multiple to which you want to round.
159
+ */
160
+ export declare function FLOOR_PRECISE(number: number, significance?: Omittable<number>): number;
161
+ /**
162
+ * @summary Returns the greatest common divisor.
163
+ * @param number are 1 to 255 values.
164
+ */
165
+ export declare function GCD(number: Scalar[]): number;
166
+ /**
167
+ * @summary Rounds a number down to the nearest integer.
168
+ * @param number is the real number you want to round down to an integer.
169
+ */
170
+ export declare function INT(number: number): number;
171
+ /**
172
+ * @name ISO.CEILING
173
+ * @summary Rounds a number up to the nearest integer.
174
+ * @param number is the real number you want to round up to an integer.
175
+ * @param significance is the multiple to which you want to round number.
176
+ * @category Compatibility
177
+ */
178
+ export declare function ISO_CEILING(number: number, significance?: number): number;
179
+ /**
180
+ * @summary Returns the least common multiple.
181
+ * @param number are 1 to 255 values for which you want the least common multiple.
182
+ */
183
+ export declare function LCM(number: Scalar[]): number;
184
+ /**
185
+ * @summary Returns the natural logarithm of a number.
186
+ * @param number is the positive real number for which you want the natural logarithm.
187
+ */
188
+ export declare function LN(number: number): number;
189
+ /**
190
+ * @summary Returns the logarithm of a number to the base you specify.
191
+ * @param number is the positive real number for which you want the logarithm.
192
+ * @param base is the base of the logarithm.
193
+ */
194
+ export declare function LOG(number: number, base?: number): number;
195
+ /**
196
+ * @summary Returns the base-10 logarithm of a number.
197
+ * @param number is the positive real number for which you want the base-10 logarithm.
198
+ */
199
+ export declare function LOG10(number: number): number;
200
+ /**
201
+ * @summary Returns the matrix determinant of an array.
202
+ * @param array is a numeric array with an equal number of rows and columns, either a cell range or an array constant.
203
+ */
204
+ export declare function MDETERM(array: IRange<number>): Scalar;
205
+ /**
206
+ * @summary Returns the inverse matrix for the matrix stored in an array.
207
+ * @param array is a numeric array with an equal number of rows and columns, either a cell range or an array constant.
208
+ */
209
+ export declare function MINVERSE(array: IRange<number>): Scalar[][];
210
+ /**
211
+ * @summary Returns the matrix product of two arrays, an array with the same number of rows as array1 and columns as array2.
212
+ * @param array1 is the first array of numbers to multiply and must have the same number of columns as Array2 has rows.
213
+ * @param array2 is the second array of numbers to multiply and must have the same number of columns as Array1 has rows.
214
+ */
215
+ export declare function MMULT(array1: IRange<number>, array2: IRange<number>): Scalar[][];
216
+ /**
217
+ * @summary Returns the remainder after a number is divided by a divisor.
218
+ * @param number is the number for which you want to find the remainder after the division is performed.
219
+ * @param divisor is the number by which you want to divide Number.
220
+ */
221
+ export declare function MOD(number: number, divisor: number): number;
222
+ /**
223
+ * @summary Returns a number rounded to the desired multiple.
224
+ * @param number is the value to round.
225
+ * @param multiple is the multiple to which you want to round number.
226
+ */
227
+ export declare function MROUND(number: number, multiple: number): number;
228
+ /**
229
+ * @summary Returns the multinomial of a set of numbers.
230
+ * @param number are 1 to 255 values for which you want the multinomial.
231
+ */
232
+ export declare function MULTINOMIAL(number: number[]): number;
233
+ /**
234
+ * @summary Returns the unit matrix for the specified dimension.
235
+ * @param dimension is an integer specifying the dimension of the unit matrix that you want to return.
236
+ */
237
+ export declare function MUNIT(dimension: number): IRange;
238
+ /**
239
+ * @summary Rounds a positive number up and negative number down to the nearest odd integer.
240
+ * @param number is the value to round.
241
+ */
242
+ export declare function ODD(number: number): number;
243
+ /**
244
+ * @summary Returns the percentage of a subset of a given data set.
245
+ * @param dataSubset is the subset.
246
+ * @param dataAll is the data set.
247
+ */
248
+ export declare function PERCENTOF(dataSubset: IRange<number>, dataAll: IRange<number>): number;
249
+ /**
250
+ * @summary Returns the value of Pi, 3.14159265358979, accurate to 15 digits.
251
+ */
252
+ export declare function PI(): number;
253
+ /**
254
+ * @summary Returns the result of a number raised to a power.
255
+ * @param number is the base number, any real number.
256
+ * @param power is the exponent, to which the base number is raised.
257
+ */
258
+ export declare function POWER(number: number, power: number): number;
259
+ /**
260
+ * @summary Multiplies all the numbers given as arguments.
261
+ * @param number are 1 to 255 numbers, logical values, or text representations of numbers that you want to multiply.
262
+ */
263
+ export declare function PRODUCT(number: IRange<number>[]): number;
264
+ /**
265
+ * @summary Returns the integer portion of a division.
266
+ * @param numerator is the dividend.
267
+ * @param denominator is the divisor.
268
+ */
269
+ export declare function QUOTIENT(numerator: number, denominator: number): number;
270
+ /**
271
+ * @summary Converts degrees to radians.
272
+ * @param angle is an angle in degrees that you want to convert.
273
+ */
274
+ export declare function RADIANS(angle: number): number;
275
+ /**
276
+ * @summary Returns a random number greater than or equal to 0 and less than 1, evenly distributed (changes on recalculation).
277
+ */
278
+ export declare function RAND(): number;
279
+ /**
280
+ * @summary Returns an array of random numbers.
281
+ * @param rows the number of rows in the returned array.
282
+ * @param columns the number of columns in the returned array.
283
+ * @param min the minimum number you would like returned.
284
+ * @param max the maximum number you would like returned.
285
+ * @param integer return an integer or a decimal value. TRUE for an integer, FALSE for a decimal number.
286
+ */
287
+ export declare function RANDARRAY(rows?: number, columns?: number, min?: number, max?: number, integer?: boolean): IRange;
288
+ /**
289
+ * @summary Returns a random number between the numbers you specify.
290
+ * @param bottom is the smallest integer RANDBETWEEN will return.
291
+ * @param top is the largest integer RANDBETWEEN will return.
292
+ */
293
+ export declare function RANDBETWEEN(bottom: Scalar, top: Scalar): number;
294
+ /**
295
+ * @summary Converts an Arabic numeral to Roman, as text.
296
+ * @param number is the Arabic numeral you want to convert.
297
+ * @param form is the number specifying the type of Roman numeral you want.
298
+ */
299
+ export declare function ROMAN(number: number, form?: number): Scalar;
300
+ /**
301
+ * @summary Rounds a number to a specified number of digits.
302
+ * @param number is the number you want to round.
303
+ * @param numDigits is the number of digits to which you want to round. Negative rounds to the left of the decimal point to the nearest integer.
304
+ */
305
+ export declare function ROUND(number: number, numDigits: number): number;
306
+ /**
307
+ * @summary Rounds a number down, toward zero.
308
+ * @param number is any real number that you want rounded down.
309
+ * @param numDigits is the number of digits to which you want to round. Negative rounds to the left of the decimal point to the nearest integer.
310
+ */
311
+ export declare function ROUNDDOWN(number: number, numDigits: number): number;
312
+ /**
313
+ * @summary Rounds a number up, away from zero.
314
+ * @param number is any real number that you want rounded up.
315
+ * @param numDigits is the number of digits to which you want to round. Negative rounds to the left of the decimal point to the nearest integer.
316
+ */
317
+ export declare function ROUNDUP(number: number, numDigits: number): number;
318
+ /**
319
+ * @summary Returns a sequence of numbers.
320
+ * @param rows the number of rows to return.
321
+ * @param columns the number of columns to return.
322
+ * @param start the first number in the sequence.
323
+ * @param step the amount to increment each subsequent value in the sequence.
324
+ */
325
+ export declare function SEQUENCE(rows: Omittable<number>, columns?: Omittable<number>, start?: Omittable<number>, step?: Omittable<number>): IRange;
326
+ /**
327
+ * @summary Returns the sum of a power series based on the formula.
328
+ * @param x is the input value to the power series.
329
+ * @param n is the initial power to which you want to raise x.
330
+ * @param m is the step by which to increase n for each term in the series.
331
+ * @param coefficients is a set of coefficients by which each successive power of x is multiplied.
332
+ */
333
+ export declare function SERIESSUM(x: number, n: number, m: number, coefficients: IRange<number>): number;
334
+ /**
335
+ * @summary Returns the sign of a number: 1 if the number is positive, zero if the number is zero, or -1 if the number is negative.
336
+ * @param number is any real number.
337
+ */
338
+ export declare function SIGN(number: number): number;
339
+ /**
340
+ * @summary Returns the square root of a number.
341
+ * @param number is the number for which you want the square root.
342
+ */
343
+ export declare function SQRT(number: number): number;
344
+ /**
345
+ * @summary Returns the square root of (number * Pi).
346
+ * @param number is the number by which p is multiplied.
347
+ */
348
+ export declare function SQRTPI(number: number): number;
349
+ /**
350
+ * @summary Returns a subtotal in a list or database.
351
+ * @param functionNum is the number 1 to 11 that specifies the summary function for the subtotal.
352
+ * @param ref are 1 to 254 ranges or references for which you want the subtotal.
353
+ *
354
+ * @remarks
355
+ * | functionNum (includes hidden rows) | functionNum (ignores hidden rows) | Function |
356
+ |-------------------------------------|-------------------------------------|----------|
357
+ | 1 | 101 | AVERAGE |
358
+ | 2 | 102 | COUNT |
359
+ | 3 | 103 | COUNTA |
360
+ | 4 | 104 | MAX |
361
+ | 5 | 105 | MIN |
362
+ | 6 | 106 | PRODUCT |
363
+ | 7 | 107 | STDEV |
364
+ | 8 | 108 | STDEVP |
365
+ | 9 | 109 | SUM |
366
+ | 10 | 110 | VAR |
367
+ | 11 | 111 | VARP |
368
+ *
369
+ * Note: nested SUBTOTAL/AGGREGATE calls within ref ranges are not excluded
370
+ * from the calculation in this implementation. This matches the behavior of
371
+ * most spreadsheet engines but differs from Excel in edge cases where
372
+ * SUBTOTAL results appear within the referenced range.
373
+ */
374
+ export declare function SUBTOTAL(functionNum: number, // 1 - 11
375
+ ref: AcceptError<IReferenceRange>[]): Scalar;
376
+ /**
377
+ * @summary Adds all the numbers in a range of cells.
378
+ * @param number are 1 to 255 numbers to sum. Logical values and text are ignored in cells, included if typed as arguments.
379
+ */
380
+ export declare function SUM(number: IRange<number>[]): number;
381
+ /**
382
+ * @summary Adds the cells specified by a given condition or criteria.
383
+ * @param range is the range of cells you want evaluated.
384
+ * @param criteria is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.
385
+ * @param sumRange are the actual cells to sum. If omitted, the cells in range are used.
386
+ */
387
+ export declare function SUMIF(range: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>, sumRange?: AcceptError<IReferenceRange>): Scalar;
388
+ /**
389
+ * @summary Adds the cells specified by a given set of conditions or criteria.
390
+ * @param sumRange are the actual cells to sum.
391
+ * @param criteria the ranges to evaluate and the conditions to evaluate them against.
392
+ * @param criteria.criteriaRange is the range of cells you want evaluated for the particular condition.
393
+ * @param criteria.criteria is the condition or criteria in the form of a number, expression, or text that defines which cells will be added.
394
+ */
395
+ export declare function SUMIFS(sumRange: AcceptError<IRange>, criteria: Repeating<[criteriaRange: AcceptError<IReferenceRange>, criteria: AcceptError<Scalar>]>): Scalar;
396
+ /**
397
+ * @summary Returns the sum of the products of corresponding ranges or arrays.
398
+ * @param array are 2 to 255 arrays for which you want to multiply and then add components. All arrays must have the same dimensions.
399
+ */
400
+ export declare function SUMPRODUCT(array: IRange[]): number;
401
+ /**
402
+ * @summary Returns the sum of the squares of the arguments. The arguments can be numbers, arrays, names, or references to cells that contain numbers.
403
+ * @param number are 1 to 255 numbers, arrays, names, or references to arrays for which you want the sum of the squares.
404
+ */
405
+ export declare function SUMSQ(number: IRange<number>[]): number;
406
+ /**
407
+ * @summary Sums the differences between the squares of two corresponding ranges or arrays.
408
+ * @param arrayX is the first range or array of numbers and can be a number or name, array, or reference that contains numbers.
409
+ * @param arrayY is the second range or array of numbers and can be a number or name, array, or reference that contains numbers.
410
+ */
411
+ export declare function SUMX2MY2(arrayX: AcceptError<IRange>, arrayY: AcceptError<IRange>): number;
412
+ /**
413
+ * @summary Returns the sum total of the sums of squares of numbers in two corresponding ranges or arrays.
414
+ * @param arrayX is the first range or array of numbers and can be a number or name, array, or reference that contains numbers.
415
+ * @param arrayY is the second range or array of numbers and can be a number or name, array, or reference that contains numbers.
416
+ */
417
+ export declare function SUMX2PY2(arrayX: AcceptError<IRange>, arrayY: AcceptError<IRange>): number;
418
+ /**
419
+ * @summary Sums the squares of the differences in two corresponding ranges or arrays.
420
+ * @param arrayX is the first range or array of numbers and can be a number or name, array, or reference that contains numbers.
421
+ * @param arrayY is the second range or array of numbers and can be a number or name, array, or reference that contains numbers.
422
+ */
423
+ export declare function SUMXMY2(arrayX: AcceptError<IRange>, arrayY: AcceptError<IRange>): number;
424
+ /**
425
+ * @summary Truncates a number to an integer by removing the decimal, or fractional, part of the number.
426
+ * @param number is the number you want to truncate.
427
+ * @param numDigits is a number specifying the precision of the truncation.
428
+ */
429
+ export declare function TRUNC(number: number, numDigits?: number): number;
430
+ //# sourceMappingURL=Math.d.ts.map
@@ -0,0 +1,107 @@
1
+ /**
2
+ * @summary Returns the arccosine of a number, in radians in the range 0 to Pi. The arccosine is the angle whose cosine is Number.
3
+ * @param number is the cosine of the angle you want and must be from -1 to 1.
4
+ */
5
+ export declare function ACOS(number: number): number;
6
+ /**
7
+ * @summary Returns the inverse hyperbolic cosine of a number.
8
+ * @param number is any real number equal to or greater than 1.
9
+ */
10
+ export declare function ACOSH(number: number): number;
11
+ /**
12
+ * @summary Returns the arccotangent of a number, in radians in the range 0 to Pi.
13
+ * @param number is the cotangent of the angle you want.
14
+ */
15
+ export declare function ACOT(number: number): number;
16
+ /**
17
+ * @summary Returns the inverse hyperbolic cotangent of a number.
18
+ * @param number is the hyperbolic cotangent of the angle that you want.
19
+ */
20
+ export declare function ACOTH(number: number): number;
21
+ /**
22
+ * @summary Returns the arcsine of a number in radians, in the range -Pi/2 to Pi/2.
23
+ * @param number is the sine of the angle you want and must be from -1 to 1.
24
+ */
25
+ export declare function ASIN(number: number): number;
26
+ /**
27
+ * @summary Returns the inverse hyperbolic sine of a number.
28
+ * @param number is any real number equal to or greater than 1.
29
+ */
30
+ export declare function ASINH(number: number): number;
31
+ /**
32
+ * @summary Returns the arctangent of a number in radians, in the range -Pi/2 to Pi/2.
33
+ * @param number is the tangent of the angle you want.
34
+ */
35
+ export declare function ATAN(number: number): number;
36
+ /**
37
+ * @summary Returns the arctangent of the specified x- and y- coordinates, in radians between -Pi and Pi, excluding -Pi.
38
+ * @param x is the x-coordinate of the point.
39
+ * @param y is the y-coordinate of the point.
40
+ */
41
+ export declare function ATAN2(x: number, y: number): number;
42
+ /**
43
+ * @summary Returns the inverse hyperbolic tangent of a number.
44
+ * @param number is any real number between -1 and 1 excluding -1 and 1.
45
+ */
46
+ export declare function ATANH(number: number): number;
47
+ /**
48
+ * @summary Returns the cosine of an angle.
49
+ * @param number is the angle in radians for which you want the cosine.
50
+ */
51
+ export declare function COS(number: number): number;
52
+ /**
53
+ * @summary Returns the hyperbolic cosine of a number.
54
+ * @param number is any real number.
55
+ */
56
+ export declare function COSH(number: number): number;
57
+ /**
58
+ * @summary Returns the cotangent of an angle.
59
+ * @param number is the angle in radians for which you want the cotangent.
60
+ */
61
+ export declare function COT(number: number): number;
62
+ /**
63
+ * @summary Returns the hyperbolic cotangent of a number.
64
+ * @param number is the angle in radians for which you want the hyperbolic cotangent.
65
+ */
66
+ export declare function COTH(number: number): number;
67
+ /**
68
+ * @summary Returns the cosecant of an angle.
69
+ * @param number is the angle in radians for which you want the cosecant.
70
+ */
71
+ export declare function CSC(number: number): number;
72
+ /**
73
+ * @summary Returns the hyperbolic cosecant of an angle.
74
+ * @param number is the angle in radians for which you want the hyperbolic cosecant.
75
+ */
76
+ export declare function CSCH(number: number): number;
77
+ /**
78
+ * @summary Returns the secant of an angle.
79
+ * @param number is the angle in radians for which you want the secant.
80
+ */
81
+ export declare function SEC(number: number): number;
82
+ /**
83
+ * @summary Returns the hyperbolic secant of an angle.
84
+ * @param number is the angle in radians for which you want the hyperbolic secant.
85
+ */
86
+ export declare function SECH(number: number): number;
87
+ /**
88
+ * @summary Returns the sine of an angle.
89
+ * @param number is the angle in radians for which you want the sine. Degrees * PI()/180 = radians.
90
+ */
91
+ export declare function SIN(number: number): number;
92
+ /**
93
+ * @summary Returns the hyperbolic sine of a number.
94
+ * @param number is any real number.
95
+ */
96
+ export declare function SINH(number: number): number;
97
+ /**
98
+ * @summary Returns the tangent of an angle.
99
+ * @param number is the angle in radians for which you want the tangent. Degrees * PI()/180 = radians.
100
+ */
101
+ export declare function TAN(number: number): number;
102
+ /**
103
+ * @summary Returns the hyperbolic tangent of a number.
104
+ * @param number is any real number.
105
+ */
106
+ export declare function TANH(number: number): number;
107
+ //# sourceMappingURL=Trig.d.ts.map
@@ -0,0 +1,107 @@
1
+ import { Scalar } from '@sheetxl/primitives';
2
+ /**
3
+ * @summary Returns the sum of two numbers. Equal to the '+' operator.
4
+ * @param value1 The first number to add.
5
+ * @param value2 The second number to add.
6
+ * @category Sheets
7
+ */
8
+ export declare function ADD(value1: number, value2: number): number;
9
+ /**
10
+ * @summary Returns the result of dividing one number by another. Equal to the '/' operator.
11
+ * @param dividend The number to be divided.
12
+ * @param divisor The number to divide by.
13
+ * @category Sheets
14
+ */
15
+ export declare function DIVIDE(dividend: number, divisor: number): number;
16
+ /**
17
+ * @summary Returns TRUE if the two specified values are equal. Equal to the '=' operator.
18
+ * @param value1 The first value to compare.
19
+ * @param value2 The second value to compare.
20
+ * @category Sheets
21
+ */
22
+ export declare function EQ(value1: Scalar, value2: Scalar): boolean;
23
+ /**
24
+ * @summary Returns TRUE if the first value is greater than the second. Equal to the '>' operator.
25
+ * @param value1 The first value to compare.
26
+ * @param value2 The second value to compare.
27
+ * @category Sheets
28
+ */
29
+ export declare function GT(value1: Scalar, value2: Scalar): boolean;
30
+ /**
31
+ * @summary Returns TRUE if the first value is greater than or equal to the second. Equal to the '>=' operator.
32
+ * @param value1 The first value to compare.
33
+ * @param value2 The second value to compare.
34
+ * @category Sheets
35
+ */
36
+ export declare function GTE(value1: Scalar, value2: Scalar): boolean;
37
+ /**
38
+ * @summary Returns TRUE if the first value is less than the second. Equal to the '<' operator.
39
+ * @param value1 The first value to compare.
40
+ * @param value2 The second value to compare.
41
+ * @category Sheets
42
+ */
43
+ export declare function LT(value1: Scalar, value2: Scalar): boolean;
44
+ /**
45
+ * @summary Returns TRUE if the first value is less than or equal to the second. Equal to the '<=' operator.
46
+ * @param value1 The first value to compare.
47
+ * @param value2 The second value to compare.
48
+ * @category Sheets
49
+ */
50
+ export declare function LTE(value1: Scalar, value2: Scalar): boolean;
51
+ /**
52
+ * @summary Returns the difference of two numbers. Equal to the '-' operator.
53
+ * @param value1 The number from which to subtract.
54
+ * @param value2 The number to subtract.
55
+ * @category Sheets
56
+ */
57
+ export declare function MINUS(value1: number, value2: number): number;
58
+ /**
59
+ * @summary Returns the product of two numbers. Equal to the '*' operator.
60
+ * @param value1 The first number to multiply.
61
+ * @param value2 The second number to multiply.
62
+ * @category Sheets
63
+ */
64
+ export declare function MULTIPLY(value1: number, value2: number): number;
65
+ /**
66
+ * @summary Returns TRUE if the two specified values are not equal. Equal to the '<>' operator.
67
+ * @param value1 The first value to compare.
68
+ * @param value2 The second value to compare.
69
+ * @category Sheets
70
+ */
71
+ export declare function NE(value1: Scalar, value2: Scalar): boolean;
72
+ /**
73
+ * @summary Returns a number raised to a power. Equal to the '^' operator.
74
+ * @param base The number to raise to a power.
75
+ * @param exponent The power to raise the base to.
76
+ * @category Sheets
77
+ */
78
+ export declare function POW(base: number, exponent: number): number;
79
+ /**
80
+ * @summary Returns the negation of a number. Equal to the unary '-' operator.
81
+ * @param value The number to negate.
82
+ * @category Sheets
83
+ */
84
+ export declare function UMINUS(value: number): number;
85
+ /**
86
+ * @summary Converts a number to a percentage. Equal to the '%' operator.
87
+ * @param value The number to convert to a percentage.
88
+ * @category Sheets
89
+ */
90
+ export declare function UNARY_PERCENT(value: number): number;
91
+ /**
92
+ * @summary Returns a number unchanged. Equal to the unary '+' operator.
93
+ * @param value The number to return.
94
+ * @category Sheets
95
+ */
96
+ export declare function UPLUS(value: number): number;
97
+ /**
98
+ * @summary Checks whether a number is between two numbers, inclusive by default.
99
+ * @param value The value to test.
100
+ * @param lower The lower bound.
101
+ * @param upper The upper bound.
102
+ * @param lowerInclusive Whether the lower bound is inclusive. Default TRUE.
103
+ * @param upperInclusive Whether the upper bound is inclusive. Default TRUE.
104
+ * @category Sheets
105
+ */
106
+ export declare function ISBETWEEN(value: number, lower: number, upper: number, lowerInclusive?: boolean, upperInclusive?: boolean): boolean;
107
+ //# sourceMappingURL=Operators.d.ts.map