MathTrig.php
40.7 KB
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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
<?php
namespace PhpOffice\PhpSpreadsheet\Calculation;
/**
* @deprecated 1.18.0
*/
class MathTrig
{
/**
* ARABIC.
*
* Converts a Roman numeral to an Arabic numeral.
*
* Excel Function:
* ARABIC(text)
*
* @Deprecated 1.18.0
*
* @See MathTrig\Arabic::evaluate()
* Use the evaluate method in the MathTrig\Arabic class instead
*
* @param string $roman
*
* @return int|string the arabic numberal contrived from the roman numeral
*/
public static function ARABIC($roman)
{
return MathTrig\Arabic::evaluate($roman);
}
/**
* ATAN2.
*
* This function calculates the arc tangent of the two variables x and y. It is similar to
* calculating the arc tangent of y ÷ x, except that the signs of both arguments are used
* to determine the quadrant of the result.
* The arctangent is the angle from the x-axis to a line containing the origin (0, 0) and a
* point with coordinates (xCoordinate, yCoordinate). The angle is given in radians between
* -pi and pi, excluding -pi.
*
* Note that the Excel ATAN2() function accepts its arguments in the reverse order to the standard
* PHP atan2() function, so we need to reverse them here before calling the PHP atan() function.
*
* Excel Function:
* ATAN2(xCoordinate,yCoordinate)
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Tangent::atan2()
* Use the atan2 method in the MathTrig\Trig\Tangent class instead
*
* @param float $xCoordinate the x-coordinate of the point
* @param float $yCoordinate the y-coordinate of the point
*
* @return float|string the inverse tangent of the specified x- and y-coordinates, or a string containing an error
*/
public static function ATAN2($xCoordinate = null, $yCoordinate = null)
{
return MathTrig\Trig\Tangent::atan2($xCoordinate, $yCoordinate);
}
/**
* BASE.
*
* Converts a number into a text representation with the given radix (base).
*
* Excel Function:
* BASE(Number, Radix [Min_length])
*
* @Deprecated 1.18.0
*
* @See MathTrig\Base::evaluate()
* Use the evaluate method in the MathTrig\Base class instead
*
* @param float $number
* @param float $radix
* @param int $minLength
*
* @return string the text representation with the given radix (base)
*/
public static function BASE($number, $radix, $minLength = null)
{
return MathTrig\Base::evaluate($number, $radix, $minLength);
}
/**
* CEILING.
*
* Returns number rounded up, away from zero, to the nearest multiple of significance.
* For example, if you want to avoid using pennies in your prices and your product is
* priced at $4.42, use the formula =CEILING(4.42,0.05) to round prices up to the
* nearest nickel.
*
* Excel Function:
* CEILING(number[,significance])
*
* @Deprecated 1.17.0
*
* @param float $number the number you want to round
* @param float $significance the multiple to which you want to round
*
* @return float|string Rounded Number, or a string containing an error
*
* @see MathTrig\Ceiling::ceiling()
* Use the ceiling() method in the MathTrig\Ceiling class instead
*/
public static function CEILING($number, $significance = null)
{
return MathTrig\Ceiling::ceiling($number, $significance);
}
/**
* COMBIN.
*
* Returns the number of combinations for a given number of items. Use COMBIN to
* determine the total possible number of groups for a given number of items.
*
* Excel Function:
* COMBIN(numObjs,numInSet)
*
* @Deprecated 1.18.0
*
* @see MathTrig\Combinations::withoutRepetition()
* Use the withoutRepetition() method in the MathTrig\Combinations class instead
*
* @param int $numObjs Number of different objects
* @param int $numInSet Number of objects in each combination
*
* @return float|int|string Number of combinations, or a string containing an error
*/
public static function COMBIN($numObjs, $numInSet)
{
return MathTrig\Combinations::withoutRepetition($numObjs, $numInSet);
}
/**
* EVEN.
*
* Returns number rounded up to the nearest even integer.
* You can use this function for processing items that come in twos. For example,
* a packing crate accepts rows of one or two items. The crate is full when
* the number of items, rounded up to the nearest two, matches the crate's
* capacity.
*
* Excel Function:
* EVEN(number)
*
* @Deprecated 1.18.0
*
* @see MathTrig\Round::even()
* Use the even() method in the MathTrig\Round class instead
*
* @param float $number Number to round
*
* @return float|int|string Rounded Number, or a string containing an error
*/
public static function EVEN($number)
{
return MathTrig\Round::even($number);
}
/**
* Helper function for Even.
*
* @Deprecated 1.18.0
*
* @see MathTrig\Helpers::getEven()
* Use the evaluate() method in the MathTrig\Helpers class instead
*/
public static function getEven(float $number): int
{
return (int) MathTrig\Helpers::getEven($number);
}
/**
* FACT.
*
* Returns the factorial of a number.
* The factorial of a number is equal to 1*2*3*...* number.
*
* Excel Function:
* FACT(factVal)
*
* @Deprecated 1.18.0
*
* @param float $factVal Factorial Value
*
* @return float|int|string Factorial, or a string containing an error
*
*@see MathTrig\Factorial::fact()
* Use the fact() method in the MathTrig\Factorial class instead
*/
public static function FACT($factVal)
{
return MathTrig\Factorial::fact($factVal);
}
/**
* FACTDOUBLE.
*
* Returns the double factorial of a number.
*
* Excel Function:
* FACTDOUBLE(factVal)
*
* @Deprecated 1.18.0
*
* @param float $factVal Factorial Value
*
* @return float|int|string Double Factorial, or a string containing an error
*
*@see MathTrig\Factorial::factDouble()
* Use the factDouble() method in the MathTrig\Factorial class instead
*/
public static function FACTDOUBLE($factVal)
{
return MathTrig\Factorial::factDouble($factVal);
}
/**
* FLOOR.
*
* Rounds number down, toward zero, to the nearest multiple of significance.
*
* Excel Function:
* FLOOR(number[,significance])
*
* @Deprecated 1.17.0
*
* @param float $number Number to round
* @param float $significance Significance
*
* @return float|string Rounded Number, or a string containing an error
*
*@see MathTrig\Floor::floor()
* Use the floor() method in the MathTrig\Floor class instead
*/
public static function FLOOR($number, $significance = null)
{
return MathTrig\Floor::floor($number, $significance);
}
/**
* FLOOR.MATH.
*
* Round a number down to the nearest integer or to the nearest multiple of significance.
*
* Excel Function:
* FLOOR.MATH(number[,significance[,mode]])
*
* @Deprecated 1.17.0
*
* @param float $number Number to round
* @param float $significance Significance
* @param int $mode direction to round negative numbers
*
* @return float|string Rounded Number, or a string containing an error
*
*@see MathTrig\Floor::math()
* Use the math() method in the MathTrig\Floor class instead
*/
public static function FLOORMATH($number, $significance = null, $mode = 0)
{
return MathTrig\Floor::math($number, $significance, $mode);
}
/**
* FLOOR.PRECISE.
*
* Rounds number down, toward zero, to the nearest multiple of significance.
*
* Excel Function:
* FLOOR.PRECISE(number[,significance])
*
* @Deprecated 1.17.0
*
* @param float $number Number to round
* @param float $significance Significance
*
* @return float|string Rounded Number, or a string containing an error
*
*@see MathTrig\Floor::precise()
* Use the precise() method in the MathTrig\Floor class instead
*/
public static function FLOORPRECISE($number, $significance = 1)
{
return MathTrig\Floor::precise($number, $significance);
}
/**
* INT.
*
* Casts a floating point value to an integer
*
* Excel Function:
* INT(number)
*
* @Deprecated 1.17.0
*
* @see MathTrig\IntClass::evaluate()
* Use the evaluate() method in the MathTrig\IntClass class instead
*
* @param float $number Number to cast to an integer
*
* @return int|string Integer value, or a string containing an error
*/
public static function INT($number)
{
return MathTrig\IntClass::evaluate($number);
}
/**
* GCD.
*
* Returns the greatest common divisor of a series of numbers.
* The greatest common divisor is the largest integer that divides both
* number1 and number2 without a remainder.
*
* Excel Function:
* GCD(number1[,number2[, ...]])
*
* @Deprecated 1.18.0
*
* @see MathTrig\Gcd::evaluate()
* Use the evaluate() method in the MathTrig\Gcd class instead
*
* @param mixed ...$args Data values
*
* @return int|mixed|string Greatest Common Divisor, or a string containing an error
*/
public static function GCD(...$args)
{
return MathTrig\Gcd::evaluate(...$args);
}
/**
* LCM.
*
* Returns the lowest common multiplier of a series of numbers
* The least common multiple is the smallest positive integer that is a multiple
* of all integer arguments number1, number2, and so on. Use LCM to add fractions
* with different denominators.
*
* Excel Function:
* LCM(number1[,number2[, ...]])
*
* @Deprecated 1.18.0
*
* @see MathTrig\Lcm::evaluate()
* Use the evaluate() method in the MathTrig\Lcm class instead
*
* @param mixed ...$args Data values
*
* @return int|string Lowest Common Multiplier, or a string containing an error
*/
public static function LCM(...$args)
{
return MathTrig\Lcm::evaluate(...$args);
}
/**
* LOG_BASE.
*
* Returns the logarithm of a number to a specified base. The default base is 10.
*
* Excel Function:
* LOG(number[,base])
*
* @Deprecated 1.18.0
*
* @see MathTrig\Logarithms::withBase()
* Use the withBase() method in the MathTrig\Logarithms class instead
*
* @param float $number The positive real number for which you want the logarithm
* @param float $base The base of the logarithm. If base is omitted, it is assumed to be 10.
*
* @return float|string The result, or a string containing an error
*/
public static function logBase($number, $base = 10)
{
return MathTrig\Logarithms::withBase($number, $base);
}
/**
* MDETERM.
*
* Returns the matrix determinant of an array.
*
* Excel Function:
* MDETERM(array)
*
* @Deprecated 1.18.0
*
* @see MathTrig\MatrixFunctions::determinant()
* Use the determinant() method in the MathTrig\MatrixFunctions class instead
*
* @param array $matrixValues A matrix of values
*
* @return float|string The result, or a string containing an error
*/
public static function MDETERM($matrixValues)
{
return MathTrig\MatrixFunctions::determinant($matrixValues);
}
/**
* MINVERSE.
*
* Returns the inverse matrix for the matrix stored in an array.
*
* Excel Function:
* MINVERSE(array)
*
* @Deprecated 1.18.0
*
* @see MathTrig\MatrixFunctions::inverse()
* Use the inverse() method in the MathTrig\MatrixFunctions class instead
*
* @param array $matrixValues A matrix of values
*
* @return array|string The result, or a string containing an error
*/
public static function MINVERSE($matrixValues)
{
return MathTrig\MatrixFunctions::inverse($matrixValues);
}
/**
* MMULT.
*
* @Deprecated 1.18.0
*
* @see MathTrig\MatrixFunctions::multiply()
* Use the multiply() method in the MathTrig\MatrixFunctions class instead
*
* @param array $matrixData1 A matrix of values
* @param array $matrixData2 A matrix of values
*
* @return array|string The result, or a string containing an error
*/
public static function MMULT($matrixData1, $matrixData2)
{
return MathTrig\MatrixFunctions::multiply($matrixData1, $matrixData2);
}
/**
* MOD.
*
* @Deprecated 1.18.0
*
* @see MathTrig\Operations::mod()
* Use the mod() method in the MathTrig\Operations class instead
*
* @param int $a Dividend
* @param int $b Divisor
*
* @return float|int|string Remainder, or a string containing an error
*/
public static function MOD($a = 1, $b = 1)
{
return MathTrig\Operations::mod($a, $b);
}
/**
* MROUND.
*
* Rounds a number to the nearest multiple of a specified value
*
* @Deprecated 1.17.0
*
* @param float $number Number to round
* @param int $multiple Multiple to which you want to round $number
*
* @return float|string Rounded Number, or a string containing an error
*
*@see MathTrig\Round::multiple()
* Use the multiple() method in the MathTrig\Mround class instead
*/
public static function MROUND($number, $multiple)
{
return MathTrig\Round::multiple($number, $multiple);
}
/**
* MULTINOMIAL.
*
* Returns the ratio of the factorial of a sum of values to the product of factorials.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Factorial::multinomial()
* Use the multinomial method in the MathTrig\Factorial class instead
*
* @param mixed[] $args An array of mixed values for the Data Series
*
* @return float|string The result, or a string containing an error
*/
public static function MULTINOMIAL(...$args)
{
return MathTrig\Factorial::multinomial(...$args);
}
/**
* ODD.
*
* Returns number rounded up to the nearest odd integer.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Round::odd()
* Use the odd method in the MathTrig\Round class instead
*
* @param float $number Number to round
*
* @return float|int|string Rounded Number, or a string containing an error
*/
public static function ODD($number)
{
return MathTrig\Round::odd($number);
}
/**
* POWER.
*
* Computes x raised to the power y.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Operations::power()
* Use the evaluate method in the MathTrig\Power class instead
*
* @param float $x
* @param float $y
*
* @return float|int|string The result, or a string containing an error
*/
public static function POWER($x = 0, $y = 2)
{
return MathTrig\Operations::power($x, $y);
}
/**
* PRODUCT.
*
* PRODUCT returns the product of all the values and cells referenced in the argument list.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Operations::product()
* Use the product method in the MathTrig\Operations class instead
*
* Excel Function:
* PRODUCT(value1[,value2[, ...]])
*
* @param mixed ...$args Data values
*
* @return float|string
*/
public static function PRODUCT(...$args)
{
return MathTrig\Operations::product(...$args);
}
/**
* QUOTIENT.
*
* QUOTIENT function returns the integer portion of a division. Numerator is the divided number
* and denominator is the divisor.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Operations::quotient()
* Use the quotient method in the MathTrig\Operations class instead
*
* Excel Function:
* QUOTIENT(value1[,value2[, ...]])
*
* @param mixed $numerator
* @param mixed $denominator
*
* @return int|string
*/
public static function QUOTIENT($numerator, $denominator)
{
return MathTrig\Operations::quotient($numerator, $denominator);
}
/**
* RAND/RANDBETWEEN.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Random::randBetween()
* Use the randBetween or randBetween method in the MathTrig\Random class instead
*
* @param int $min Minimal value
* @param int $max Maximal value
*
* @return float|int|string Random number
*/
public static function RAND($min = 0, $max = 0)
{
return MathTrig\Random::randBetween($min, $max);
}
/**
* ROMAN.
*
* Converts a number to Roman numeral
*
* @Deprecated 1.17.0
*
* @Ssee MathTrig\Roman::evaluate()
* Use the evaluate() method in the MathTrig\Roman class instead
*
* @param mixed $aValue Number to convert
* @param mixed $style Number indicating one of five possible forms
*
* @return string Roman numeral, or a string containing an error
*/
public static function ROMAN($aValue, $style = 0)
{
return MathTrig\Roman::evaluate($aValue, $style);
}
/**
* ROUNDUP.
*
* Rounds a number up to a specified number of decimal places
*
* @Deprecated 1.17.0
*
* @See MathTrig\Round::up()
* Use the up() method in the MathTrig\Round class instead
*
* @param float $number Number to round
* @param int $digits Number of digits to which you want to round $number
*
* @return float|string Rounded Number, or a string containing an error
*/
public static function ROUNDUP($number, $digits)
{
return MathTrig\Round::up($number, $digits);
}
/**
* ROUNDDOWN.
*
* Rounds a number down to a specified number of decimal places
*
* @Deprecated 1.17.0
*
* @See MathTrig\Round::down()
* Use the down() method in the MathTrig\Round class instead
*
* @param float $number Number to round
* @param int $digits Number of digits to which you want to round $number
*
* @return float|string Rounded Number, or a string containing an error
*/
public static function ROUNDDOWN($number, $digits)
{
return MathTrig\Round::down($number, $digits);
}
/**
* SERIESSUM.
*
* Returns the sum of a power series
*
* @Deprecated 1.18.0
*
* @See MathTrig\SeriesSum::evaluate()
* Use the evaluate method in the MathTrig\SeriesSum class instead
*
* @param mixed $x Input value
* @param mixed $n Initial power
* @param mixed $m Step
* @param mixed[] $args An array of coefficients for the Data Series
*
* @return float|string The result, or a string containing an error
*/
public static function SERIESSUM($x, $n, $m, ...$args)
{
return MathTrig\SeriesSum::evaluate($x, $n, $m, ...$args);
}
/**
* SIGN.
*
* Determines the sign of a number. Returns 1 if the number is positive, zero (0)
* if the number is 0, and -1 if the number is negative.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Sign::evaluate()
* Use the evaluate method in the MathTrig\Sign class instead
*
* @param float $number Number to round
*
* @return int|string sign value, or a string containing an error
*/
public static function SIGN($number)
{
return MathTrig\Sign::evaluate($number);
}
/**
* returnSign = returns 0/-1/+1.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Helpers::returnSign()
* Use the returnSign method in the MathTrig\Helpers class instead
*/
public static function returnSign(float $number): int
{
return MathTrig\Helpers::returnSign($number);
}
/**
* SQRTPI.
*
* Returns the square root of (number * pi).
*
* @Deprecated 1.18.0
*
* @See MathTrig\Sqrt::sqrt()
* Use the pi method in the MathTrig\Sqrt class instead
*
* @param float $number Number
*
* @return float|string Square Root of Number * Pi, or a string containing an error
*/
public static function SQRTPI($number)
{
return MathTrig\Sqrt::pi($number);
}
/**
* SUBTOTAL.
*
* Returns a subtotal in a list or database.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Subtotal::evaluate()
* Use the evaluate method in the MathTrig\Subtotal class instead
*
* @param int $functionType
* A number 1 to 11 that specifies which function to
* use in calculating subtotals within a range
* list
* Numbers 101 to 111 shadow the functions of 1 to 11
* but ignore any values in the range that are
* in hidden rows or columns
* @param mixed[] $args A mixed data series of values
*
* @return float|string
*/
public static function SUBTOTAL($functionType, ...$args)
{
return MathTrig\Subtotal::evaluate($functionType, ...$args);
}
/**
* SUM.
*
* SUM computes the sum of all the values and cells referenced in the argument list.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Sum::sumErroringStrings()
* Use the sumErroringStrings method in the MathTrig\Sum class instead
*
* Excel Function:
* SUM(value1[,value2[, ...]])
*
* @param mixed ...$args Data values
*
* @return float|string
*/
public static function SUM(...$args)
{
return MathTrig\Sum::sumIgnoringStrings(...$args);
}
/**
* SUMIF.
*
* Totals the values of cells that contain numbers within the list of arguments
*
* Excel Function:
* SUMIF(range, criteria, [sum_range])
*
* @Deprecated 1.17.0
*
* @see Statistical\Conditional::SUMIF()
* Use the SUMIF() method in the Statistical\Conditional class instead
*
* @param mixed $range Data values
* @param string $criteria the criteria that defines which cells will be summed
* @param mixed $sumRange
*
* @return float|string
*/
public static function SUMIF($range, $criteria, $sumRange = [])
{
return Statistical\Conditional::SUMIF($range, $criteria, $sumRange);
}
/**
* SUMIFS.
*
* Totals the values of cells that contain numbers within the list of arguments
*
* Excel Function:
* SUMIFS(sum_range, criteria_range1, criteria1, [criteria_range2, criteria2], ...)
*
* @Deprecated 1.17.0
*
* @see Statistical\Conditional::SUMIFS()
* Use the SUMIFS() method in the Statistical\Conditional class instead
*
* @param mixed $args Data values
*
* @return null|float|string
*/
public static function SUMIFS(...$args)
{
return Statistical\Conditional::SUMIFS(...$args);
}
/**
* SUMPRODUCT.
*
* Excel Function:
* SUMPRODUCT(value1[,value2[, ...]])
*
* @Deprecated 1.18.0
*
* @See MathTrig\Sum::product()
* Use the product method in the MathTrig\Sum class instead
*
* @param mixed ...$args Data values
*
* @return float|string The result, or a string containing an error
*/
public static function SUMPRODUCT(...$args)
{
return MathTrig\Sum::product(...$args);
}
/**
* SUMSQ.
*
* SUMSQ returns the sum of the squares of the arguments
*
* @Deprecated 1.18.0
*
* @See MathTrig\SumSquares::sumSquare()
* Use the sumSquare method in the MathTrig\SumSquares class instead
*
* Excel Function:
* SUMSQ(value1[,value2[, ...]])
*
* @param mixed ...$args Data values
*
* @return float|string
*/
public static function SUMSQ(...$args)
{
return MathTrig\SumSquares::sumSquare(...$args);
}
/**
* SUMX2MY2.
*
* @Deprecated 1.18.0
*
* @See MathTrig\SumSquares::sumXSquaredMinusYSquared()
* Use the sumXSquaredMinusYSquared method in the MathTrig\SumSquares class instead
*
* @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2
*
* @return float|string
*/
public static function SUMX2MY2($matrixData1, $matrixData2)
{
return MathTrig\SumSquares::sumXSquaredMinusYSquared($matrixData1, $matrixData2);
}
/**
* SUMX2PY2.
*
* @Deprecated 1.18.0
*
* @See MathTrig\SumSquares::sumXSquaredPlusYSquared()
* Use the sumXSquaredPlusYSquared method in the MathTrig\SumSquares class instead
*
* @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2
*
* @return float|string
*/
public static function SUMX2PY2($matrixData1, $matrixData2)
{
return MathTrig\SumSquares::sumXSquaredPlusYSquared($matrixData1, $matrixData2);
}
/**
* SUMXMY2.
*
* @Deprecated 1.18.0
*
* @See MathTrig\SumSquares::sumXMinusYSquared()
* Use the sumXMinusYSquared method in the MathTrig\SumSquares class instead
*
* @param mixed[] $matrixData1 Matrix #1
* @param mixed[] $matrixData2 Matrix #2
*
* @return float|string
*/
public static function SUMXMY2($matrixData1, $matrixData2)
{
return MathTrig\SumSquares::sumXMinusYSquared($matrixData1, $matrixData2);
}
/**
* TRUNC.
*
* Truncates value to the number of fractional digits by number_digits.
*
* @Deprecated 1.17.0
*
* @see MathTrig\Trunc::evaluate()
* Use the evaluate() method in the MathTrig\Trunc class instead
*
* @param float $value
* @param int $digits
*
* @return float|string Truncated value, or a string containing an error
*/
public static function TRUNC($value = 0, $digits = 0)
{
return MathTrig\Trunc::evaluate($value, $digits);
}
/**
* SEC.
*
* Returns the secant of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Secant::sec()
* Use the sec method in the MathTrig\Trig\Secant class instead
*
* @param float $angle Number
*
* @return float|string The secant of the angle
*/
public static function SEC($angle)
{
return MathTrig\Trig\Secant::sec($angle);
}
/**
* SECH.
*
* Returns the hyperbolic secant of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Secant::sech()
* Use the sech method in the MathTrig\Trig\Secant class instead
*
* @param float $angle Number
*
* @return float|string The hyperbolic secant of the angle
*/
public static function SECH($angle)
{
return MathTrig\Trig\Secant::sech($angle);
}
/**
* CSC.
*
* Returns the cosecant of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosecant::csc()
* Use the csc method in the MathTrig\Trig\Cosecant class instead
*
* @param float $angle Number
*
* @return float|string The cosecant of the angle
*/
public static function CSC($angle)
{
return MathTrig\Trig\Cosecant::csc($angle);
}
/**
* CSCH.
*
* Returns the hyperbolic cosecant of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosecant::csch()
* Use the csch method in the MathTrig\Trig\Cosecant class instead
*
* @param float $angle Number
*
* @return float|string The hyperbolic cosecant of the angle
*/
public static function CSCH($angle)
{
return MathTrig\Trig\Cosecant::csch($angle);
}
/**
* COT.
*
* Returns the cotangent of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cotangent::cot()
* Use the cot method in the MathTrig\Trig\Cotangent class instead
*
* @param float $angle Number
*
* @return float|string The cotangent of the angle
*/
public static function COT($angle)
{
return MathTrig\Trig\Cotangent::cot($angle);
}
/**
* COTH.
*
* Returns the hyperbolic cotangent of an angle.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cotangent::coth()
* Use the coth method in the MathTrig\Trig\Cotangent class instead
*
* @param float $angle Number
*
* @return float|string The hyperbolic cotangent of the angle
*/
public static function COTH($angle)
{
return MathTrig\Trig\Cotangent::coth($angle);
}
/**
* ACOT.
*
* Returns the arccotangent of a number.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cotangent::acot()
* Use the acot method in the MathTrig\Trig\Cotangent class instead
*
* @param float $number Number
*
* @return float|string The arccotangent of the number
*/
public static function ACOT($number)
{
return MathTrig\Trig\Cotangent::acot($number);
}
/**
* Return NAN or value depending on argument.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Helpers::numberOrNan()
* Use the numberOrNan method in the MathTrig\Helpers class instead
*
* @param float $result Number
*
* @return float|string
*/
public static function numberOrNan($result)
{
return MathTrig\Helpers::numberOrNan($result);
}
/**
* ACOTH.
*
* Returns the hyperbolic arccotangent of a number.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cotangent::acoth()
* Use the acoth method in the MathTrig\Trig\Cotangent class instead
*
* @param float $number Number
*
* @return float|string The hyperbolic arccotangent of the number
*/
public static function ACOTH($number)
{
return MathTrig\Trig\Cotangent::acoth($number);
}
/**
* ROUND.
*
* Returns the result of builtin function round after validating args.
*
* @Deprecated 1.17.0
*
* @See MathTrig\Round::round()
* Use the round() method in the MathTrig\Round class instead
*
* @param mixed $number Should be numeric
* @param mixed $precision Should be int
*
* @return float|string Rounded number
*/
public static function builtinROUND($number, $precision)
{
return MathTrig\Round::round($number, $precision);
}
/**
* ABS.
*
* Returns the result of builtin function abs after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Absolute::evaluate()
* Use the evaluate method in the MathTrig\Absolute class instead
*
* @param mixed $number Should be numeric
*
* @return float|int|string Rounded number
*/
public static function builtinABS($number)
{
return MathTrig\Absolute::evaluate($number);
}
/**
* ACOS.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosine::acos()
* Use the acos method in the MathTrig\Trig\Cosine class instead
*
* Returns the result of builtin function acos after validating args.
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinACOS($number)
{
return MathTrig\Trig\Cosine::acos($number);
}
/**
* ACOSH.
*
* Returns the result of builtin function acosh after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosine::acosh()
* Use the acosh method in the MathTrig\Trig\Cosine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinACOSH($number)
{
return MathTrig\Trig\Cosine::acosh($number);
}
/**
* ASIN.
*
* Returns the result of builtin function asin after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Sine::asin()
* Use the asin method in the MathTrig\Trig\Sine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinASIN($number)
{
return MathTrig\Trig\Sine::asin($number);
}
/**
* ASINH.
*
* Returns the result of builtin function asinh after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Sine::asinh()
* Use the asinh method in the MathTrig\Trig\Sine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinASINH($number)
{
return MathTrig\Trig\Sine::asinh($number);
}
/**
* ATAN.
*
* Returns the result of builtin function atan after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Tangent::atan()
* Use the atan method in the MathTrig\Trig\Tangent class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinATAN($number)
{
return MathTrig\Trig\Tangent::atan($number);
}
/**
* ATANH.
*
* Returns the result of builtin function atanh after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Tangent::atanh()
* Use the atanh method in the MathTrig\Trig\Tangent class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinATANH($number)
{
return MathTrig\Trig\Tangent::atanh($number);
}
/**
* COS.
*
* Returns the result of builtin function cos after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosine::cos()
* Use the cos method in the MathTrig\Trig\Cosine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinCOS($number)
{
return MathTrig\Trig\Cosine::cos($number);
}
/**
* COSH.
*
* Returns the result of builtin function cos after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Cosine::cosh()
* Use the cosh method in the MathTrig\Trig\Cosine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinCOSH($number)
{
return MathTrig\Trig\Cosine::cosh($number);
}
/**
* DEGREES.
*
* Returns the result of builtin function rad2deg after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Angle::toDegrees()
* Use the toDegrees method in the MathTrig\Angle class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinDEGREES($number)
{
return MathTrig\Angle::toDegrees($number);
}
/**
* EXP.
*
* Returns the result of builtin function exp after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Exp::evaluate()
* Use the evaluate method in the MathTrig\Exp class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinEXP($number)
{
return MathTrig\Exp::evaluate($number);
}
/**
* LN.
*
* Returns the result of builtin function log after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Logarithms::natural()
* Use the natural method in the MathTrig\Logarithms class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinLN($number)
{
return MathTrig\Logarithms::natural($number);
}
/**
* LOG10.
*
* Returns the result of builtin function log after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Logarithms::base10()
* Use the natural method in the MathTrig\Logarithms class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinLOG10($number)
{
return MathTrig\Logarithms::base10($number);
}
/**
* RADIANS.
*
* Returns the result of builtin function deg2rad after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Angle::toRadians()
* Use the toRadians method in the MathTrig\Angle class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinRADIANS($number)
{
return MathTrig\Angle::toRadians($number);
}
/**
* SIN.
*
* Returns the result of builtin function sin after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Sine::evaluate()
* Use the sin method in the MathTrig\Trig\Sine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string sine
*/
public static function builtinSIN($number)
{
return MathTrig\Trig\Sine::sin($number);
}
/**
* SINH.
*
* Returns the result of builtin function sinh after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Sine::sinh()
* Use the sinh method in the MathTrig\Trig\Sine class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinSINH($number)
{
return MathTrig\Trig\Sine::sinh($number);
}
/**
* SQRT.
*
* Returns the result of builtin function sqrt after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Sqrt::sqrt()
* Use the sqrt method in the MathTrig\Sqrt class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinSQRT($number)
{
return MathTrig\Sqrt::sqrt($number);
}
/**
* TAN.
*
* Returns the result of builtin function tan after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Tangent::tan()
* Use the tan method in the MathTrig\Trig\Tangent class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinTAN($number)
{
return MathTrig\Trig\Tangent::tan($number);
}
/**
* TANH.
*
* Returns the result of builtin function sinh after validating args.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Trig\Tangent::tanh()
* Use the tanh method in the MathTrig\Trig\Tangent class instead
*
* @param mixed $number Should be numeric
*
* @return float|string Rounded number
*/
public static function builtinTANH($number)
{
return MathTrig\Trig\Tangent::tanh($number);
}
/**
* Many functions accept null/false/true argument treated as 0/0/1.
*
* @Deprecated 1.18.0
*
* @See MathTrig\Helpers::validateNumericNullBool()
* Use the validateNumericNullBool method in the MathTrig\Helpers class instead
*
* @param mixed $number
*/
public static function nullFalseTrueToNumber(&$number): void
{
$number = Functions::flattenSingleValue($number);
if ($number === null) {
$number = 0;
} elseif (is_bool($number)) {
$number = (int) $number;
}
}
}