Collaboration diagram for PhpOffice\PhpSpreadsheet\Calculation\MathTrig:

Static Public Member Functions
static	ARABIC ($roman)
	ARABIC. More...

static	ATAN2 ($xCoordinate=null, $yCoordinate=null)
	ATAN2. More...

static	BASE ($number, $radix, $minLength=null)
	BASE. More...

static	CEILING ($number, $significance=null)
	CEILING. More...

static	COMBIN ($numObjs, $numInSet)
	COMBIN. More...

static	EVEN ($number)
	EVEN. More...

static	getEven (float $number)
	Helper function for Even. More...

static	FACT ($factVal)
	FACT. More...

static	FACTDOUBLE ($factVal)
	FACTDOUBLE. More...

static	FLOOR ($number, $significance=null)
	FLOOR. More...

static	FLOORMATH ($number, $significance=null, $mode=0)
	FLOOR.MATH. More...

static	FLOORPRECISE ($number, $significance=1)
	FLOOR.PRECISE. More...

static	INT ($number)
	INT. More...

static	GCD (... $args)
	GCD. More...

static	LCM (... $args)
	LCM. More...

static	logBase ($number, $base=10)
	LOG_BASE. More...

static	MDETERM ($matrixValues)
	MDETERM. More...

static	MINVERSE ($matrixValues)
	MINVERSE. More...

static	MMULT ($matrixData1, $matrixData2)
	MMULT. More...

static	MOD ($a=1, $b=1)
	MOD. More...

static	MROUND ($number, $multiple)
	MROUND. More...

static	MULTINOMIAL (... $args)
	MULTINOMIAL. More...

static	ODD ($number)
	ODD. More...

static	POWER ($x=0, $y=2)
	POWER. More...

static	PRODUCT (... $args)
	PRODUCT. More...

static	QUOTIENT ($numerator, $denominator)
	QUOTIENT. More...

static	RAND ($min=0, $max=0)
	RAND/RANDBETWEEN. More...

static	ROMAN ($aValue, $style=0)
	ROMAN. More...

static	ROUNDUP ($number, $digits)
	ROUNDUP. More...

static	ROUNDDOWN ($number, $digits)
	ROUNDDOWN. More...

static	SERIESSUM ($x, $n, $m,... $args)
	SERIESSUM. More...

static	SIGN ($number)
	SIGN. More...

static	returnSign (float $number)
	returnSign = returns 0/-1/+1. More...

static	SQRTPI ($number)
	SQRTPI. More...

static	SUBTOTAL ($functionType,... $args)
	SUBTOTAL. More...

static	SUM (... $args)
	SUM. More...

static	SUMIF ($range, $criteria, $sumRange=[])
	SUMIF. More...

static	SUMIFS (... $args)
	SUMIFS. More...

static	SUMPRODUCT (... $args)
	SUMPRODUCT. More...

static	SUMSQ (... $args)
	SUMSQ. More...

static	SUMX2MY2 ($matrixData1, $matrixData2)
	SUMX2MY2. More...

static	SUMX2PY2 ($matrixData1, $matrixData2)
	SUMX2PY2. More...

static	SUMXMY2 ($matrixData1, $matrixData2)
	SUMXMY2. More...

static	TRUNC ($value=0, $digits=0)
	TRUNC. More...

static	SEC ($angle)
	SEC. More...

static	SECH ($angle)
	SECH. More...

static	CSC ($angle)
	CSC. More...

static	CSCH ($angle)
	CSCH. More...

static	COT ($angle)
	COT. More...

static	COTH ($angle)
	COTH. More...

static	ACOT ($number)
	ACOT. More...

static	numberOrNan ($result)
	Return NAN or value depending on argument. More...

static	ACOTH ($number)
	ACOTH. More...

static	builtinROUND ($number, $precision)
	ROUND. More...

static	builtinABS ($number)
	ABS. More...

static	builtinACOS ($number)
	ACOS. More...

static	builtinACOSH ($number)
	ACOSH. More...

static	builtinASIN ($number)
	ASIN. More...

static	builtinASINH ($number)
	ASINH. More...

static	builtinATAN ($number)
	ATAN. More...

static	builtinATANH ($number)
	ATANH. More...

static	builtinCOS ($number)
	COS. More...

static	builtinCOSH ($number)
	COSH. More...

static	builtinDEGREES ($number)
	DEGREES. More...

static	builtinEXP ($number)
	EXP. More...

static	builtinLN ($number)
	LN. More...

static	builtinLOG10 ($number)
	LOG10. More...

static	builtinRADIANS ($number)
	RADIANS. More...

static	builtinSIN ($number)
	SIN. More...

static	builtinSINH ($number)
	SINH. More...

static	builtinSQRT ($number)
	SQRT. More...

static	builtinTAN ($number)
	TAN. More...

static	builtinTANH ($number)
	TANH. More...

static	nullFalseTrueToNumber (&$number)
	Many functions accept null/false/true argument treated as 0/0/1. More...

Detailed Description

Deprecated:: 1.18.0

Definition at line 8 of file MathTrig.php.

Member Function Documentation

◆ ACOT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ACOT ( $number )

static

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

Parameters

float $number Number

Returns: float|string The arccotangent of the number

Definition at line 1079 of file MathTrig.php.

    {
        return MathTrig\Trig\Cotangent::acot($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cotangent\acot().

Here is the call graph for this function:

◆ ACOTH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ACOTH ( $number )

static

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

Parameters

float $number Number

Returns: float|string The hyperbolic arccotangent of the number

Definition at line 1115 of file MathTrig.php.

    {
        return MathTrig\Trig\Cotangent::acoth($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cotangent\acoth().

Here is the call graph for this function:

◆ ARABIC()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ARABIC ( $roman )

static

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

Parameters

string $roman

Returns: int|string the arabic numberal contrived from the roman numeral

Definition at line 27 of file MathTrig.php.

    {
        return MathTrig\Arabic::evaluate($roman);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Arabic\evaluate().

Here is the call graph for this function:

◆ ATAN2()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ATAN2	(	$xCoordinate = `null`,
		$yCoordinate = `null`
	)

static

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

Parameters

float	$xCoordinate	the x-coordinate of the point
float	$yCoordinate	the y-coordinate of the point

Returns: float|string the inverse tangent of the specified x- and y-coordinates, or a string containing an error

Definition at line 58 of file MathTrig.php.

    {
        return MathTrig\Trig\Tangent::atan2($xCoordinate, $yCoordinate);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Tangent\atan2().

Here is the call graph for this function:

◆ BASE()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::BASE	(	$number,
		$radix,
		$minLength = `null`
	)

static

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

Parameters

float	$number
float	$radix
int	$minLength

Returns: string the text representation with the given radix (base)

Definition at line 82 of file MathTrig.php.

    {
        return MathTrig\Base::evaluate($number, $radix, $minLength);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Base\evaluate().

Here is the call graph for this function:

◆ builtinABS()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinABS ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|int|string Rounded number

Definition at line 1154 of file MathTrig.php.

    {
        return MathTrig\Absolute::evaluate($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Absolute\evaluate().

Here is the call graph for this function:

◆ builtinACOS()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinACOS ( $number )

static

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.

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1173 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosine::acos($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosine\acos().

Here is the call graph for this function:

◆ builtinACOSH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinACOSH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1192 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosine::acosh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosine\acosh().

Here is the call graph for this function:

◆ builtinASIN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinASIN ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1211 of file MathTrig.php.

    {
        return MathTrig\Trig\Sine::asin($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Sine\asin().

Here is the call graph for this function:

◆ builtinASINH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinASINH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1230 of file MathTrig.php.

    {
        return MathTrig\Trig\Sine::asinh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Sine\asinh().

Here is the call graph for this function:

◆ builtinATAN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinATAN ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1249 of file MathTrig.php.

    {
        return MathTrig\Trig\Tangent::atan($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Tangent\atan().

Here is the call graph for this function:

◆ builtinATANH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinATANH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1268 of file MathTrig.php.

    {
        return MathTrig\Trig\Tangent::atanh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Tangent\atanh().

Here is the call graph for this function:

◆ builtinCOS()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinCOS ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1287 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosine::cos($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosine\cos().

Here is the call graph for this function:

◆ builtinCOSH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinCOSH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1306 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosine::cosh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosine\cosh().

Here is the call graph for this function:

◆ builtinDEGREES()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinDEGREES ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1325 of file MathTrig.php.

    {
        return MathTrig\Angle::toDegrees($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Angle\toDegrees().

Here is the call graph for this function:

◆ builtinEXP()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinEXP ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1344 of file MathTrig.php.

    {
        return MathTrig\Exp::evaluate($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Exp\evaluate().

Here is the call graph for this function:

◆ builtinLN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinLN ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1363 of file MathTrig.php.

    {
        return MathTrig\Logarithms::natural($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Logarithms\natural().

Here is the call graph for this function:

◆ builtinLOG10()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinLOG10 ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1382 of file MathTrig.php.

    {
        return MathTrig\Logarithms::base10($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Logarithms\base10().

Here is the call graph for this function:

◆ builtinRADIANS()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinRADIANS ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1401 of file MathTrig.php.

    {
        return MathTrig\Angle::toRadians($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Angle\toRadians().

Here is the call graph for this function:

◆ builtinROUND()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinROUND	(	$number,
		$precision
	)

static

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

Parameters

mixed	$number	Should be numeric
mixed	$precision	Should be int

Returns: float|string Rounded number

Definition at line 1135 of file MathTrig.php.

    {
        return MathTrig\Round::round($number, $precision);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\round().

Here is the call graph for this function:

◆ builtinSIN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinSIN ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string sine

Definition at line 1420 of file MathTrig.php.

    {
        return MathTrig\Trig\Sine::sin($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Sine\sin().

Here is the call graph for this function:

◆ builtinSINH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinSINH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1439 of file MathTrig.php.

    {
        return MathTrig\Trig\Sine::sinh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Sine\sinh().

Here is the call graph for this function:

◆ builtinSQRT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinSQRT ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1458 of file MathTrig.php.

    {
        return MathTrig\Sqrt::sqrt($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sqrt\sqrt().

Here is the call graph for this function:

◆ builtinTAN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinTAN ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1477 of file MathTrig.php.

    {
        return MathTrig\Trig\Tangent::tan($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Tangent\tan().

Here is the call graph for this function:

◆ builtinTANH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::builtinTANH ( $number )

static

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

Parameters

mixed $number Should be numeric

Returns: float|string Rounded number

Definition at line 1496 of file MathTrig.php.

    {
        return MathTrig\Trig\Tangent::tanh($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Tangent\tanh().

Here is the call graph for this function:

◆ CEILING()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::CEILING	(	$number,
		$significance = `null`
	)

static

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

Parameters

float	$number	the number you want to round
float	$significance	the multiple to which you want to round

Returns: float|string Rounded Number, or a string containing an error

See also: MathTrig\Ceiling::ceiling() Use the ceiling() method in the MathTrig\Ceiling class instead

Definition at line 108 of file MathTrig.php.

    {
        return MathTrig\Ceiling::ceiling($number, $significance);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Ceiling\ceiling().

Here is the call graph for this function:

◆ COMBIN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::COMBIN	(	$numObjs,
		$numInSet
	)

static

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 also: MathTrig\Combinations::withoutRepetition() Use the withoutRepetition() method in the MathTrig\Combinations class instead

Parameters

int	$numObjs	Number of different objects
int	$numInSet	Number of objects in each combination

Returns: float|int|string Number of combinations, or a string containing an error

Definition at line 132 of file MathTrig.php.

    {
        return MathTrig\Combinations::withoutRepetition($numObjs, $numInSet);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Combinations\withoutRepetition().

Here is the call graph for this function:

◆ COT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::COT ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The cotangent of the angle

Definition at line 1041 of file MathTrig.php.

    {
        return MathTrig\Trig\Cotangent::cot($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cotangent\cot().

Here is the call graph for this function:

◆ COTH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::COTH ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The hyperbolic cotangent of the angle

Definition at line 1060 of file MathTrig.php.

    {
        return MathTrig\Trig\Cotangent::coth($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cotangent\coth().

Here is the call graph for this function:

◆ CSC()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::CSC ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The cosecant of the angle

Definition at line 1003 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosecant::csc($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosecant\csc().

Here is the call graph for this function:

◆ CSCH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::CSCH ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The hyperbolic cosecant of the angle

Definition at line 1022 of file MathTrig.php.

    {
        return MathTrig\Trig\Cosecant::csch($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Cosecant\csch().

Here is the call graph for this function:

◆ EVEN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::EVEN ( $number )

static

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 also: MathTrig\Round::even() Use the even() method in the MathTrig\Round class instead

Parameters

float $number Number to round

Returns: float|int|string Rounded Number, or a string containing an error

Definition at line 158 of file MathTrig.php.

    {
        return MathTrig\Round::even($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\even().

Here is the call graph for this function:

◆ FACT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACT ( $factVal )

static

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

Parameters

float $factVal Factorial Value

Returns: float|int|string Factorial, or a string containing an error

See also: MathTrig\Factorial::fact() Use the fact() method in the MathTrig\Factorial class instead

Definition at line 194 of file MathTrig.php.

    {
        return MathTrig\Factorial::fact($factVal);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Factorial\fact().

Here is the call graph for this function:

◆ FACTDOUBLE()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FACTDOUBLE ( $factVal )

static

FACTDOUBLE.

Returns the double factorial of a number.

Excel Function: FACTDOUBLE(factVal)

@Deprecated 1.18.0

Parameters

float $factVal Factorial Value

Returns: float|int|string Double Factorial, or a string containing an error

See also: MathTrig\Factorial::factDouble() Use the factDouble() method in the MathTrig\Factorial class instead

Definition at line 216 of file MathTrig.php.

    {
        return MathTrig\Factorial::factDouble($factVal);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Factorial\factDouble().

Here is the call graph for this function:

◆ FLOOR()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOOR	(	$number,
		$significance = `null`
	)

static

FLOOR.

Rounds number down, toward zero, to the nearest multiple of significance.

Excel Function: FLOOR(number[,significance])

@Deprecated 1.17.0

Parameters

float	$number	Number to round
float	$significance	Significance

Returns: float|string Rounded Number, or a string containing an error

See also: MathTrig\Floor::floor() Use the floor() method in the MathTrig\Floor class instead

Definition at line 239 of file MathTrig.php.

    {
        return MathTrig\Floor::floor($number, $significance);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Floor\floor().

Here is the call graph for this function:

◆ FLOORMATH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORMATH	(	$number,
		$significance = `null`,
		$mode = `0`
	)

static

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

Parameters

float	$number	Number to round
float	$significance	Significance
int	$mode	direction to round negative numbers

Returns: float|string Rounded Number, or a string containing an error

See also: MathTrig\Floor::math() Use the math() method in the MathTrig\Floor class instead

Definition at line 263 of file MathTrig.php.

    {
        return MathTrig\Floor::math($number, $significance, $mode);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Floor\math().

Here is the call graph for this function:

◆ FLOORPRECISE()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::FLOORPRECISE	(	$number,
		$significance = `1`
	)

static

FLOOR.PRECISE.

Rounds number down, toward zero, to the nearest multiple of significance.

Excel Function: FLOOR.PRECISE(number[,significance])

@Deprecated 1.17.0

Parameters

float	$number	Number to round
float	$significance	Significance

Returns: float|string Rounded Number, or a string containing an error

See also: MathTrig\Floor::precise() Use the precise() method in the MathTrig\Floor class instead

Definition at line 286 of file MathTrig.php.

    {
        return MathTrig\Floor::precise($number, $significance);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Floor\precise().

Here is the call graph for this function:

◆ GCD()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::GCD ( $args )

static

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 also: MathTrig\Gcd::evaluate() Use the evaluate() method in the MathTrig\Gcd class instead

Parameters

mixed ...$args Data values

Returns: int|mixed|string Greatest Common Divisor, or a string containing an error

Definition at line 332 of file MathTrig.php.

    {
        return MathTrig\Gcd::evaluate(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Gcd\evaluate().

Here is the call graph for this function:

◆ getEven()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::getEven ( float $number )

static

Helper function for Even.

@Deprecated 1.18.0

See also: MathTrig\Helpers::getEven() Use the evaluate() method in the MathTrig\Helpers class instead

Definition at line 171 of file MathTrig.php.

                                                 : int
    {
        return (int) MathTrig\Helpers::getEven($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Helpers\getEven().

Here is the call graph for this function:

◆ INT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::INT ( $number )

static

INT.

Casts a floating point value to an integer

Excel Function: INT(number)

@Deprecated 1.17.0

See also: MathTrig\IntClass::evaluate() Use the evaluate() method in the MathTrig\IntClass class instead

Parameters

float $number Number to cast to an integer

Returns: int|string Integer value, or a string containing an error

Definition at line 308 of file MathTrig.php.

    {
        return MathTrig\IntClass::evaluate($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\IntClass\evaluate().

Here is the call graph for this function:

◆ LCM()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::LCM ( $args )

static

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 also: MathTrig\Lcm::evaluate() Use the evaluate() method in the MathTrig\Lcm class instead

Parameters

mixed ...$args Data values

Returns: int|string Lowest Common Multiplier, or a string containing an error

Definition at line 357 of file MathTrig.php.

    {
        return MathTrig\Lcm::evaluate(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Lcm\evaluate().

Here is the call graph for this function:

◆ logBase()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::logBase	(	$number,
		$base = `10`
	)

static

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 also: MathTrig\Logarithms::withBase() Use the withBase() method in the MathTrig\Logarithms class instead

Parameters

float	$number	The positive real number for which you want the logarithm
float	$base	The base of the logarithm. If base is omitted, it is assumed to be 10.

Returns: float|string The result, or a string containing an error

Definition at line 380 of file MathTrig.php.

    {
        return MathTrig\Logarithms::withBase($number, $base);
    }

References $base, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Logarithms\withBase().

Here is the call graph for this function:

◆ MDETERM()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MDETERM ( $matrixValues )

static

MDETERM.

Returns the matrix determinant of an array.

Excel Function: MDETERM(array)

@Deprecated 1.18.0

See also: MathTrig\MatrixFunctions::determinant() Use the determinant() method in the MathTrig\MatrixFunctions class instead

Parameters

array $matrixValues A matrix of values

Returns: float|string The result, or a string containing an error

Definition at line 402 of file MathTrig.php.

    {
        return MathTrig\MatrixFunctions::determinant($matrixValues);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\MatrixFunctions\determinant().

Here is the call graph for this function:

◆ MINVERSE()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MINVERSE ( $matrixValues )

static

MINVERSE.

Returns the inverse matrix for the matrix stored in an array.

Excel Function: MINVERSE(array)

@Deprecated 1.18.0

See also: MathTrig\MatrixFunctions::inverse() Use the inverse() method in the MathTrig\MatrixFunctions class instead

Parameters

array $matrixValues A matrix of values

Returns: array|string The result, or a string containing an error

Definition at line 424 of file MathTrig.php.

    {
        return MathTrig\MatrixFunctions::inverse($matrixValues);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\MatrixFunctions\inverse().

Here is the call graph for this function:

◆ MMULT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MMULT	(	$matrixData1,
		$matrixData2
	)

static

MMULT.

@Deprecated 1.18.0

See also: MathTrig\MatrixFunctions::multiply() Use the multiply() method in the MathTrig\MatrixFunctions class instead

Parameters

array	$matrixData1	A matrix of values
array	$matrixData2	A matrix of values

Returns: array|string The result, or a string containing an error

Definition at line 442 of file MathTrig.php.

    {
        return MathTrig\MatrixFunctions::multiply($matrixData1, $matrixData2);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\MatrixFunctions\multiply().

Here is the call graph for this function:

◆ MOD()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MOD	(	$a = `1`,
		$b = `1`
	)

static

MOD.

@Deprecated 1.18.0

See also: MathTrig\Operations::mod() Use the mod() method in the MathTrig\Operations class instead

Parameters

int	$a	Dividend
int	$b	Divisor

Returns: float|int|string Remainder, or a string containing an error

Definition at line 460 of file MathTrig.php.

    {
        return MathTrig\Operations::mod($a, $b);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Operations\mod().

Here is the call graph for this function:

◆ MROUND()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MROUND	(	$number,
		$multiple
	)

static

MROUND.

Rounds a number to the nearest multiple of a specified value

@Deprecated 1.17.0

Parameters

float	$number	Number to round
int	$multiple	Multiple to which you want to round $number

Returns: float|string Rounded Number, or a string containing an error

See also: MathTrig\Round::multiple() Use the multiple() method in the MathTrig\Mround class instead

Definition at line 480 of file MathTrig.php.

    {
        return MathTrig\Round::multiple($number, $multiple);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\multiple().

Here is the call graph for this function:

◆ MULTINOMIAL()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::MULTINOMIAL ( $args )

static

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

Parameters

mixed[] $args An array of mixed values for the Data Series

Returns: float|string The result, or a string containing an error

Definition at line 499 of file MathTrig.php.

    {
        return MathTrig\Factorial::multinomial(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Factorial\multinomial().

Here is the call graph for this function:

◆ nullFalseTrueToNumber()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::nullFalseTrueToNumber ( & $number )

static

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

Parameters

mixed $number

Definition at line 1511 of file MathTrig.php.

                                                          : void
    {
        $number = Functions::flattenSingleValue($number);
        if ($number === null) {
            $number = 0;
        } elseif (is_bool($number)) {
            $number = (int) $number;
        }
    }

References PhpOffice\PhpSpreadsheet\Calculation\Functions\flattenSingleValue().

Here is the call graph for this function:

◆ numberOrNan()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::numberOrNan ( $result )

static

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

Parameters

float $result Number

Returns: float|string

Definition at line 1096 of file MathTrig.php.

    {
        return MathTrig\Helpers::numberOrNan($result);
    }

References $result, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Helpers\numberOrNan().

Here is the call graph for this function:

◆ ODD()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ODD ( $number )

static

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

Parameters

float $number Number to round

Returns: float|int|string Rounded Number, or a string containing an error

Definition at line 518 of file MathTrig.php.

    {
        return MathTrig\Round::odd($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\odd().

Here is the call graph for this function:

◆ POWER()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::POWER	(	$x = `0`,
		$y = `2`
	)

static

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

Parameters

float	$x
float	$y

Returns: float|int|string The result, or a string containing an error

Definition at line 538 of file MathTrig.php.

    {
        return MathTrig\Operations::power($x, $y);
    }

References $x, $y, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Operations\power().

Here is the call graph for this function:

◆ PRODUCT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::PRODUCT ( $args )

static

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[, ...]])

Parameters

mixed ...$args Data values

Returns: float|string

Definition at line 560 of file MathTrig.php.

    {
        return MathTrig\Operations::product(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Operations\product().

Here is the call graph for this function:

◆ QUOTIENT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::QUOTIENT	(	$numerator,
		$denominator
	)

static

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[, ...]])

Parameters

mixed	$numerator
mixed	$denominator

Returns: int|string

Definition at line 584 of file MathTrig.php.

    {
        return MathTrig\Operations::quotient($numerator, $denominator);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Operations\quotient().

Here is the call graph for this function:

◆ RAND()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::RAND	(	$min = `0`,
		$max = `0`
	)

static

RAND/RANDBETWEEN.

@Deprecated 1.18.0

@See MathTrig\Random::randBetween() Use the randBetween or randBetween method in the MathTrig\Random class instead

Parameters

int	$min	Minimal value
int	$max	Maximal value

Returns: float|int|string Random number

Definition at line 602 of file MathTrig.php.

    {
        return MathTrig\Random::randBetween($min, $max);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Random\randBetween().

Here is the call graph for this function:

◆ returnSign()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::returnSign ( float $number )

static

returnSign = returns 0/-1/+1.

@Deprecated 1.18.0

@See MathTrig\Helpers::returnSign() Use the returnSign method in the MathTrig\Helpers class instead

Definition at line 717 of file MathTrig.php.

                                                    : int
    {
        return MathTrig\Helpers::returnSign($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Helpers\returnSign().

Here is the call graph for this function:

◆ ROMAN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ROMAN	(	$aValue,
		$style = `0`
	)

static

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

Parameters

mixed	$aValue	Number to convert
mixed	$style	Number indicating one of five possible forms

Returns: string Roman numeral, or a string containing an error

Definition at line 622 of file MathTrig.php.

    {
        return MathTrig\Roman::evaluate($aValue, $style);
    }

References $style, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Roman\evaluate().

Here is the call graph for this function:

◆ ROUNDDOWN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ROUNDDOWN	(	$number,
		$digits
	)

static

ROUNDDOWN.

Rounds a number down to a specified number of decimal places

@Deprecated 1.17.0

@See MathTrig\Rounddown() Use the down() method in the MathTrig\Round class instead

Parameters

float	$number	Number to round
int	$digits	Number of digits to which you want to round $number

Returns: float|string Rounded Number, or a string containing an error

Definition at line 662 of file MathTrig.php.

    {
        return MathTrig\Round::down($number, $digits);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\down().

Here is the call graph for this function:

◆ ROUNDUP()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::ROUNDUP	(	$number,
		$digits
	)

static

ROUNDUP.

Rounds a number up to a specified number of decimal places

@Deprecated 1.17.0

@See MathTrig\Roundup() Use the up() method in the MathTrig\Round class instead

Parameters

float	$number	Number to round
int	$digits	Number of digits to which you want to round $number

Returns: float|string Rounded Number, or a string containing an error

Definition at line 642 of file MathTrig.php.

    {
        return MathTrig\Round::up($number, $digits);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Round\up().

Here is the call graph for this function:

◆ SEC()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SEC ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The secant of the angle

Definition at line 965 of file MathTrig.php.

    {
        return MathTrig\Trig\Secant::sec($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Secant\sec().

Here is the call graph for this function:

◆ SECH()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SECH ( $angle )

static

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

Parameters

float $angle Number

Returns: float|string The hyperbolic secant of the angle

Definition at line 984 of file MathTrig.php.

    {
        return MathTrig\Trig\Secant::sech($angle);
    }

References $angle, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trig\Secant\sech().

Here is the call graph for this function:

◆ SERIESSUM()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SERIESSUM	(	$x,
		$n,
		$m,
		$args
	)

static

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

Parameters

mixed	$x	Input value
mixed	$n	Initial power
mixed	$m	Step
mixed[]	$args	An array of coefficients for the Data Series

Returns: float|string The result, or a string containing an error

Definition at line 684 of file MathTrig.php.

    {
        return MathTrig\SeriesSum::evaluate($x, $n, $m, ...$args);
    }

References $m, $n, $x, and PhpOffice\PhpSpreadsheet\Calculation\MathTrig\SeriesSum\evaluate().

Here is the call graph for this function:

◆ SIGN()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SIGN ( $number )

static

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

Parameters

float $number Number to round

Returns: int|string sign value, or a string containing an error

Definition at line 704 of file MathTrig.php.

    {
        return MathTrig\Sign::evaluate($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sign\evaluate().

Here is the call graph for this function:

◆ SQRTPI()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SQRTPI ( $number )

static

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

Parameters

float $number Number

Returns: float|string Square Root of Number * Pi, or a string containing an error

Definition at line 736 of file MathTrig.php.

    {
        return MathTrig\Sqrt::pi($number);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sqrt\pi().

Here is the call graph for this function:

◆ SUBTOTAL()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUBTOTAL	(	$functionType,
		$args
	)

static

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

Parameters

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
mixed[]	$args	A mixed data series of values

Returns: float|string

Definition at line 762 of file MathTrig.php.

    {
        return MathTrig\Subtotal::evaluate($functionType, ...$args);
    }

◆ SUM()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUM ( $args )

static

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[, ...]])

Parameters

mixed ...$args Data values

Returns: float|string

Definition at line 784 of file MathTrig.php.

    {
        return MathTrig\Sum::sumIgnoringStrings(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sum\sumIgnoringStrings().

Here is the call graph for this function:

◆ SUMIF()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMIF	(	$range,
		$criteria,
		$sumRange = `[]`
	)

static

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 also: Statistical\Conditional::SUMIF() Use the SUMIF() method in the Statistical\Conditional class instead

Parameters

mixed	$range	Data values
string	$criteria	the criteria that defines which cells will be summed
mixed	$sumRange

Returns: float|string

Definition at line 808 of file MathTrig.php.

    {
        return Statistical\Conditional::SUMIF($range, $criteria, $sumRange);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Statistical\Conditional\SUMIF().

Here is the call graph for this function:

◆ SUMIFS()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMIFS ( $args )

static

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 also: Statistical\Conditional::SUMIFS() Use the SUMIFS() method in the Statistical\Conditional class instead

Parameters

mixed $args Data values

Returns: null|float|string

Definition at line 830 of file MathTrig.php.

    {
        return Statistical\Conditional::SUMIFS(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\Statistical\Conditional\SUMIFS().

Here is the call graph for this function:

◆ SUMPRODUCT()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMPRODUCT ( $args )

static

SUMPRODUCT.

Excel Function: SUMPRODUCT(value1[,value2[, ...]])

@Deprecated 1.18.0

@See MathTrig\Sum::product() Use the product method in the MathTrig\Sum class instead

Parameters

mixed ...$args Data values

Returns: float|string The result, or a string containing an error

Definition at line 850 of file MathTrig.php.

    {
        return MathTrig\Sum::product(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Sum\product().

Here is the call graph for this function:

◆ SUMSQ()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMSQ ( $args )

static

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[, ...]])

Parameters

mixed ...$args Data values

Returns: float|string

Definition at line 872 of file MathTrig.php.

    {
        return MathTrig\SumSquares::sumSquare(...$args);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\SumSquares\sumSquare().

Here is the call graph for this function:

◆ SUMX2MY2()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMX2MY2	(	$matrixData1,
		$matrixData2
	)

static

SUMX2MY2.

@Deprecated 1.18.0

@See MathTrig\SumSquares::sumXSquaredMinusYSquared() Use the sumXSquaredMinusYSquared method in the MathTrig\SumSquares class instead

Parameters

mixed[]	$matrixData1	Matrix #1
mixed[]	$matrixData2	Matrix #2

Returns: float|string

Definition at line 890 of file MathTrig.php.

    {
        return MathTrig\SumSquares::sumXSquaredMinusYSquared($matrixData1, $matrixData2);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\SumSquares\sumXSquaredMinusYSquared().

Here is the call graph for this function:

◆ SUMX2PY2()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMX2PY2	(	$matrixData1,
		$matrixData2
	)

static

SUMX2PY2.

@Deprecated 1.18.0

@See MathTrig\SumSquares::sumXSquaredPlusYSquared() Use the sumXSquaredPlusYSquared method in the MathTrig\SumSquares class instead

Parameters

mixed[]	$matrixData1	Matrix #1
mixed[]	$matrixData2	Matrix #2

Returns: float|string

Definition at line 908 of file MathTrig.php.

    {
        return MathTrig\SumSquares::sumXSquaredPlusYSquared($matrixData1, $matrixData2);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\SumSquares\sumXSquaredPlusYSquared().

Here is the call graph for this function:

◆ SUMXMY2()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::SUMXMY2	(	$matrixData1,
		$matrixData2
	)

static

SUMXMY2.

@Deprecated 1.18.0

@See MathTrig\SumSquares::sumXMinusYSquared() Use the sumXMinusYSquared method in the MathTrig\SumSquares class instead

Parameters

mixed[]	$matrixData1	Matrix #1
mixed[]	$matrixData2	Matrix #2

Returns: float|string

Definition at line 926 of file MathTrig.php.

    {
        return MathTrig\SumSquares::sumXMinusYSquared($matrixData1, $matrixData2);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\SumSquares\sumXMinusYSquared().

Here is the call graph for this function:

◆ TRUNC()

static PhpOffice\PhpSpreadsheet\Calculation\MathTrig::TRUNC	(	$value = `0`,
		$digits = `0`
	)

static

TRUNC.

Truncates value to the number of fractional digits by number_digits.

@Deprecated 1.17.0

See also: MathTrig\Trunc::evaluate() Use the evaluate() method in the MathTrig\Trunc class instead

Parameters

float	$value
int	$digits

Returns: float|string Truncated value, or a string containing an error

Definition at line 946 of file MathTrig.php.

    {
        return MathTrig\Trunc::evaluate($value, $digits);
    }

References PhpOffice\PhpSpreadsheet\Calculation\MathTrig\Trunc\evaluate().

Here is the call graph for this function:

The documentation for this class was generated from the following file:

libs/composer/vendor/phpoffice/phpspreadsheet/src/PhpSpreadsheet/Calculation/MathTrig.php

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ ACOT()

◆ ACOTH()

◆ ARABIC()

◆ ATAN2()

◆ BASE()

◆ builtinABS()

◆ builtinACOS()

◆ builtinACOSH()

◆ builtinASIN()

◆ builtinASINH()

◆ builtinATAN()

◆ builtinATANH()

◆ builtinCOS()

◆ builtinCOSH()

◆ builtinDEGREES()

◆ builtinEXP()

◆ builtinLN()

◆ builtinLOG10()

◆ builtinRADIANS()

◆ builtinROUND()

◆ builtinSIN()

◆ builtinSINH()

◆ builtinSQRT()

◆ builtinTAN()

◆ builtinTANH()

◆ CEILING()

◆ COMBIN()

◆ COT()

◆ COTH()

◆ CSC()

◆ CSCH()

◆ EVEN()

◆ FACT()

◆ FACTDOUBLE()

◆ FLOOR()

◆ FLOORMATH()

◆ FLOORPRECISE()

◆ GCD()

◆ getEven()

◆ INT()

◆ LCM()

◆ logBase()

◆ MDETERM()

◆ MINVERSE()

◆ MMULT()

◆ MOD()

◆ MROUND()

◆ MULTINOMIAL()

◆ nullFalseTrueToNumber()

◆ numberOrNan()

◆ ODD()

◆ POWER()

◆ PRODUCT()

◆ QUOTIENT()

◆ RAND()

◆ returnSign()

◆ ROMAN()

◆ ROUNDDOWN()

◆ ROUNDUP()

◆ SEC()

◆ SECH()

◆ SERIESSUM()

◆ SIGN()

◆ SQRTPI()

◆ SUBTOTAL()

◆ SUM()

◆ SUMIF()

◆ SUMIFS()

◆ SUMPRODUCT()

◆ SUMSQ()

◆ SUMX2MY2()

◆ SUMX2PY2()

◆ SUMXMY2()

◆ TRUNC()