From 83c82b47afbe0cc4ecf550b528447352e63c2bb7 Mon Sep 17 00:00:00 2001 From: Hartmut Holzgraefe Date: Sat, 31 Mar 2007 11:20:55 +0000 Subject: [PATCH] moving towards new structure (work-in-progress commit as i'm about to change machines, will finish soon) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@233015 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/math/functions/abs.xml | 43 +++++++++++++++++----- reference/math/functions/acos.xml | 41 +++++++++++++++++---- reference/math/functions/acosh.xml | 41 +++++++++++++++++---- reference/math/functions/asin.xml | 41 +++++++++++++++++---- reference/math/functions/asinh.xml | 42 +++++++++++++++++++-- reference/math/functions/atan.xml | 42 +++++++++++++++++++-- reference/math/functions/atan2.xml | 42 +++++++++++++++++++-- reference/math/functions/atanh.xml | 42 +++++++++++++++++++-- reference/math/functions/base-convert.xml | 42 +++++++++++++++++++-- reference/math/functions/bindec.xml | 42 +++++++++++++++++++-- reference/math/functions/ceil.xml | 42 +++++++++++++++++++-- reference/math/functions/cos.xml | 42 +++++++++++++++++++-- reference/math/functions/cosh.xml | 42 +++++++++++++++++++-- reference/math/functions/decbin.xml | 42 +++++++++++++++++++-- reference/math/functions/dechex.xml | 42 +++++++++++++++++++-- reference/math/functions/decoct.xml | 42 +++++++++++++++++++-- reference/math/functions/deg2rad.xml | 42 +++++++++++++++++++-- reference/math/functions/exp.xml | 42 +++++++++++++++++++-- reference/math/functions/expm1.xml | 42 +++++++++++++++++++-- reference/math/functions/floor.xml | 42 +++++++++++++++++++-- reference/math/functions/fmod.xml | 41 +++++++++++++++++++-- reference/math/functions/getrandmax.xml | 42 +++++++++++++++++++-- reference/math/functions/hexdec.xml | 42 +++++++++++++++++++-- reference/math/functions/hypot.xml | 42 +++++++++++++++++++-- reference/math/functions/is-finite.xml | 42 +++++++++++++++++++-- reference/math/functions/is-infinite.xml | 42 +++++++++++++++++++-- reference/math/functions/is-nan.xml | 42 +++++++++++++++++++-- reference/math/functions/lcg-value.xml | 42 +++++++++++++++++++-- reference/math/functions/log.xml | 42 +++++++++++++++++++-- reference/math/functions/log10.xml | 42 +++++++++++++++++++-- reference/math/functions/log1p.xml | 42 +++++++++++++++++++-- reference/math/functions/max.xml | 42 +++++++++++++++++++-- reference/math/functions/min.xml | 42 +++++++++++++++++++-- reference/math/functions/mt-getrandmax.xml | 42 +++++++++++++++++++-- reference/math/functions/mt-rand.xml | 42 +++++++++++++++++++-- reference/math/functions/mt-srand.xml | 42 +++++++++++++++++++-- reference/math/functions/octdec.xml | 42 +++++++++++++++++++-- reference/math/functions/pi.xml | 42 +++++++++++++++++++-- reference/math/functions/pow.xml | 42 +++++++++++++++++++-- reference/math/functions/rad2deg.xml | 42 +++++++++++++++++++-- reference/math/functions/rand.xml | 42 +++++++++++++++++++-- reference/math/functions/round.xml | 42 +++++++++++++++++++-- reference/math/functions/sin.xml | 42 +++++++++++++++++++-- reference/math/functions/sinh.xml | 42 +++++++++++++++++++-- reference/math/functions/sqrt.xml | 42 +++++++++++++++++++-- reference/math/functions/srand.xml | 42 +++++++++++++++++++-- reference/math/functions/tan.xml | 42 +++++++++++++++++++-- reference/math/functions/tanh.xml | 42 +++++++++++++++++++-- 48 files changed, 1805 insertions(+), 208 deletions(-) diff --git a/reference/math/functions/abs.xml b/reference/math/functions/abs.xml index 51a0a5d10b..ded03a598a 100644 --- a/reference/math/functions/abs.xml +++ b/reference/math/functions/abs.xml @@ -1,13 +1,12 @@ - - + abs Absolute value - - Description + + &reftitle.description; numberabs mixednumber @@ -19,9 +18,34 @@ otherwise it is integer (as float usually has a bigger value range than integer). - - <function>abs</function> example - + + + &reftitle.parameters; + + + + number + + + The numeric value to process + + + + + + + + &reftitle.returnvalues; + + The absoulte value of number + + + + &reftitle.examples; + + + <function>abs</function> example + ]]> - - + + + diff --git a/reference/math/functions/acos.xml b/reference/math/functions/acos.xml index 037e50aed2..93248709b1 100644 --- a/reference/math/functions/acos.xml +++ b/reference/math/functions/acos.xml @@ -1,13 +1,12 @@ - - + acos Arc cosine - - Description + + &reftitle.description; floatacos floatarg @@ -19,11 +18,37 @@ a==cos(acos(a)) for every value of a that is within acos' range. + + + &reftitle.parameters; - See also: - acosh, - asin, and - atan. + + + arg + + + The argument to process + + + + + + + + &reftitle.returnvalues; + + The arc consine of arg + + + + &reftitle.seealso; + + + cos + acosh + asin + atan + diff --git a/reference/math/functions/acosh.xml b/reference/math/functions/acosh.xml index 5626bd67f1..29bd54fad3 100644 --- a/reference/math/functions/acosh.xml +++ b/reference/math/functions/acosh.xml @@ -1,13 +1,12 @@ - - + acosh Inverse hyperbolic cosine - - Description + + &reftitle.description; floatacosh floatarg @@ -18,11 +17,37 @@ hyperbolic cosine is arg. ¬e.no-windows; + + + &reftitle.parameters; - See also: - acos, - asinh, and - atanh. + + + arg + + + The value to process + + + + + + + + &reftitle.returnvalues; + + The inverse hyperbolic cosine of arg + + + + &reftitle.seealso; + + + cosh + acos + asinh + atanh + diff --git a/reference/math/functions/asin.xml b/reference/math/functions/asin.xml index 892472ef71..4583282687 100644 --- a/reference/math/functions/asin.xml +++ b/reference/math/functions/asin.xml @@ -1,13 +1,12 @@ - - + asin Arc sine - - Description + + &reftitle.description; floatasin floatarg @@ -19,11 +18,37 @@ a==sin(asin(a)) for every value of a that is within asin's range. + + + &reftitle.parameters; - See also: - asinh, - acos, and - atan. + + + arg + + + The argument to process + + + + + + + + &reftitle.returnvalues; + + The arc sine of arg + + + + &reftitle.seealso; + + + sin + asinh + acos + atan + diff --git a/reference/math/functions/asinh.xml b/reference/math/functions/asinh.xml index 42602b5322..309f135606 100644 --- a/reference/math/functions/asinh.xml +++ b/reference/math/functions/asinh.xml @@ -1,13 +1,12 @@ - - + asinh Inverse hyperbolic sine - - Description + + &reftitle.description; floatasinh floatarg @@ -25,6 +24,41 @@ atanh. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + atan Arc tangent - - Description + + &reftitle.description; floatatan floatarg @@ -26,6 +25,41 @@ acos. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + atan2 Arc tangent of two variables - - Description + + &reftitle.description; floatatan2 floaty @@ -29,6 +28,41 @@ See also acos and atan. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + atanh Inverse hyperbolic tangent - - Description + + &reftitle.description; floatatanh floatarg @@ -25,6 +24,41 @@ acosh. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + base_convert Convert a number between arbitrary bases - - Description + + &reftitle.description; stringbase_convert stringnumber @@ -55,6 +54,41 @@ echo base_convert($hexadecimal, 16, 2); See also: intval. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + bindec Binary to decimal - - Description + + &reftitle.description; numberbindec stringbinary_string @@ -53,6 +52,41 @@ echo bindec('111'); base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + ceil Round fractions up - - Description + + &reftitle.description; floatceil floatvalue @@ -38,6 +37,41 @@ echo ceil(-3.14); // -3 round. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + cos Cosine - - Description + + &reftitle.description; floatcos floatarg @@ -38,6 +37,41 @@ echo cos(M_PI); // -1 deg2rad. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + cosh Hyperbolic cosine - - Description + + &reftitle.description; floatcosh floatarg @@ -24,6 +23,41 @@ tan. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + decbin Decimal to binary - - Description + + &reftitle.description; stringdecbin intnumber @@ -44,6 +43,41 @@ echo decbin(26); base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + dechex Decimal to hexadecimal - - Description + + &reftitle.description; stringdechex intnumber @@ -44,6 +43,41 @@ a base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + decoct Decimal to octal - - Description + + &reftitle.description; stringdecoct intnumber @@ -44,6 +43,41 @@ echo decoct(264); base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + deg2rad @@ -8,8 +7,8 @@ Converts the number in degrees to the radian equivalent - - Description + + &reftitle.description; floatdeg2rad floatnumber @@ -37,6 +36,41 @@ var_dump(deg2rad(45) === M_PI_4); // bool(true) See also rad2deg. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + exp Calculates the exponent of e - - Description + + &reftitle.description; floatexp floatarg @@ -47,6 +46,41 @@ echo exp(5.7); pow. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + expm1 @@ -9,8 +8,8 @@ when the value of number is close to zero - - Description + + &reftitle.description; floatexpm1 floatnumber @@ -29,6 +28,41 @@ exp. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + floor Round fractions down - - Description + + &reftitle.description; floatfloor floatvalue @@ -38,6 +37,41 @@ echo floor(-3.14); // -4 round. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + + fmod Returns the floating point remainder (modulo) of the division of the arguments - - Description + + &reftitle.description; floatfmod floatx @@ -38,6 +38,41 @@ $r = fmod($x, $y); + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + getrandmax Show largest possible random value - - Description + + &reftitle.description; intgetrandmax @@ -21,6 +20,41 @@ and mt_getrandmax. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + hexdec Hexadecimal to decimal - - Description + + &reftitle.description; numberhexdec stringhex_string @@ -47,6 +46,41 @@ var_dump(hexdec("a0")); // print "int(160)" base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + hypot @@ -8,8 +7,8 @@ Calculate the length of the hypotenuse of a right-angle triangle - - Description + + &reftitle.description; floathypot floatx @@ -23,6 +22,41 @@ This is equivalent to sqrt(x*x + y*y). + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + is_finite Finds whether a value is a legal finite number - - Description + + &reftitle.description; boolis_finite floatval @@ -21,6 +20,41 @@ is_nan. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + is_infinite Finds whether a value is infinite - - Description + + &reftitle.description; boolis_infinite floatval @@ -22,6 +21,41 @@ is_nan. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + is_nan Finds whether a value is not a number - - Description + + &reftitle.description; boolis_nan floatval @@ -21,6 +20,41 @@ is_infinite. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + lcg_value Combined linear congruential generator - - Description + + &reftitle.description; floatlcg_value @@ -19,6 +18,41 @@ to the product of both primes. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + log Natural logarithm - - Description + + &reftitle.description; floatlog floatarg @@ -35,6 +34,41 @@ See also exp. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + log10 Base-10 logarithm - - Description + + &reftitle.description; floatlog10 floatarg @@ -20,6 +19,41 @@ log + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + log1p @@ -9,8 +8,8 @@ the value of number is close to zero - - Description + + &reftitle.description; floatlog1p floatnumber @@ -27,6 +26,41 @@ log. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + max Find highest value - - Description + + &reftitle.description; mixedmax numberarg1 @@ -69,6 +68,41 @@ $val = max('string', array(2, 5, 7), 42); // array(2, 5, 7) count. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + min Find lowest value - - Description + + &reftitle.description; mixedmin numberarg1 @@ -69,6 +68,41 @@ $val = min('string', array(2, 5, 7), 42); // string count. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + mt_getrandmax Show largest possible random value - - Description + + &reftitle.description; intmt_getrandmax @@ -23,6 +22,41 @@ getrandmax. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + mt_rand Generate a better random value - - Description + + &reftitle.description; intmt_rand intmin @@ -72,6 +71,41 @@ echo mt_rand(5, 15); rand. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + mt_srand Seed the better random number generator - - Description + + &reftitle.description; voidmt_srand intseed @@ -47,6 +46,41 @@ $randval = mt_rand(); srand. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + octdec Octal to decimal - - Description + + &reftitle.description; numberoctdec stringoctal_string @@ -48,6 +47,41 @@ echo octdec(decoct(45)); base_convert. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + pi Get value of pi - - Description + + &reftitle.description; floatpi @@ -34,6 +33,41 @@ echo M_PI; // 3.1415926535898 + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + pow Exponential expression - - Description + + &reftitle.description; numberpow numberbase @@ -58,6 +57,41 @@ echo pow(-1, 5.5); // error gmp_pow, + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + rad2deg @@ -8,8 +7,8 @@ Converts the radian number to the equivalent number in degrees - - Description + + &reftitle.description; floatrad2deg floatnumber @@ -36,6 +35,41 @@ echo rad2deg(M_PI_4); // 45 See also deg2rad. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + rand Generate a random integer - - Description + + &reftitle.description; intrand intmin @@ -72,6 +71,41 @@ echo rand(5, 15); mt_rand. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + round Rounds a float - - Description + + &reftitle.description; floatround floatval @@ -78,6 +77,41 @@ echo round(5.055, 2); // 5.06 number_format. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + sin Sine - - Description + + &reftitle.description; floatsin floatarg @@ -40,6 +39,41 @@ echo sin(60); // -0.304810621 ... deg2rad. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + sinh Hyperbolic sine - - Description + + &reftitle.description; floatsinh floatarg @@ -24,6 +23,41 @@ tan. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + sqrt Square root - - Description + + &reftitle.description; floatsqrt floatarg @@ -33,6 +32,41 @@ echo sqrt(10); // 3.16227766 ... See also pow. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + srand Seed the random number generator - - Description + + &reftitle.description; voidsrand intseed @@ -46,6 +45,41 @@ $randval = rand(); mt_srand. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + tan Tangent - - Description + + &reftitle.description; floattan floatarg @@ -38,6 +37,41 @@ echo tan(M_PI_4); // 1 deg2rad. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + + - + tanh Hyperbolic tangent - - Description + + &reftitle.description; floattanh floatarg @@ -24,6 +23,41 @@ cos. + + &reftitle.parameters; + + + + + + + + + + + + + + + &reftitle.returnvalues; + + + + + + &reftitle.examples; + + + + + + &reftitle.seealso; + + + + + +