From 68f6b97171f1d1fac3c040c445e810e88ede11a6 Mon Sep 17 00:00:00 2001 From: Hartmut Holzgraefe Date: Sat, 31 Mar 2007 10:43:52 +0000 Subject: [PATCH] whitespace git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@233013 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/math/functions/abs.xml | 52 ++++----- reference/math/functions/acos.xml | 54 ++++----- reference/math/functions/acosh.xml | 52 ++++----- reference/math/functions/asin.xml | 54 ++++----- reference/math/functions/asinh.xml | 52 ++++----- reference/math/functions/atan.xml | 54 ++++----- reference/math/functions/atan2.xml | 60 +++++----- reference/math/functions/atanh.xml | 52 ++++----- reference/math/functions/base-convert.xml | 94 +++++++-------- reference/math/functions/bindec.xml | 82 ++++++------- reference/math/functions/ceil.xml | 64 +++++----- reference/math/functions/cos.xml | 64 +++++----- reference/math/functions/cosh.xml | 50 ++++---- reference/math/functions/decbin.xml | 70 +++++------ reference/math/functions/dechex.xml | 70 +++++------ reference/math/functions/decoct.xml | 70 +++++------ reference/math/functions/deg2rad.xml | 60 +++++----- reference/math/functions/exp.xml | 76 ++++++------ reference/math/functions/expm1.xml | 60 +++++----- reference/math/functions/floor.xml | 64 +++++----- reference/math/functions/fmod.xml | 64 +++++----- reference/math/functions/getrandmax.xml | 44 +++---- reference/math/functions/hexdec.xml | 76 ++++++------ reference/math/functions/hypot.xml | 48 ++++---- reference/math/functions/is-finite.xml | 44 +++---- reference/math/functions/is-infinite.xml | 46 ++++---- reference/math/functions/is-nan.xml | 44 +++---- reference/math/functions/lcg-value.xml | 40 +++---- reference/math/functions/log.xml | 72 ++++++------ reference/math/functions/log10.xml | 42 +++---- reference/math/functions/log1p.xml | 56 ++++----- reference/math/functions/max.xml | 104 ++++++++--------- reference/math/functions/min.xml | 104 ++++++++--------- reference/math/functions/mt-getrandmax.xml | 48 ++++---- reference/math/functions/mt-rand.xml | 118 +++++++++---------- reference/math/functions/mt-srand.xml | 72 ++++++------ reference/math/functions/octdec.xml | 78 ++++++------- reference/math/functions/pi.xml | 58 ++++----- reference/math/functions/pow.xml | 96 +++++++-------- reference/math/functions/rad2deg.xml | 60 +++++----- reference/math/functions/rand.xml | 116 +++++++++--------- reference/math/functions/round.xml | 130 ++++++++++----------- reference/math/functions/sin.xml | 64 +++++----- reference/math/functions/sinh.xml | 50 ++++---- reference/math/functions/sqrt.xml | 54 ++++----- reference/math/functions/srand.xml | 70 +++++------ reference/math/functions/tan.xml | 64 +++++----- reference/math/functions/tanh.xml | 50 ++++---- 48 files changed, 1583 insertions(+), 1583 deletions(-) diff --git a/reference/math/functions/abs.xml b/reference/math/functions/abs.xml index 6d6413d1c7..51a0a5d10b 100644 --- a/reference/math/functions/abs.xml +++ b/reference/math/functions/abs.xml @@ -1,27 +1,27 @@ - + - - - abs - Absolute value - - - Description - - numberabs - mixednumber - - - Returns the absolute value of number. If the - argument number is - of type float, the return type is also float, - otherwise it is integer (as float usually has a - bigger value range than integer). - - - <function>abs</function> example - + + + abs + Absolute value + + + Description + + numberabs + mixednumber + + + Returns the absolute value of number. If the + argument number is + of type float, the return type is also float, + otherwise it is integer (as float usually has a + bigger value range than integer). + + + <function>abs</function> example + ]]> - - - - + + + + + - - - acos - Arc cosine - - - Description - - floatacos - floatarg - - - Returns the arc cosine of arg in radians. - acos is the complementary function of - cos, which means that - a==cos(acos(a)) for every value of a that is within - acos' range. - - - See also: - acosh, - asin, and - atan. - - - + + + acos + Arc cosine + + + Description + + floatacos + floatarg + + + Returns the arc cosine of arg in radians. + acos is the complementary function of + cos, which means that + a==cos(acos(a)) for every value of a that is within + acos' range. + + + See also: + acosh, + asin, and + atan. + + + + - - - acosh - Inverse hyperbolic cosine - - - Description - - floatacosh - floatarg - - - Returns the inverse hyperbolic cosine of - arg, i.e. the value whose - hyperbolic cosine is arg. - - ¬e.no-windows; - - See also: - acos, - asinh, and - atanh. - - - + + + acosh + Inverse hyperbolic cosine + + + Description + + floatacosh + floatarg + + + Returns the inverse hyperbolic cosine of + arg, i.e. the value whose + hyperbolic cosine is arg. + + ¬e.no-windows; + + See also: + acos, + asinh, and + atanh. + + + + - - - asin - Arc sine - - - Description - - floatasin - floatarg - - - Returns the arc sine of arg in radians. - asin is the complementary function of - sin, which means that - a==sin(asin(a)) for every value of a that is within - asin's range. - - - See also: - asinh, - acos, and - atan. - - - + + + asin + Arc sine + + + Description + + floatasin + floatarg + + + Returns the arc sine of arg in radians. + asin is the complementary function of + sin, which means that + a==sin(asin(a)) for every value of a that is within + asin's range. + + + See also: + asinh, + acos, and + atan. + + + + - - - asinh - Inverse hyperbolic sine - - - Description - - floatasinh - floatarg - - - Returns the inverse hyperbolic sine of - arg, i.e. the value whose - hyperbolic sine is arg. - - ¬e.no-windows; - - See also: - asin, - acosh, and - atanh. - - - + + + asinh + Inverse hyperbolic sine + + + Description + + floatasinh + floatarg + + + Returns the inverse hyperbolic sine of + arg, i.e. the value whose + hyperbolic sine is arg. + + ¬e.no-windows; + + See also: + asin, + acosh, and + atanh. + + + + - - - atan - Arc tangent - - - Description - - floatatan - floatarg - - - Returns the arc tangent of arg in radians. - atan is the complementary function of - tan, which means that - a==tan(atan(a)) for every value of a that is within - atan's range. - - - See also: - atanh, - asin, and - acos. - - - + + + atan + Arc tangent + + + Description + + floatatan + floatarg + + + Returns the arc tangent of arg in radians. + atan is the complementary function of + tan, which means that + a==tan(atan(a)) for every value of a that is within + atan's range. + + + See also: + atanh, + asin, and + acos. + + + + - - - atan2 - Arc tangent of two variables - - - Description - - floatatan2 - floaty - floatx - - - 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 function returns the result in radians, which is between -PI - and PI (inclusive). - - - See also acos and atan. - - - + + + atan2 + Arc tangent of two variables + + + Description + + floatatan2 + floaty + floatx + + + 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 function returns the result in radians, which is between -PI + and PI (inclusive). + + + See also acos and atan. + + + + - - - atanh - Inverse hyperbolic tangent - - - Description - - floatatanh - floatarg - - - Returns the inverse hyperbolic tangent of - arg, i.e. the value whose - hyperbolic tangent is arg. - - ¬e.no-windows; - - See also: - atan, - asinh, and - acosh. - - - + + + atanh + Inverse hyperbolic tangent + + + Description + + floatatanh + floatarg + + + Returns the inverse hyperbolic tangent of + arg, i.e. the value whose + hyperbolic tangent is arg. + + ¬e.no-windows; + + See also: + atan, + asinh, and + acosh. + + + + - - - base_convert - Convert a number between arbitrary bases - - - Description - - stringbase_convert - stringnumber - intfrombase - inttobase - - - Returns a string containing number - represented in base tobase. The base in - which number is given is specified in - frombase. Both - frombase and tobase - have to be between 2 and 36, inclusive. Digits in numbers with a - base higher than 10 will be represented with the letters a-z, - with a meaning 10, b meaning 11 and z meaning 35. - - <function>base_convert</function> example - + + + base_convert + Convert a number between arbitrary bases + + + Description + + stringbase_convert + stringnumber + intfrombase + inttobase + + + Returns a string containing number + represented in base tobase. The base in + which number is given is specified in + frombase. Both + frombase and tobase + have to be between 2 and 36, inclusive. Digits in numbers with a + base higher than 10 will be represented with the letters a-z, + with a meaning 10, b meaning 11 and z meaning 35. + + <function>base_convert</function> example + ]]> - - - Outputs: - - + + + Outputs: + + - - - - - - base_convert may lose precision on large numbers - due to properties related to the internal "double" or "float" type used. - Please see the Floating point numbers - section in the manual for more specific information and limitations. - - - - See also: intval. - - - + + + + + + base_convert may lose precision on large numbers + due to properties related to the internal "double" or "float" type used. + Please see the Floating point numbers + section in the manual for more specific information and limitations. + + + + See also: intval. + + + + - - - bindec - Binary to decimal - - - Description - - numberbindec - stringbinary_string - - - Returns the decimal equivalent of the binary number represented by - the binary_string argument. - - - bindec converts a binary number to an - integer. The largest number that can be converted is - 31 bits of 1's or 2147483647 in decimal. - As of PHP 4.1.0, this function can also convert larger numbers. It returns - float in that case. - - - - <function>bindec</function> example - + + + bindec + Binary to decimal + + + Description + + numberbindec + stringbinary_string + + + Returns the decimal equivalent of the binary number represented by + the binary_string argument. + + + bindec converts a binary number to an + integer. The largest number that can be converted is + 31 bits of 1's or 2147483647 in decimal. + As of PHP 4.1.0, this function can also convert larger numbers. It returns + float in that case. + + + + <function>bindec</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also decbin, - octdec, - hexdec and - base_convert. - - - + + + + + See also decbin, + octdec, + hexdec and + base_convert. + + + + - - - ceil - Round fractions up - - - Description - - floatceil - floatvalue - - - Returns the next highest integer value by rounding up - value if necessary. - The return value of ceil is still of type - float as the value range of float is - usually bigger than that of integer. - - - - <function>ceil</function> example - + + + ceil + Round fractions up + + + Description + + floatceil + floatvalue + + + Returns the next highest integer value by rounding up + value if necessary. + The return value of ceil is still of type + float as the value range of float is + usually bigger than that of integer. + + + + <function>ceil</function> example + ]]> - - - - - See also floor and - round. - - - + + + + + See also floor and + round. + + + + - - - cos - Cosine - - - Description - - floatcos - floatarg - - - cos returns the cosine of the arg - parameter. The arg parameter is in radians. - - - - <function>cos</function> example - + + + cos + Cosine + + + Description + + floatcos + floatarg + + + cos returns the cosine of the arg + parameter. The arg parameter is in radians. + + + + <function>cos</function> example + ]]> - - - - - See also: - acos, - sin, - tan, and - deg2rad. - - - + + + + + See also: + acos, + sin, + tan, and + deg2rad. + + + + - - - cosh - Hyperbolic cosine - - - Description - - floatcosh - floatarg - - - Returns the hyperbolic cosine of arg, - defined as (exp(arg) + exp(-arg))/2. - - - See also: - cos, - acosh, - sin, and - tan. - - - + + + cosh + Hyperbolic cosine + + + Description + + floatcosh + floatarg + + + Returns the hyperbolic cosine of arg, + defined as (exp(arg) + exp(-arg))/2. + + + See also: + cos, + acosh, + sin, and + tan. + + + + - - - decbin - Decimal to binary - - - Description - - stringdecbin - intnumber - - - Returns a string containing a binary representation of the given - number argument. The largest number that can be converted is - 4294967295 in decimal resulting to a string of 32 1's. - - - - <function>decbin</function> example - + + + decbin + Decimal to binary + + + Description + + stringdecbin + intnumber + + + Returns a string containing a binary representation of the given + number argument. The largest number that can be converted is + 4294967295 in decimal resulting to a string of 32 1's. + + + + <function>decbin</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also bindec, - decoct, - dechex and - base_convert. - - - + + + + + See also bindec, + decoct, + dechex and + base_convert. + + + + - - - dechex - Decimal to hexadecimal - - - Description - - stringdechex - intnumber - - - Returns a string containing a hexadecimal representation of the - given number argument. The largest number that can - be converted is 4294967295 in decimal resulting to "ffffffff". - - - - <function>dechex</function> example - + + + dechex + Decimal to hexadecimal + + + Description + + stringdechex + intnumber + + + Returns a string containing a hexadecimal representation of the + given number argument. The largest number that can + be converted is 4294967295 in decimal resulting to "ffffffff". + + + + <function>dechex</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also hexdec, - decbin, - decoct and - base_convert. - - - + + + + + See also hexdec, + decbin, + decoct and + base_convert. + + + + - - - decoct - Decimal to octal - - - Description - - stringdecoct - intnumber - - - Returns a string containing an octal representation of the given - number argument. The largest number that can be converted is - 4294967295 in decimal resulting to "37777777777". - - - - <function>decoct</function> example - + + + decoct + Decimal to octal + + + Description + + stringdecoct + intnumber + + + Returns a string containing an octal representation of the given + number argument. The largest number that can be converted is + 4294967295 in decimal resulting to "37777777777". + + + + <function>decoct</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also octdec, - decbin, - dechex and - base_convert. - - - + + + + + See also octdec, + decbin, + dechex and + base_convert. + + + + - - - deg2rad - - Converts the number in degrees to the radian equivalent - - - - Description - - floatdeg2rad - floatnumber - - - This function converts number from degrees - to the radian equivalent. - - - - <function>deg2rad</function> example - + + + deg2rad + + Converts the number in degrees to the radian equivalent + + + + Description + + floatdeg2rad + floatnumber + + + This function converts number from degrees + to the radian equivalent. + + + + <function>deg2rad</function> example + ]]> - - - - - See also rad2deg. - - - + + + + + See also rad2deg. + + + + - - - exp - Calculates the exponent of e - - - Description - - floatexp - floatarg - - - Returns e raised to the power of arg. - - - - 'e' is the base of the natural system of logarithms, or approximately - 2.718282. - - - - - <function>exp</function> example - + + + exp + Calculates the exponent of e + + + Description + + floatexp + floatarg + + + Returns e raised to the power of arg. + + + + 'e' is the base of the natural system of logarithms, or approximately + 2.718282. + + + + + <function>exp</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also - log and - pow. - - - + + + + + See also + log and + pow. + + + + - - - expm1 - - Returns exp(number) - 1, computed in a way that is accurate even - when the value of number is close to zero - - - - Description - - floatexpm1 - floatnumber - - &warn.experimental.func; - - expm1 returns the equivalent to - 'exp(number) - 1' computed in a way that is - accurate even if the value of number is near zero, - a case where 'exp (number) - 1' would be - inaccurate due to subtraction of two numbers that are nearly equal. - - ¬e.no-windows; - - See also log1p and - exp. - - - + + + expm1 + + Returns exp(number) - 1, computed in a way that is accurate even + when the value of number is close to zero + + + + Description + + floatexpm1 + floatnumber + + &warn.experimental.func; + + expm1 returns the equivalent to + 'exp(number) - 1' computed in a way that is + accurate even if the value of number is near zero, + a case where 'exp (number) - 1' would be + inaccurate due to subtraction of two numbers that are nearly equal. + + ¬e.no-windows; + + See also log1p and + exp. + + + + - - - floor - Round fractions down - - - Description - - floatfloor - floatvalue - - - Returns the next lowest integer value by rounding down - value if necessary. - The return value of floor is still of type - float because the value range of float is - usually bigger than that of integer. - - - - <function>floor</function> example - + + + floor + Round fractions down + + + Description + + floatfloor + floatvalue + + + Returns the next lowest integer value by rounding down + value if necessary. + The return value of floor is still of type + float because the value range of float is + usually bigger than that of integer. + + + + <function>floor</function> example + ]]> - - - - - See also ceil and - round. - - - + + + + + See also ceil and + round. + + + - - - fmod - Returns the floating point remainder (modulo) of the division - of the arguments - - - Description - - floatfmod - floatx - floaty - - - Returns the floating point remainder of dividing the dividend - (x) by the divisor (y). - The reminder (r) is defined as: x = i * y + r, for - some integer i. If y is - non-zero, r has the same sign as - x and a magnitude less than the magnitude of - y. - - - - Using <function>fmod</function> - + + + + fmod + Returns the floating point remainder (modulo) of the division + of the arguments + + + Description + + floatfmod + floatx + floaty + + + Returns the floating point remainder of dividing the dividend + (x) by the divisor (y). + The reminder (r) is defined as: x = i * y + r, for + some integer i. If y is + non-zero, r has the same sign as + x and a magnitude less than the magnitude of + y. + + + + Using <function>fmod</function> + ]]> - - - - - + + + + + + - - - getrandmax - Show largest possible random value - - - Description - - intgetrandmax - - - - Returns the maximum value that can be returned by a call to - rand. - - - See also rand, srand - and mt_getrandmax. - - - + + + getrandmax + Show largest possible random value + + + Description + + intgetrandmax + + + + Returns the maximum value that can be returned by a call to + rand. + + + See also rand, srand + and mt_getrandmax. + + + + - - - hexdec - Hexadecimal to decimal - - - Description - - numberhexdec - stringhex_string - - - Returns the decimal equivalent of the hexadecimal number - represented by the hex_string argument. - hexdec converts a hexadecimal string to a - decimal number. The largest number that can be converted is - 7fffffff or 2147483647 in decimal. - As of PHP 4.1.0, this function can also convert larger numbers. It returns - float in that case. - - - hexdec will ignore any non-hexadecimal - characters it encounters. - - <function>hexdec</function> example - + + + hexdec + Hexadecimal to decimal + + + Description + + numberhexdec + stringhex_string + + + Returns the decimal equivalent of the hexadecimal number + represented by the hex_string argument. + hexdec converts a hexadecimal string to a + decimal number. The largest number that can be converted is + 7fffffff or 2147483647 in decimal. + As of PHP 4.1.0, this function can also convert larger numbers. It returns + float in that case. + + + hexdec will ignore any non-hexadecimal + characters it encounters. + + <function>hexdec</function> example + ]]> - - - - - See also dechex, - bindec, - octdec and - base_convert. - - - + + + + + See also dechex, + bindec, + octdec and + base_convert. + + + + - - - hypot - - Calculate the length of the hypotenuse of a right-angle triangle - - - - Description - - floathypot - floatx - floaty - - - hypot returns the length of the hypotenuse of a - right-angle triangle with sides of length x and - y, or the distance of the point - (x, y) from the origin. - This is equivalent to sqrt(x*x + y*y). - - - + + + hypot + + Calculate the length of the hypotenuse of a right-angle triangle + + + + Description + + floathypot + floatx + floaty + + + hypot returns the length of the hypotenuse of a + right-angle triangle with sides of length x and + y, or the distance of the point + (x, y) from the origin. + This is equivalent to sqrt(x*x + y*y). + + + + - - - is_finite - Finds whether a value is a legal finite number - - - Description - - boolis_finite - floatval - - - Returns &true; if val is a legal finite - number within the allowed range for a PHP float on this platform. - - - See also is_infinite and - is_nan. - - - + + + is_finite + Finds whether a value is a legal finite number + + + Description + + boolis_finite + floatval + + + Returns &true; if val is a legal finite + number within the allowed range for a PHP float on this platform. + + + See also is_infinite and + is_nan. + + + + - - - is_infinite - Finds whether a value is infinite - - - Description - - boolis_infinite - floatval - - - Returns &true; if val is infinite (positive or - negative), like the result of log(0) or any value too - big to fit into a float on this platform. - - - See also is_finite and - is_nan. - - - + + + is_infinite + Finds whether a value is infinite + + + Description + + boolis_infinite + floatval + + + Returns &true; if val is infinite (positive or + negative), like the result of log(0) or any value too + big to fit into a float on this platform. + + + See also is_finite and + is_nan. + + + + - - - is_nan - Finds whether a value is not a number - - - Description - - boolis_nan - floatval - - - Returns &true; if val is 'not a number', - like the result of acos(1.01). - - - See also is_finite and - is_infinite. - - - + + + is_nan + Finds whether a value is not a number + + + Description + + boolis_nan + floatval + + + Returns &true; if val is 'not a number', + like the result of acos(1.01). + + + See also is_finite and + is_infinite. + + + + - - - lcg_value - Combined linear congruential generator - - - Description - - floatlcg_value - - - - lcg_value returns a pseudo random number in - the range of (0, 1). The function combines two CGs with periods - of 2^31 - 85 and 2^31 - 249. The period of this function is equal - to the product of both primes. - - - + + + lcg_value + Combined linear congruential generator + + + Description + + floatlcg_value + + + + lcg_value returns a pseudo random number in + the range of (0, 1). The function combines two CGs with periods + of 2^31 - 85 and 2^31 - 249. The period of this function is equal + to the product of both primes. + + + + - - - log - Natural logarithm - - - Description - - floatlog - floatarg - floatbase - - - If the optional base parameter is specified, - log returns logbase - arg, otherwise log - returns the natural logarithm of arg. - - - - The base parameter became available - with PHP 4.3.0. - - - As always you can calculate the logarithm in base b - of a number n, but using the mathematical identity: - logb(n) = log(n)/log(b), where log is the - neperian (or natural) logarithm. - - - - See also exp. - - - + + + log + Natural logarithm + + + Description + + floatlog + floatarg + floatbase + + + If the optional base parameter is specified, + log returns logbase + arg, otherwise log + returns the natural logarithm of arg. + + + + The base parameter became available + with PHP 4.3.0. + + + As always you can calculate the logarithm in base b + of a number n, but using the mathematical identity: + logb(n) = log(n)/log(b), where log is the + neperian (or natural) logarithm. + + + + See also exp. + + + + - - - log10 - Base-10 logarithm - - - Description - - floatlog10 - floatarg - - - Returns the base-10 logarithm of arg. - - - See Also: - log - - - + + + log10 + Base-10 logarithm + + + Description + + floatlog10 + floatarg + + + Returns the base-10 logarithm of arg. + + + See Also: + log + + + + - - - log1p - - Returns log(1 + number), computed in a way that is accurate even when - the value of number is close to zero - - - - Description - - floatlog1p - floatnumber - - &warn.experimental.func; - - log1p returns log(1 + - number) computed in a way that is accurante even - when the value of number is close to zero. - - ¬e.no-windows; - - See also expm1 and - log. - - - + + + log1p + + Returns log(1 + number), computed in a way that is accurate even when + the value of number is close to zero + + + + Description + + floatlog1p + floatnumber + + &warn.experimental.func; + + log1p returns log(1 + + number) computed in a way that is accurante even + when the value of number is close to zero. + + ¬e.no-windows; + + See also expm1 and + log. + + + + - - - max - Find highest value - - - Description - - mixedmax - numberarg1 - numberarg2 - number... - - - mixedmax - arraynumbers - - - max returns the numerically highest of the - parameter values. - - - If the first and only parameter is an array, max - returns the highest value in that array. If the first parameter - is an integer, string or float, you need at least two parameters - and max returns the biggest of these values. - You can compare an unlimited number of values. - - - - PHP will evaluate a non-numeric string as - 0, but still return the string if it's seen as the - numerically highest value. If multiple arguments evaluate to - 0, max will return a numeric - 0 if given, else the alphabetical highest string - value will be returned. - - - - - Example uses of <function>max</function> - + + + max + Find highest value + + + Description + + mixedmax + numberarg1 + numberarg2 + number... + + + mixedmax + arraynumbers + + + max returns the numerically highest of the + parameter values. + + + If the first and only parameter is an array, max + returns the highest value in that array. If the first parameter + is an integer, string or float, you need at least two parameters + and max returns the biggest of these values. + You can compare an unlimited number of values. + + + + PHP will evaluate a non-numeric string as + 0, but still return the string if it's seen as the + numerically highest value. If multiple arguments evaluate to + 0, max will return a numeric + 0 if given, else the alphabetical highest string + value will be returned. + + + + + Example uses of <function>max</function> + ]]> - - - - - See also min and - count. - - - + + + + + See also min and + count. + + + + - - - min - Find lowest value - - - Description - - mixedmin - numberarg1 - numberarg2 - number... - - - mixedmin - arraynumbers - - - min returns the numerically lowest of the - parameter values. - - - If the first and only parameter is an array, min - returns the lowest value in that array. If the first parameter - is an integer, string or float, you need at least two parameters - and min returns the smallest of these values. - You can compare an unlimited number of values. - - - - PHP will evaluate a non-numeric string as - 0, but still return the string if it's seen as the - numerically lowest value. If multiple arguments evaluate to - 0, min will return the lowest - alphanumerical string value if any strings are given, else a numeric - 0 is returned. - - - - - Example uses of <function>min</function> - + + + min + Find lowest value + + + Description + + mixedmin + numberarg1 + numberarg2 + number... + + + mixedmin + arraynumbers + + + min returns the numerically lowest of the + parameter values. + + + If the first and only parameter is an array, min + returns the lowest value in that array. If the first parameter + is an integer, string or float, you need at least two parameters + and min returns the smallest of these values. + You can compare an unlimited number of values. + + + + PHP will evaluate a non-numeric string as + 0, but still return the string if it's seen as the + numerically lowest value. If multiple arguments evaluate to + 0, min will return the lowest + alphanumerical string value if any strings are given, else a numeric + 0 is returned. + + + + + Example uses of <function>min</function> + ]]> - - - - - See also max and - count. - - - + + + + + See also max and + count. + + + + - - - mt_getrandmax - Show largest possible random value - - - Description - - intmt_getrandmax - - - - Returns the maximum value that can be returned by a call to - mt_rand. - - - See also: - mt_rand, - mt_srand, and - getrandmax. - - - + + + mt_getrandmax + Show largest possible random value + + + Description + + intmt_getrandmax + + + + Returns the maximum value that can be returned by a call to + mt_rand. + + + See also: + mt_rand, + mt_srand, and + getrandmax. + + + + - - - mt_rand - Generate a better random value - - - Description - - intmt_rand - intmin - intmax - - - Many random number generators of older libcs have dubious or - unknown characteristics and are slow. By default, PHP uses the - libc random number generator with the rand - function. The mt_rand function is a drop-in - replacement for this. It uses a random number generator with - known characteristics using the - Mersenne Twister, which will produce random numbers four times - faster than what the average libc rand() provides. - - - If called without the optional min, - max arguments mt_rand - returns a pseudo-random value between 0 and - RAND_MAX. If you want a random number - between 5 and 15 (inclusive), for example, use mt_rand - (5, 15). - - - - <function>mt_rand</function> example - + + + mt_rand + Generate a better random value + + + Description + + intmt_rand + intmin + intmax + + + Many random number generators of older libcs have dubious or + unknown characteristics and are slow. By default, PHP uses the + libc random number generator with the rand + function. The mt_rand function is a drop-in + replacement for this. It uses a random number generator with + known characteristics using the + Mersenne Twister, which will produce random numbers four times + faster than what the average libc rand() provides. + + + If called without the optional min, + max arguments mt_rand + returns a pseudo-random value between 0 and + RAND_MAX. If you want a random number + between 5 and 15 (inclusive), for example, use mt_rand + (5, 15). + + + + <function>mt_rand</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - ¬e.randomseed; + + + + ¬e.randomseed; - - - In versions before 3.0.7 the meaning of - max was range. To - get the same results in these versions the short example should - be mt_rand (5, 11) to get a random number - between 5 and 15. - - - - See also: - mt_srand, - mt_getrandmax, and - rand. - - - + + + In versions before 3.0.7 the meaning of + max was range. To + get the same results in these versions the short example should + be mt_rand (5, 11) to get a random number + between 5 and 15. + + + + See also: + mt_srand, + mt_getrandmax, and + rand. + + + + - - - mt_srand - Seed the better random number generator - - - Description - - voidmt_srand - intseed - - - Seeds the random number generator with - seed. - Since PHP 4.2.0, the seed - becomes optional and defaults to a random value if omitted. - - - - <function>mt_srand</function> example - + + + mt_srand + Seed the better random number generator + + + Description + + voidmt_srand + intseed + + + Seeds the random number generator with + seed. + Since PHP 4.2.0, the seed + becomes optional and defaults to a random value if omitted. + + + + <function>mt_srand</function> example + ]]> - - - + + + - ¬e.randomseed; + ¬e.randomseed; - - See also: - mt_rand, - mt_getrandmax, and - srand. - - - + + See also: + mt_rand, + mt_getrandmax, and + srand. + + + + - - - octdec - Octal to decimal - - - Description - - numberoctdec - stringoctal_string - - - Returns the decimal equivalent of the octal number - represented by the octal_string argument. - The largest number that can be converted is 17777777777 or 2147483647 in - decimal. - As of PHP 4.1.0, this function can also convert larger numbers. It returns - float in that case. - - - - <function>octdec</function> example - + + + octdec + Octal to decimal + + + Description + + numberoctdec + stringoctal_string + + + Returns the decimal equivalent of the octal number + represented by the octal_string argument. + The largest number that can be converted is 17777777777 or 2147483647 in + decimal. + As of PHP 4.1.0, this function can also convert larger numbers. It returns + float in that case. + + + + <function>octdec</function> example + ]]> - - &example.outputs; - + + &example.outputs; + - - - - - See also: - decoct, - bindec, - hexdec, and - base_convert. - - - + + + + + See also: + decoct, + bindec, + hexdec, and + base_convert. + + + + - - - pi - Get value of pi - - - Description - - floatpi - - - - Returns an approximation of pi. The returned float - has a precision based on the - precision directive in - &php.ini;, which defaults to 14. - Also, you can use the M_PI constant which yields - identical results to pi. - - - - <function>pi</function> example - + + + pi + Get value of pi + + + Description + + floatpi + + + + Returns an approximation of pi. The returned float + has a precision based on the + precision directive in + &php.ini;, which defaults to 14. + Also, you can use the M_PI constant which yields + identical results to pi. + + + + <function>pi</function> example + ]]> - - - - - + + + + + + - - - pow - Exponential expression - - - Description - - numberpow - numberbase - numberexp - - - Returns base raised to the power of - exp. If possible, this function will - return an integer. - - - If the power cannot be computed, a warning will be issued, - and pow will return &false;. Since PHP 4.2.0 - pow doesn't issue any warning. - - - - PHP cannot handle negative exps. - - - - Some examples of <function>pow</function> - + + + pow + Exponential expression + + + Description + + numberpow + numberbase + numberexp + + + Returns base raised to the power of + exp. If possible, this function will + return an integer. + + + If the power cannot be computed, a warning will be issued, + and pow will return &false;. Since PHP 4.2.0 + pow doesn't issue any warning. + + + + PHP cannot handle negative exps. + + + + Some examples of <function>pow</function> + ]]> - - - - - In PHP 4.0.6 and earlier pow always returned - a float, and did not issue warnings. - - - - See also: - exp, - sqrt, - bcpow, and - gmp_pow, - - - + + + + + In PHP 4.0.6 and earlier pow always returned + a float, and did not issue warnings. + + + + See also: + exp, + sqrt, + bcpow, and + gmp_pow, + + + + - - - rad2deg - - Converts the radian number to the equivalent number in degrees - - - - Description - - floatrad2deg - floatnumber - - - This function converts number from radian - to degrees. - - - - <function>rad2deg</function> example - + + + rad2deg + + Converts the radian number to the equivalent number in degrees + + + + Description + + floatrad2deg + floatnumber + + + This function converts number from radian + to degrees. + + + + <function>rad2deg</function> example + ]]> - - - - - See also deg2rad. - - - + + + + + See also deg2rad. + + + + - - - rand - Generate a random integer - - - Description - - intrand - intmin - intmax - - - If called without the optional min, - max arguments rand - returns a pseudo-random integer between 0 and - RAND_MAX. If you want a random number - between 5 and 15 (inclusive), for example, use rand (5, - 15). - - - - <function>rand</function> example - + + + rand + Generate a random integer + + + Description + + intrand + intmin + intmax + + + If called without the optional min, + max arguments rand + returns a pseudo-random integer between 0 and + RAND_MAX. If you want a random number + between 5 and 15 (inclusive), for example, use rand (5, + 15). + + + + <function>rand</function> example + ]]> - - &example.outputs.similar; - + + &example.outputs.similar; + - - - - - - On some platforms (such as Windows) RAND_MAX - is only 32768. If you require a range larger than 32768, specifying - min and max will allow - you to create a range larger than RAND_MAX, or consider using - mt_rand instead. - - + + + + + + On some platforms (such as Windows) RAND_MAX + is only 32768. If you require a range larger than 32768, specifying + min and max will allow + you to create a range larger than RAND_MAX, or consider using + mt_rand instead. + + - ¬e.randomseed; + ¬e.randomseed; - - - In versions before 3.0.7 the meaning of - max was range. To - get the same results in these versions the short example should - be rand (5, 11) to get a random number - between 5 and 15. - - - - See also: - srand, - getrandmax, and - mt_rand. - - - + + + In versions before 3.0.7 the meaning of + max was range. To + get the same results in these versions the short example should + be rand (5, 11) to get a random number + between 5 and 15. + + + + See also: + srand, + getrandmax, and + mt_rand. + + + + - - - round - Rounds a float - - - Description - - floatround - floatval - intprecision - - - Returns the rounded value of val to - specified precision - (number of digits after the decimal point). - precision can also be negative or zero (default). - - - - <function>round</function> examples - + + + round + Rounds a float + + + Description + + floatround + floatval + intprecision + + + Returns the rounded value of val to + specified precision + (number of digits after the decimal point). + precision can also be negative or zero (default). + + + + <function>round</function> examples + ]]> - - - - - - - - PHP doesn't handle strings like "12,300.2" correctly - by default. See converting from strings. - - - - - - - The precision parameter was introduced - in PHP 4. - - - + + + + + + + + PHP doesn't handle strings like "12,300.2" correctly + by default. See converting from strings. + + + + + + + The precision parameter was introduced + in PHP 4. + + + + + See also: + ceil, + floor, and + number_format. + + + + - - - sin - Sine - - - Description - - floatsin - floatarg - - - sin returns the sine of the arg - parameter. The arg parameter is in radians. - - - - <function>sin</function> example - + + + sin + Sine + + + Description + + floatsin + floatarg + + + sin returns the sine of the arg + parameter. The arg parameter is in radians. + + + + <function>sin</function> example + ]]> - - - - - See also: - asin, - cos, - tan, and - deg2rad. - - - + + + + + See also: + asin, + cos, + tan, and + deg2rad. + + + + - - - sinh - Hyperbolic sine - - - Description - - floatsinh - floatarg - - - Returns the hyperbolic sine of arg, - defined as (exp(arg) - exp(-arg))/2. - - - See also: - sin, - asinh, - cos, and - tan. - - - + + + sinh + Hyperbolic sine + + + Description + + floatsinh + floatarg + + + Returns the hyperbolic sine of arg, + defined as (exp(arg) - exp(-arg))/2. + + + See also: + sin, + asinh, + cos, and + tan. + + + + - - - sqrt - Square root - - - Description - - floatsqrt - floatarg - - - Returns the square root of arg. - - - - <function>sqrt</function> example - + + + sqrt + Square root + + + Description + + floatsqrt + floatarg + + + Returns the square root of arg. + + + + <function>sqrt</function> example + ]]> - - - - - See also pow. - - - + + + + + See also pow. + + + + - - - srand - Seed the random number generator - - - Description - - voidsrand - intseed - - - Seeds the random number generator with seed. - Since PHP 4.2.0, the seed - becomes optional and defaults to a random value if omitted. - - - - <function>srand</function> example - + + + srand + Seed the random number generator + + + Description + + voidsrand + intseed + + + Seeds the random number generator with seed. + Since PHP 4.2.0, the seed + becomes optional and defaults to a random value if omitted. + + + + <function>srand</function> example + ]]> - - - + + + - ¬e.randomseed; + ¬e.randomseed; - - See also: - rand, - getrandmax, and - mt_srand. - - - + + See also: + rand, + getrandmax, and + mt_srand. + + + + - - - tan - Tangent - - - Description - - floattan - floatarg - - - tan returns the tangent of the arg - parameter. The arg parameter is in radians. - - - - <function>tan</function> example - + + + tan + Tangent + + + Description + + floattan + floatarg + + + tan returns the tangent of the arg + parameter. The arg parameter is in radians. + + + + <function>tan</function> example + ]]> - - - - - See also: - atan, - sin, - cos, and - deg2rad. - - - + + + + + See also: + atan, + sin, + cos, and + deg2rad. + + + + - - - tanh - Hyperbolic tangent - - - Description - - floattanh - floatarg - - - Returns the hyperbolic tangent of arg, - defined as sinh(arg)/cosh(arg). - - - See also: - tan, - atanh, - sin, and - cos. - - - + + + tanh + Hyperbolic tangent + + + Description + + floattanh + floatarg + + + Returns the hyperbolic tangent of arg, + defined as sinh(arg)/cosh(arg). + + + See also: + tan, + atanh, + sin, and + cos. + + +