| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520 |
- <?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 array|string $roman
- *
- * @return array|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 array|float $xCoordinate the x-coordinate of the point
- * @param array|float $yCoordinate the y-coordinate of the point
- *
- * @return array|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 array|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 array|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 array|int $numObjs Number of different objects
- * @param array|int $numInSet Number of objects in each combination
- *
- * @return array|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 array|float $number Number to round
- *
- * @return array|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 array|float $factVal Factorial Value
- *
- * @return array|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 array|float $factVal Factorial Value
- *
- * @return array|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 array|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 array|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 array|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 array|float $number Number to cast to an integer
- *
- * @return array|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 array|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 array|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 array|int $multiple Multiple to which you want to round $number
- *
- * @return array|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 array|float $number Number to round
- *
- * @return array|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 array|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 array|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 array|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 array|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 array|float $number Number to round
- * @param array|int $digits Number of digits to which you want to round $number
- *
- * @return array|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 array|float $number Number to round
- * @param array|int $digits Number of digits to which you want to round $number
- *
- * @return array|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 array|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 array|float $number Number to round
- *
- * @return array|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 array|float $number Number
- *
- * @return array|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 array|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 array|float $angle Number
- *
- * @return array|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 array|float $angle Number
- *
- * @return array|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 array|float $angle Number
- *
- * @return array|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 array|float $angle Number
- *
- * @return array|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 array|float $angle Number
- *
- * @return array|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 array|float $angle Number
- *
- * @return array|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 array|float $number Number
- *
- * @return array|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 array|float $number Number
- *
- * @return array|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 array|mixed $number Should be numeric
- * @param array|mixed $precision Should be int
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|float $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|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 array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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 array|mixed $number Should be numeric
- *
- * @return array|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;
- }
- }
- }
|