1@CATEGORY=Bitwise Operations 2@FUNCTION=BITAND 3@SHORTDESC=bitwise and 4@SYNTAX=BITAND(a,b) 5@ARGUMENTDESCRIPTION=@{a}: non-negative integer 6@{b}: non-negative integer 7@DESCRIPTION=BITAND returns the bitwise and of the binary representations of its arguments. 8@SEEALSO=BITOR,BITXOR 9 10@CATEGORY=Bitwise Operations 11@FUNCTION=BITLSHIFT 12@SHORTDESC=bit-shift to the left 13@SYNTAX=BITLSHIFT(a,n) 14@ARGUMENTDESCRIPTION=@{a}: non-negative integer 15@{n}: integer 16@DESCRIPTION=BITLSHIFT returns the binary representations of @{a} shifted @{n} positions to the left. 17@NOTE=If @{n} is negative, BITLSHIFT shifts the bits to the right by ABS(@{n}) positions. 18@SEEALSO=BITRSHIFT 19 20@CATEGORY=Bitwise Operations 21@FUNCTION=BITOR 22@SHORTDESC=bitwise or 23@SYNTAX=BITOR(a,b) 24@ARGUMENTDESCRIPTION=@{a}: non-negative integer 25@{b}: non-negative integer 26@DESCRIPTION=BITOR returns the bitwise or of the binary representations of its arguments. 27@SEEALSO=BITXOR,BITAND 28 29@CATEGORY=Bitwise Operations 30@FUNCTION=BITRSHIFT 31@SHORTDESC=bit-shift to the right 32@SYNTAX=BITRSHIFT(a,n) 33@ARGUMENTDESCRIPTION=@{a}: non-negative integer 34@{n}: integer 35@DESCRIPTION=BITRSHIFT returns the binary representations of @{a} shifted @{n} positions to the right. 36@NOTE=If @{n} is negative, BITRSHIFT shifts the bits to the left by ABS(@{n}) positions. 37@SEEALSO=BITLSHIFT 38 39@CATEGORY=Bitwise Operations 40@FUNCTION=BITXOR 41@SHORTDESC=bitwise exclusive or 42@SYNTAX=BITXOR(a,b) 43@ARGUMENTDESCRIPTION=@{a}: non-negative integer 44@{b}: non-negative integer 45@DESCRIPTION=BITXOR returns the bitwise exclusive or of the binary representations of its arguments. 46@SEEALSO=BITOR,BITAND 47 48@CATEGORY=Complex 49@FUNCTION=COMPLEX 50@SHORTDESC=a complex number of the form @{x} + @{y}@{i} 51@SYNTAX=COMPLEX(x,y,i) 52@ARGUMENTDESCRIPTION=@{x}: real part 53@{y}: imaginary part 54@{i}: the suffix for the complex number, either "i" or "j"; defaults to "i" 55@NOTE=If @{i} is neither "i" nor "j", COMPLEX returns #VALUE! 56@EXCEL=This function is Excel compatible. 57 58@CATEGORY=Complex 59@FUNCTION=IMABS 60@SHORTDESC=the absolute value of the complex number @{z} 61@SYNTAX=IMABS(z) 62@ARGUMENTDESCRIPTION=@{z}: a complex number 63@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 64@EXCEL=This function is Excel compatible. 65@SEEALSO=IMAGINARY,IMREAL 66 67@CATEGORY=Complex 68@FUNCTION=IMAGINARY 69@SHORTDESC=the imaginary part of the complex number @{z} 70@SYNTAX=IMAGINARY(z) 71@ARGUMENTDESCRIPTION=@{z}: a complex number 72@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 73@EXCEL=This function is Excel compatible. 74@SEEALSO=IMREAL 75 76@CATEGORY=Complex 77@FUNCTION=IMARCCOS 78@SHORTDESC=the complex arccosine of the complex number 79@SYNTAX=IMARCCOS(z) 80@ARGUMENTDESCRIPTION=@{z}: a complex number 81@DESCRIPTION=IMARCCOS returns the complex arccosine of the complex number @{z}. The branch cuts are on the real axis, less than -1 and greater than 1. 82@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 83@SEEALSO=IMARCSIN,IMARCTAN 84 85@CATEGORY=Complex 86@FUNCTION=IMARCCOSH 87@SHORTDESC=the complex hyperbolic arccosine of the complex number @{z} 88@SYNTAX=IMARCCOSH(z) 89@ARGUMENTDESCRIPTION=@{z}: a complex number 90@DESCRIPTION=IMARCCOSH returns the complex hyperbolic arccosine of the complex number @{z}. The branch cut is on the real axis, less than 1. 91@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 92@SEEALSO=IMARCSINH,IMARCTANH 93 94@CATEGORY=Complex 95@FUNCTION=IMARCCOT 96@SHORTDESC=the complex arccotangent of the complex number @{z} 97@SYNTAX=IMARCCOT(z) 98@ARGUMENTDESCRIPTION=@{z}: a complex number 99@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 100@SEEALSO=IMARCSEC,IMARCCSC 101 102@CATEGORY=Complex 103@FUNCTION=IMARCCOTH 104@SHORTDESC=the complex hyperbolic arccotangent of the complex number @{z} 105@SYNTAX=IMARCCOTH(z) 106@ARGUMENTDESCRIPTION=@{z}: a complex number 107@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 108@SEEALSO=IMARCSECH,IMARCCSCH 109 110@CATEGORY=Complex 111@FUNCTION=IMARCCSC 112@SHORTDESC=the complex arccosecant of the complex number @{z} 113@SYNTAX=IMARCCSC(z) 114@ARGUMENTDESCRIPTION=@{z}: a complex number 115@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 116@SEEALSO=IMARCSEC,IMARCCOT 117 118@CATEGORY=Complex 119@FUNCTION=IMARCCSCH 120@SHORTDESC=the complex hyperbolic arccosecant of the complex number @{z} 121@SYNTAX=IMARCCSCH(z) 122@ARGUMENTDESCRIPTION=@{z}: a complex number 123@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 124@SEEALSO=IMARCSECH,IMARCCOTH 125 126@CATEGORY=Complex 127@FUNCTION=IMARCSEC 128@SHORTDESC=the complex arcsecant of the complex number @{z} 129@SYNTAX=IMARCSEC(z) 130@ARGUMENTDESCRIPTION=@{z}: a complex number 131@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 132@SEEALSO=IMARCCSC,IMARCCOT 133 134@CATEGORY=Complex 135@FUNCTION=IMARCSECH 136@SHORTDESC=the complex hyperbolic arcsecant of the complex number @{z} 137@SYNTAX=IMARCSECH(z) 138@ARGUMENTDESCRIPTION=@{z}: a complex number 139@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 140@SEEALSO=IMARCCSCH,IMARCCOTH 141 142@CATEGORY=Complex 143@FUNCTION=IMARCSIN 144@SHORTDESC=the complex arcsine of the complex number @{z} 145@SYNTAX=IMARCSIN(z) 146@ARGUMENTDESCRIPTION=@{z}: a complex number 147@DESCRIPTION=IMARCSIN returns the complex arcsine of the complex number @{z}. The branch cuts are on the real axis, less than -1 and greater than 1. 148@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 149@SEEALSO=IMARCCOS,IMARCTAN 150 151@CATEGORY=Complex 152@FUNCTION=IMARCSINH 153@SHORTDESC=the complex hyperbolic arcsine of the complex number @{z} 154@SYNTAX=IMARCSINH(z) 155@ARGUMENTDESCRIPTION=@{z}: a complex number 156@DESCRIPTION=IMARCSINH returns the complex hyperbolic arcsine of the complex number @{z}. The branch cuts are on the imaginary axis, below -i and above i. 157@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 158@SEEALSO=IMARCCOSH,IMARCTANH 159 160@CATEGORY=Complex 161@FUNCTION=IMARCTAN 162@SHORTDESC=the complex arctangent of the complex number 163@SYNTAX=IMARCTAN(z) 164@ARGUMENTDESCRIPTION=@{z}: a complex number 165@DESCRIPTION=IMARCTAN returns the complex arctangent of the complex number @{z}. The branch cuts are on the imaginary axis, below -i and above i. 166@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 167@SEEALSO=IMARCSIN,IMARCCOS 168 169@CATEGORY=Complex 170@FUNCTION=IMARCTANH 171@SHORTDESC=the complex hyperbolic arctangent of the complex number @{z} 172@SYNTAX=IMARCTANH(z) 173@ARGUMENTDESCRIPTION=@{z}: a complex number 174@DESCRIPTION=IMARCTANH returns the complex hyperbolic arctangent of the complex number @{z}. The branch cuts are on the real axis, less than -1 and greater than 1. 175@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 176@SEEALSO=IMARCSINH,IMARCCOSH 177 178@CATEGORY=Complex 179@FUNCTION=IMARGUMENT 180@SHORTDESC=the argument theta of the complex number @{z} 181@SYNTAX=IMARGUMENT(z) 182@ARGUMENTDESCRIPTION=@{z}: a complex number 183@DESCRIPTION=The argument theta of a complex number is its angle in radians from the real axis. 184@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. If @{z} is 0, 0 is returned. This is different from Excel which returns an error. 185 186@CATEGORY=Complex 187@FUNCTION=IMCONJUGATE 188@SHORTDESC=the complex conjugate of the complex number @{z} 189@SYNTAX=IMCONJUGATE(z) 190@ARGUMENTDESCRIPTION=@{z}: a complex number 191@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 192@EXCEL=This function is Excel compatible. 193@SEEALSO=IMAGINARY,IMREAL 194 195@CATEGORY=Complex 196@FUNCTION=IMCOS 197@SHORTDESC=the cosine of the complex number @{z} 198@SYNTAX=IMCOS(z) 199@ARGUMENTDESCRIPTION=@{z}: a complex number 200@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 201@EXCEL=This function is Excel compatible. 202@SEEALSO=IMSIN,IMTAN 203 204@CATEGORY=Complex 205@FUNCTION=IMCOSH 206@SHORTDESC=the hyperbolic cosine of the complex number @{z} 207@SYNTAX=IMCOSH(z) 208@ARGUMENTDESCRIPTION=@{z}: a complex number 209@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 210@SEEALSO=IMSINH,IMTANH 211 212@CATEGORY=Complex 213@FUNCTION=IMCOT 214@SHORTDESC=the cotangent of the complex number @{z} 215@SYNTAX=IMCOT(z) 216@ARGUMENTDESCRIPTION=@{z}: a complex number 217@DESCRIPTION=IMCOT(@{z}) = IMCOS(@{z})/IMSIN(@{z}). 218@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 219@SEEALSO=IMSEC,IMCSC 220 221@CATEGORY=Complex 222@FUNCTION=IMCOTH 223@SHORTDESC=the hyperbolic cotangent of the complex number @{z} 224@SYNTAX=IMCOTH(z) 225@ARGUMENTDESCRIPTION=@{z}: a complex number 226@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 227@SEEALSO=IMSECH,IMCSCH 228 229@CATEGORY=Complex 230@FUNCTION=IMCSC 231@SHORTDESC=the cosecant of the complex number @{z} 232@SYNTAX=IMCSC(z) 233@ARGUMENTDESCRIPTION=@{z}: a complex number 234@DESCRIPTION=IMCSC(@{z}) = 1/IMSIN(@{z}). 235@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 236@SEEALSO=IMSEC,IMCOT 237 238@CATEGORY=Complex 239@FUNCTION=IMCSCH 240@SHORTDESC=the hyperbolic cosecant of the complex number @{z} 241@SYNTAX=IMCSCH(z) 242@ARGUMENTDESCRIPTION=@{z}: a complex number 243@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 244@SEEALSO=IMSECH,IMCOTH 245 246@CATEGORY=Complex 247@FUNCTION=IMDIV 248@SHORTDESC=the quotient of two complex numbers @{z1}/@{z2} 249@SYNTAX=IMDIV(z1,z2) 250@ARGUMENTDESCRIPTION=@{z1}: a complex number 251@{z2}: a complex number 252@NOTE=If @{z1} or @{z2} is not a valid complex number, #VALUE! is returned. 253@EXCEL=This function is Excel compatible. 254@SEEALSO=IMPRODUCT 255 256@CATEGORY=Complex 257@FUNCTION=IMEXP 258@SHORTDESC=the exponential of the complex number @{z} 259@SYNTAX=IMEXP(z) 260@ARGUMENTDESCRIPTION=@{z}: a complex number 261@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 262@EXCEL=This function is Excel compatible. 263@SEEALSO=IMLN 264 265@CATEGORY=Complex 266@FUNCTION=IMFACT 267@SHORTDESC=the factorial of the complex number @{z} 268@SYNTAX=IMFACT(z) 269@ARGUMENTDESCRIPTION=@{z}: a complex number 270@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 271@SEEALSO=IMGAMMA 272 273@CATEGORY=Complex 274@FUNCTION=IMGAMMA 275@SHORTDESC=the gamma function of the complex number @{z} 276@SYNTAX=IMGAMMA(z) 277@ARGUMENTDESCRIPTION=@{z}: a complex number 278@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 279@SEEALSO=IMGAMMA 280 281@CATEGORY=Complex 282@FUNCTION=IMIGAMMA 283@SHORTDESC=the incomplete Gamma function 284@SYNTAX=IMIGAMMA(a,z,lower,regularize) 285@ARGUMENTDESCRIPTION=@{a}: a complex number 286@{z}: a complex number 287@{lower}: if true (the default), the lower incomplete gamma function, otherwise the upper incomplete gamma function 288@{regularize}: if true (the default), the regularized version of the incomplete gamma function 289@NOTE=The regularized incomplete gamma function is the unregularized incomplete gamma function divided by GAMMA(@{a}). 290@SEEALSO=GAMMA,IMIGAMMA 291 292@CATEGORY=Complex 293@FUNCTION=IMINV 294@SHORTDESC=the reciprocal, or inverse, of the complex number @{z} 295@SYNTAX=IMINV(z) 296@ARGUMENTDESCRIPTION=@{z}: a complex number 297@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 298 299@CATEGORY=Complex 300@FUNCTION=IMLN 301@SHORTDESC=the natural logarithm of the complex number @{z} 302@SYNTAX=IMLN(z) 303@ARGUMENTDESCRIPTION=@{z}: a complex number 304@DESCRIPTION=The result will have an imaginary part between -π and +π. 305The natural logarithm is not uniquely defined on complex numbers. You may need to add or subtract an even multiple of π to the imaginary part. 306@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 307@EXCEL=This function is Excel compatible. 308@SEEALSO=IMEXP,IMLOG2,IMLOG10 309 310@CATEGORY=Complex 311@FUNCTION=IMLOG10 312@SHORTDESC=the base-10 logarithm of the complex number @{z} 313@SYNTAX=IMLOG10(z) 314@ARGUMENTDESCRIPTION=@{z}: a complex number 315@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 316@EXCEL=This function is Excel compatible. 317@SEEALSO=IMLN,IMLOG2 318 319@CATEGORY=Complex 320@FUNCTION=IMLOG2 321@SHORTDESC=the base-2 logarithm of the complex number @{z} 322@SYNTAX=IMLOG2(z) 323@ARGUMENTDESCRIPTION=@{z}: a complex number 324@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 325@EXCEL=This function is Excel compatible. 326@SEEALSO=IMLN,IMLOG10 327 328@CATEGORY=Complex 329@FUNCTION=IMNEG 330@SHORTDESC=the negative of the complex number @{z} 331@SYNTAX=IMNEG(z) 332@ARGUMENTDESCRIPTION=@{z}: a complex number 333@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 334 335@CATEGORY=Complex 336@FUNCTION=IMPOWER 337@SHORTDESC=the complex number @{z1} raised to the @{z2}th power 338@SYNTAX=IMPOWER(z1,z2) 339@ARGUMENTDESCRIPTION=@{z1}: a complex number 340@{z2}: a complex number 341@NOTE=If @{z1} or @{z2} is not a valid complex number, #VALUE! is returned. 342@EXCEL=This function is Excel compatible. 343@SEEALSO=IMSQRT 344 345@CATEGORY=Complex 346@FUNCTION=IMPRODUCT 347@SHORTDESC=the product of the given complex numbers 348@SYNTAX=IMPRODUCT(z1,z2,…) 349@ARGUMENTDESCRIPTION=@{z1}: a complex number 350@{z2}: a complex number 351@NOTE=If any of @{z1}, @{z2},... is not a valid complex number, #VALUE! is returned. 352@EXCEL=This function is Excel compatible. 353@SEEALSO=IMDIV 354 355@CATEGORY=Complex 356@FUNCTION=IMREAL 357@SHORTDESC=the real part of the complex number @{z} 358@SYNTAX=IMREAL(z) 359@ARGUMENTDESCRIPTION=@{z}: a complex number 360@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 361@EXCEL=This function is Excel compatible. 362@SEEALSO=IMAGINARY 363 364@CATEGORY=Complex 365@FUNCTION=IMSEC 366@SHORTDESC=the secant of the complex number @{z} 367@SYNTAX=IMSEC(z) 368@ARGUMENTDESCRIPTION=@{z}: a complex number 369@DESCRIPTION=IMSEC(@{z}) = 1/IMCOS(@{z}). 370@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 371@SEEALSO=IMCSC,IMCOT 372 373@CATEGORY=Complex 374@FUNCTION=IMSECH 375@SHORTDESC=the hyperbolic secant of the complex number @{z} 376@SYNTAX=IMSECH(z) 377@ARGUMENTDESCRIPTION=@{z}: a complex number 378@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 379@SEEALSO=IMCSCH,IMCOTH 380 381@CATEGORY=Complex 382@FUNCTION=IMSIN 383@SHORTDESC=the sine of the complex number @{z} 384@SYNTAX=IMSIN(z) 385@ARGUMENTDESCRIPTION=@{z}: a complex number 386@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 387@EXCEL=This function is Excel compatible. 388@SEEALSO=IMCOS,IMTAN 389 390@CATEGORY=Complex 391@FUNCTION=IMSINH 392@SHORTDESC=the hyperbolic sine of the complex number @{z} 393@SYNTAX=IMSINH(z) 394@ARGUMENTDESCRIPTION=@{z}: a complex number 395@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 396@SEEALSO=IMCOSH,IMTANH 397 398@CATEGORY=Complex 399@FUNCTION=IMSQRT 400@SHORTDESC=the square root of the complex number @{z} 401@SYNTAX=IMSQRT(z) 402@ARGUMENTDESCRIPTION=@{z}: a complex number 403@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 404@EXCEL=This function is Excel compatible. 405@SEEALSO=IMPOWER 406 407@CATEGORY=Complex 408@FUNCTION=IMSUB 409@SHORTDESC=the difference of two complex numbers 410@SYNTAX=IMSUB(z1,z2) 411@ARGUMENTDESCRIPTION=@{z1}: a complex number 412@{z2}: a complex number 413@NOTE=If @{z1} or @{z2} is not a valid complex number, #VALUE! is returned. 414@EXCEL=This function is Excel compatible. 415@SEEALSO=IMSUM 416 417@CATEGORY=Complex 418@FUNCTION=IMSUM 419@SHORTDESC=the sum of the given complex numbers 420@SYNTAX=IMSUM(z1,z2,…) 421@ARGUMENTDESCRIPTION=@{z1}: a complex number 422@{z2}: a complex number 423@NOTE=If any of @{z1}, @{z2},... is not a valid complex number, #VALUE! is returned. 424@EXCEL=This function is Excel compatible. 425@SEEALSO=IMSUB 426 427@CATEGORY=Complex 428@FUNCTION=IMTAN 429@SHORTDESC=the tangent of the complex number @{z} 430@SYNTAX=IMTAN(z) 431@ARGUMENTDESCRIPTION=@{z}: a complex number 432@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 433@EXCEL=This function is Excel compatible. 434@SEEALSO=IMSIN,IMCOS 435 436@CATEGORY=Complex 437@FUNCTION=IMTANH 438@SHORTDESC=the hyperbolic tangent of the complex number @{z} 439@SYNTAX=IMTANH(z) 440@ARGUMENTDESCRIPTION=@{z}: a complex number 441@NOTE=If @{z} is not a valid complex number, #VALUE! is returned. 442@SEEALSO=IMSINH,IMCOSH 443 444@CATEGORY=Database 445@FUNCTION=DAVERAGE 446@SHORTDESC=average of the values in @{field} in @{database} belonging to records that match @{criteria} 447@SYNTAX=DAVERAGE(database,field,criteria) 448@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 449@{field}: a string or integer specifying which field is to be used 450@{criteria}: a range containing conditions 451@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 452@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 453@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 454@SEEALSO=DCOUNT 455 456@CATEGORY=Database 457@FUNCTION=DCOUNT 458@SHORTDESC=count of numbers in @{field} in @{database} belonging to records that match @{criteria} 459@SYNTAX=DCOUNT(database,field,criteria) 460@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 461@{field}: a string or integer specifying which field is to be used 462@{criteria}: a range containing conditions 463@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 464@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 465@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 466@SEEALSO=DAVERAGE,DCOUNTA 467 468@CATEGORY=Database 469@FUNCTION=DCOUNTA 470@SHORTDESC=count of cells with data in @{field} in @{database} belonging to records that match @{criteria} 471@SYNTAX=DCOUNTA(database,field,criteria) 472@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 473@{field}: a string or integer specifying which field is to be used 474@{criteria}: a range containing conditions 475@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 476@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 477@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 478@SEEALSO=DCOUNT 479 480@CATEGORY=Database 481@FUNCTION=DGET 482@SHORTDESC=a value from @{field} in @{database} belonging to records that match @{criteria} 483@SYNTAX=DGET(database,field,criteria) 484@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 485@{field}: a string or integer specifying which field is to be used 486@{criteria}: a range containing conditions 487@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 488@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 489@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 490@NOTE=If none of the records match the conditions, DGET returns #VALUE! If more than one record match the conditions, DGET returns #NUM! 491@SEEALSO=DCOUNT 492 493@CATEGORY=Database 494@FUNCTION=DMAX 495@SHORTDESC=largest number in @{field} in @{database} belonging to a record that match @{criteria} 496@SYNTAX=DMAX(database,field,criteria) 497@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 498@{field}: a string or integer specifying which field is to be used 499@{criteria}: a range containing conditions 500@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 501@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 502@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 503@SEEALSO=DMIN 504 505@CATEGORY=Database 506@FUNCTION=DMIN 507@SHORTDESC=smallest number in @{field} in @{database} belonging to a record that match @{criteria} 508@SYNTAX=DMIN(database,field,criteria) 509@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 510@{field}: a string or integer specifying which field is to be used 511@{criteria}: a range containing conditions 512@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 513@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 514@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 515@SEEALSO=DCOUNT 516 517@CATEGORY=Database 518@FUNCTION=DPRODUCT 519@SHORTDESC=product of all values in @{field} in @{database} belonging to records that match @{criteria} 520@SYNTAX=DPRODUCT(database,field,criteria) 521@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 522@{field}: a string or integer specifying which field is to be used 523@{criteria}: a range containing conditions 524@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 525@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 526@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 527@SEEALSO=DSUM 528 529@CATEGORY=Database 530@FUNCTION=DSTDEV 531@SHORTDESC=sample standard deviation of the values in @{field} in @{database} belonging to records that match @{criteria} 532@SYNTAX=DSTDEV(database,field,criteria) 533@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 534@{field}: a string or integer specifying which field is to be used 535@{criteria}: a range containing conditions 536@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 537@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 538@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 539@SEEALSO=DSTDEVP 540 541@CATEGORY=Database 542@FUNCTION=DSTDEVP 543@SHORTDESC=standard deviation of the population of values in @{field} in @{database} belonging to records that match @{criteria} 544@SYNTAX=DSTDEVP(database,field,criteria) 545@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 546@{field}: a string or integer specifying which field is to be used 547@{criteria}: a range containing conditions 548@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 549@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 550@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 551@SEEALSO=DSTDEV 552 553@CATEGORY=Database 554@FUNCTION=DSUM 555@SHORTDESC=sum of the values in @{field} in @{database} belonging to records that match @{criteria} 556@SYNTAX=DSUM(database,field,criteria) 557@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 558@{field}: a string or integer specifying which field is to be used 559@{criteria}: a range containing conditions 560@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 561@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 562@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 563@SEEALSO=DPRODUCT 564 565@CATEGORY=Database 566@FUNCTION=DVAR 567@SHORTDESC=sample variance of the values in @{field} in @{database} belonging to records that match @{criteria} 568@SYNTAX=DVAR(database,field,criteria) 569@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 570@{field}: a string or integer specifying which field is to be used 571@{criteria}: a range containing conditions 572@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 573@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 574@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 575@SEEALSO=DVARP 576 577@CATEGORY=Database 578@FUNCTION=DVARP 579@SHORTDESC=variance of the population of values in @{field} in @{database} belonging to records that match @{criteria} 580@SYNTAX=DVARP(database,field,criteria) 581@ARGUMENTDESCRIPTION=@{database}: a range in which rows of related information are records and columns of data are fields 582@{field}: a string or integer specifying which field is to be used 583@{criteria}: a range containing conditions 584@DESCRIPTION=@{database} is a range in which rows of related information are records and columns of data are fields. The first row of a database contains labels for each column. 585@{field} is a string or integer specifying which field is to be used. If @{field} is an integer n then the nth column will be used. If @{field} is a string, then the column with the matching label will be used. 586@{criteria} is a range containing conditions. The first row of a @{criteria} should contain labels. Each label specifies to which field the conditions given in that column apply. Each cell below the label specifies a condition such as ">3" or "<9". An equality condition can be given by simply specifying a value, e. g. "3" or "Jody". For a record to be considered it must satisfy all conditions in at least one of the rows of @{criteria}. 587@SEEALSO=DVAR 588 589@CATEGORY=Database 590@FUNCTION=GETPIVOTDATA 591@SHORTDESC=summary data from a pivot table 592@SYNTAX=GETPIVOTDATA(pivot_table,field_name) 593@ARGUMENTDESCRIPTION=@{pivot_table}: cell range containing the pivot table 594@{field_name}: name of the field for which the summary data is requested 595@NOTE=If the summary data is unavailable, GETPIVOTDATA returns #REF! 596 597@CATEGORY=Date/Time 598@FUNCTION=ASCENSIONTHURSDAY 599@SHORTDESC=Ascension Thursday in the Gregorian calendar according to the Roman rite of the Christian Church 600@SYNTAX=ASCENSIONTHURSDAY(year) 601@ARGUMENTDESCRIPTION=@{year}: year between 1582 and 9956, defaults to the year of the next Ascension Thursday 602@NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited. 603@SEEALSO=EASTERSUNDAY 604 605@CATEGORY=Date/Time 606@FUNCTION=ASHWEDNESDAY 607@SHORTDESC=Ash Wednesday in the Gregorian calendar according to the Roman rite of the Christian Church 608@SYNTAX=ASHWEDNESDAY(year) 609@ARGUMENTDESCRIPTION=@{year}: year between 1582 and 9956, defaults to the year of the next Ash Wednesday 610@NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited. 611@SEEALSO=EASTERSUNDAY 612 613@CATEGORY=Date/Time 614@FUNCTION=DATE 615@SHORTDESC=create a date serial value 616@SYNTAX=DATE(year,month,day) 617@ARGUMENTDESCRIPTION=@{year}: year of date 618@{month}: month of year 619@{day}: day of month 620@DESCRIPTION=The DATE function creates date serial values. 1-Jan-1900 is serial value 1, 2-Jan-1900 is serial value 2, and so on. For compatibility reasons, a serial value is reserved for the non-existing date 29-Feb-1900. 621@NOTE=If @{month} or @{day} is less than 1 or too big, then the year and/or month will be adjusted. For spreadsheets created with the Mac version of Excel, serial 1 is 1-Jan-1904. 622@EXCEL=This function is Excel compatible. 623@SEEALSO=TODAY,YEAR,MONTH,DAY 624 625@CATEGORY=Date/Time 626@FUNCTION=DATE2HDATE 627@SHORTDESC=Hebrew date 628@SYNTAX=DATE2HDATE(date) 629@ARGUMENTDESCRIPTION=@{date}: Gregorian date, defaults to today 630@SEEALSO=HDATE,DATE2HDATE_HEB 631 632@CATEGORY=Date/Time 633@FUNCTION=DATE2HDATE_HEB 634@SHORTDESC=Hebrew date in Hebrew 635@SYNTAX=DATE2HDATE_HEB(date) 636@ARGUMENTDESCRIPTION=@{date}: Gregorian date, defaults to today 637@SEEALSO=DATE2HDATE,HDATE_HEB 638 639@CATEGORY=Date/Time 640@FUNCTION=DATE2JULIAN 641@SHORTDESC=Julian day number for given Gregorian date 642@SYNTAX=DATE2JULIAN(date) 643@ARGUMENTDESCRIPTION=@{date}: Gregorian date, defaults to today 644@SEEALSO=HDATE_JULIAN 645 646@CATEGORY=Date/Time 647@FUNCTION=DATE2UNIX 648@SHORTDESC=the Unix timestamp corresponding to a date @{d} 649@SYNTAX=DATE2UNIX(d) 650@ARGUMENTDESCRIPTION=@{d}: date 651@DESCRIPTION=The DATE2UNIX function translates a date into a Unix timestamp. A Unix timestamp is the number of seconds since midnight (0:00) of January 1st, 1970 GMT. 652@SEEALSO=UNIX2DATE,DATE 653 654@CATEGORY=Date/Time 655@FUNCTION=DATEDIF 656@SHORTDESC=difference between dates 657@SYNTAX=DATEDIF(start_date,end_date,interval) 658@ARGUMENTDESCRIPTION=@{start_date}: starting date serial value 659@{end_date}: ending date serial value 660@{interval}: counting unit 661@DESCRIPTION=DATEDIF returns the distance from @{start_date} to @{end_date} according to the unit specified by @{interval}. 662@NOTE=If @{interval} is "y", "m", or "d" then the distance is measured in complete years, months, or days respectively. If @{interval} is "ym" or "yd" then the distance is measured in complete months or days, respectively, but excluding any difference in years. If @{interval} is "md" then the distance is measured in complete days but excluding any difference in months. 663@EXCEL=This function is Excel compatible. 664@SEEALSO=DAYS360 665 666@CATEGORY=Date/Time 667@FUNCTION=DATEVALUE 668@SHORTDESC=the date part of a date and time serial value 669@SYNTAX=DATEVALUE(serial) 670@ARGUMENTDESCRIPTION=@{serial}: date and time serial value 671@DESCRIPTION=DATEVALUE returns the date serial value part of a date and time serial value. 672@EXCEL=This function is Excel compatible. 673@SEEALSO=TIMEVALUE,DATE 674 675@CATEGORY=Date/Time 676@FUNCTION=DAY 677@SHORTDESC=the day-of-month part of a date serial value 678@SYNTAX=DAY(date) 679@ARGUMENTDESCRIPTION=@{date}: date serial value 680@DESCRIPTION=The DAY function returns the day-of-month part of @{date}. 681@EXCEL=This function is Excel compatible. 682@SEEALSO=DATE,YEAR,MONTH 683 684@CATEGORY=Date/Time 685@FUNCTION=DAYS 686@SHORTDESC=difference between dates in days 687@SYNTAX=DAYS(end_date,start_date) 688@ARGUMENTDESCRIPTION=@{end_date}: ending date serial value 689@{start_date}: starting date serial value 690@DESCRIPTION=DAYS returns the positive or negative number of days from @{start_date} to @{end_date}. 691@ODF=This function is OpenFormula compatible. 692@SEEALSO=DATEDIF 693 694@CATEGORY=Date/Time 695@FUNCTION=DAYS360 696@SHORTDESC=days between dates 697@SYNTAX=DAYS360(start_date,end_date,method) 698@ARGUMENTDESCRIPTION=@{start_date}: starting date serial value 699@{end_date}: ending date serial value 700@{method}: counting method 701@DESCRIPTION=DAYS360 returns the number of days from @{start_date} to @{end_date}. 702@NOTE=If @{method} is 0, the default, the MS Excel (tm) US method will be used. This is a somewhat complicated industry standard method where the last day of February is considered to be the 30th day of the month, but only for @{start_date}. If @{method} is 1, the European method will be used. In this case, if the day of the month is 31 it will be considered as 30 If @{method} is 2, a saner version of the US method is used in which both dates get the same February treatment. 703@EXCEL=This function is Excel compatible. 704@SEEALSO=DATEDIF 705 706@CATEGORY=Date/Time 707@FUNCTION=EASTERSUNDAY 708@SHORTDESC=Easter Sunday in the Gregorian calendar according to the Roman rite of the Christian Church 709@SYNTAX=EASTERSUNDAY(year) 710@ARGUMENTDESCRIPTION=@{year}: year between 1582 and 9956, defaults to the year of the next Easter Sunday 711@NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited. 712@ODF=The 1-argument version of EASTERSUNDAY is compatible with OpenOffice for years after 1904. This function is not specified in ODF/OpenFormula. 713@SEEALSO=ASHWEDNESDAY 714 715@CATEGORY=Date/Time 716@FUNCTION=EDATE 717@SHORTDESC=adjust a date by a number of months 718@SYNTAX=EDATE(date,months) 719@ARGUMENTDESCRIPTION=@{date}: date serial value 720@{months}: signed number of months 721@DESCRIPTION=EDATE returns @{date} moved forward or backward the number of months specified by @{months}. 722@EXCEL=This function is Excel compatible. 723@SEEALSO=DATE 724 725@CATEGORY=Date/Time 726@FUNCTION=EOMONTH 727@SHORTDESC=end of month 728@SYNTAX=EOMONTH(date,months) 729@ARGUMENTDESCRIPTION=@{date}: date serial value 730@{months}: signed number of months 731@DESCRIPTION=EOMONTH returns the date serial value of the end of the month specified by @{date} adjusted forward or backward the number of months specified by @{months}. 732@EXCEL=This function is Excel compatible. 733@SEEALSO=EDATE 734 735@CATEGORY=Date/Time 736@FUNCTION=GOODFRIDAY 737@SHORTDESC=Good Friday in the Gregorian calendar according to the Roman rite of the Christian Church 738@SYNTAX=GOODFRIDAY(year) 739@ARGUMENTDESCRIPTION=@{year}: year between 1582 and 9956, defaults to the year of the next Good Friday 740@NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited. 741@SEEALSO=EASTERSUNDAY 742 743@CATEGORY=Date/Time 744@FUNCTION=HDATE 745@SHORTDESC=Hebrew date 746@SYNTAX=HDATE(year,month,day) 747@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 748@{month}: Gregorian month of year, defaults to the current month 749@{day}: Gregorian day of month, defaults to the current day 750@SEEALSO=HDATE_HEB,DATE 751 752@CATEGORY=Date/Time 753@FUNCTION=HDATE_DAY 754@SHORTDESC=Hebrew day of Gregorian date 755@SYNTAX=HDATE_DAY(year,month,day) 756@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 757@{month}: Gregorian month of year, defaults to the current month 758@{day}: Gregorian day of month, defaults to the current day 759@SEEALSO=HDATE_JULIAN 760 761@CATEGORY=Date/Time 762@FUNCTION=HDATE_HEB 763@SHORTDESC=Hebrew date in Hebrew 764@SYNTAX=HDATE_HEB(year,month,day) 765@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 766@{month}: Gregorian month of year, defaults to the current month 767@{day}: Gregorian day of month, defaults to the current day 768@SEEALSO=HDATE,DATE 769 770@CATEGORY=Date/Time 771@FUNCTION=HDATE_JULIAN 772@SHORTDESC=Julian day number for given Gregorian date 773@SYNTAX=HDATE_JULIAN(year,month,day) 774@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 775@{month}: Gregorian month of year, defaults to the current month 776@{day}: Gregorian day of month, defaults to the current day 777@SEEALSO=HDATE 778 779@CATEGORY=Date/Time 780@FUNCTION=HDATE_MONTH 781@SHORTDESC=Hebrew month of Gregorian date 782@SYNTAX=HDATE_MONTH(year,month,day) 783@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 784@{month}: Gregorian month of year, defaults to the current month 785@{day}: Gregorian day of month, defaults to the current day 786@SEEALSO=HDATE_JULIAN 787 788@CATEGORY=Date/Time 789@FUNCTION=HDATE_YEAR 790@SHORTDESC=Hebrew year of Gregorian date 791@SYNTAX=HDATE_YEAR(year,month,day) 792@ARGUMENTDESCRIPTION=@{year}: Gregorian year of date, defaults to the current year 793@{month}: Gregorian month of year, defaults to the current month 794@{day}: Gregorian day of month, defaults to the current day 795@SEEALSO=HDATE_JULIAN 796 797@CATEGORY=Date/Time 798@FUNCTION=HOUR 799@SHORTDESC=compute hour part of fractional day 800@SYNTAX=HOUR(time) 801@ARGUMENTDESCRIPTION=@{time}: time of day as fractional day 802@DESCRIPTION=The HOUR function computes the hour part of the fractional day given by @{time}. 803@EXCEL=This function is Excel compatible. 804@SEEALSO=TIME,MINUTE,SECOND 805 806@CATEGORY=Date/Time 807@FUNCTION=ISOWEEKNUM 808@SHORTDESC=ISO week number 809@SYNTAX=ISOWEEKNUM(date) 810@ARGUMENTDESCRIPTION=@{date}: date serial value 811@DESCRIPTION=ISOWEEKNUM calculates the week number according to the ISO 8601 standard. Weeks start on Mondays and week 1 contains the first Thursday of the year. 812@NOTE=January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year. 813@SEEALSO=ISOYEAR,WEEKNUM 814 815@CATEGORY=Date/Time 816@FUNCTION=ISOYEAR 817@SHORTDESC=year corresponding to the ISO week number 818@SYNTAX=ISOYEAR(date) 819@ARGUMENTDESCRIPTION=@{date}: date serial value 820@DESCRIPTION=ISOYEAR calculates the year to go with week number according to the ISO 8601 standard. 821@NOTE=January 1 of a year is sometimes in week 52 or 53 of the previous year. Similarly, December 31 is sometimes in week 1 of the following year. 822@SEEALSO=ISOWEEKNUM,YEAR 823 824@CATEGORY=Date/Time 825@FUNCTION=MINUTE 826@SHORTDESC=compute minute part of fractional day 827@SYNTAX=MINUTE(time) 828@ARGUMENTDESCRIPTION=@{time}: time of day as fractional day 829@DESCRIPTION=The MINUTE function computes the minute part of the fractional day given by @{time}. 830@EXCEL=This function is Excel compatible. 831@SEEALSO=TIME,HOUR,SECOND 832 833@CATEGORY=Date/Time 834@FUNCTION=MONTH 835@SHORTDESC=the month part of a date serial value 836@SYNTAX=MONTH(date) 837@ARGUMENTDESCRIPTION=@{date}: date serial value 838@DESCRIPTION=The MONTH function returns the month part of @{date}. 839@EXCEL=This function is Excel compatible. 840@SEEALSO=DATE,YEAR,DAY 841 842@CATEGORY=Date/Time 843@FUNCTION=NETWORKDAYS 844@SHORTDESC=number of workdays in range 845@SYNTAX=NETWORKDAYS(start_date,end_date,holidays,weekend) 846@ARGUMENTDESCRIPTION=@{start_date}: starting date serial value 847@{end_date}: ending date serial value 848@{holidays}: array of holidays 849@{weekend}: array of 0s and 1s, indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {1,0,0,0,0,0,1} 850@DESCRIPTION=NETWORKDAYS calculates the number of days from @{start_date} to @{end_date} skipping weekends and @{holidays} in the process. 851@NOTE=If an entry of @{weekend} is non-zero, the corresponding weekday is not a work day. 852@EXCEL=This function is Excel compatible if the last argument is omitted. 853@ODF=This function is OpenFormula compatible. 854@SEEALSO=WORKDAY 855 856@CATEGORY=Date/Time 857@FUNCTION=NOW 858@SHORTDESC=the date and time serial value of the current time 859@SYNTAX=NOW() 860@DESCRIPTION=The NOW function returns the date and time serial value of the moment it is computed. Recomputing later will produce a different value. 861@EXCEL=This function is Excel compatible. 862@SEEALSO=DATE 863 864@CATEGORY=Date/Time 865@FUNCTION=ODF.TIME 866@SHORTDESC=create a time serial value 867@SYNTAX=ODF.TIME(hour,minute,second) 868@ARGUMENTDESCRIPTION=@{hour}: hour 869@{minute}: minute 870@{second}: second 871@DESCRIPTION=The ODF.TIME function computes the time given by @{hour}, @{minute}, and @{second} as a fraction of a day. 872@NOTE=While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value can be any number. 873@ODF=This function is OpenFormula compatible. 874@SEEALSO=TIME,HOUR,MINUTE,SECOND 875 876@CATEGORY=Date/Time 877@FUNCTION=PENTECOSTSUNDAY 878@SHORTDESC=Pentecost Sunday in the Gregorian calendar according to the Roman rite of the Christian Church 879@SYNTAX=PENTECOSTSUNDAY(year) 880@ARGUMENTDESCRIPTION=@{year}: year between 1582 and 9956, defaults to the year of the next Pentecost Sunday 881@NOTE=Two digit years are adjusted as elsewhere in Gnumeric. Dates before 1904 may also be prohibited. 882@SEEALSO=EASTERSUNDAY 883 884@CATEGORY=Date/Time 885@FUNCTION=SECOND 886@SHORTDESC=compute seconds part of fractional day 887@SYNTAX=SECOND(time) 888@ARGUMENTDESCRIPTION=@{time}: time of day as fractional day 889@DESCRIPTION=The SECOND function computes the seconds part of the fractional day given by @{time}. 890@EXCEL=This function is Excel compatible. 891@SEEALSO=TIME,HOUR,MINUTE 892 893@CATEGORY=Date/Time 894@FUNCTION=TIME 895@SHORTDESC=create a time serial value 896@SYNTAX=TIME(hour,minute,second) 897@ARGUMENTDESCRIPTION=@{hour}: hour of the day 898@{minute}: minute within the hour 899@{second}: second within the minute 900@DESCRIPTION=The TIME function computes the fractional day after midnight at the time given by @{hour}, @{minute}, and @{second}. 901@NOTE=While the return value is automatically formatted to look like a time between 0:00 and 24:00, the underlying serial time value is a number between 0 and 1. If any of @{hour}, @{minute}, and @{second} is negative, #NUM! is returned 902@EXCEL=This function is Excel compatible. 903@SEEALSO=ODF.TIME,HOUR,MINUTE,SECOND 904 905@CATEGORY=Date/Time 906@FUNCTION=TIMEVALUE 907@SHORTDESC=the time part of a date and time serial value 908@SYNTAX=TIMEVALUE(serial) 909@ARGUMENTDESCRIPTION=@{serial}: date and time serial value 910@DESCRIPTION=TIMEVALUE returns the time-of-day part of a date and time serial value. 911@EXCEL=This function is Excel compatible. 912@SEEALSO=DATEVALUE,TIME 913 914@CATEGORY=Date/Time 915@FUNCTION=TODAY 916@SHORTDESC=the date serial value of today 917@SYNTAX=TODAY() 918@DESCRIPTION=The TODAY function returns the date serial value of the day it is computed. Recomputing on a later date will produce a different value. 919@EXCEL=This function is Excel compatible. 920@SEEALSO=DATE 921 922@CATEGORY=Date/Time 923@FUNCTION=UNIX2DATE 924@SHORTDESC=date value corresponding to the Unix timestamp @{t} 925@SYNTAX=UNIX2DATE(t) 926@ARGUMENTDESCRIPTION=@{t}: Unix time stamp 927@DESCRIPTION=The UNIX2DATE function translates Unix timestamps into the corresponding date. A Unix timestamp is the number of seconds since midnight (0:00) of January 1st, 1970 GMT. 928@SEEALSO=DATE2UNIX,DATE 929 930@CATEGORY=Date/Time 931@FUNCTION=WEEKDAY 932@SHORTDESC=day-of-week 933@SYNTAX=WEEKDAY(date,method) 934@ARGUMENTDESCRIPTION=@{date}: date serial value 935@{method}: numbering system, defaults to 1 936@DESCRIPTION=The WEEKDAY function returns the day-of-week of @{date}. The value of @{method} determines how days are numbered; it defaults to 1. 937@NOTE=If @{method} is 1, then Sunday is 1, Monday is 2, etc. If @{method} is 2, then Monday is 1, Tuesday is 2, etc. If @{method} is 3, then Monday is 0, Tuesday is 1, etc. If @{method} is 11, then Monday is 1, Tuesday is 2, etc. If @{method} is 12, then Tuesday is 1, Wednesday is 2, etc. If @{method} is 13, then Wednesday is 1, Thursday is 2, etc. If @{method} is 14, then Thursday is 1, Friday is 2, etc. If @{method} is 15, then Friday is 1, Saturday is 2, etc. If @{method} is 16, then Saturday is 1, Sunday is 2, etc. If @{method} is 17, then Sunday is 1, Monday is 2, etc. 938@EXCEL=This function is Excel compatible. 939@SEEALSO=DATE,ISOWEEKNUM 940 941@CATEGORY=Date/Time 942@FUNCTION=WEEKNUM 943@SHORTDESC=week number 944@SYNTAX=WEEKNUM(date,method) 945@ARGUMENTDESCRIPTION=@{date}: date serial value 946@{method}: numbering system, defaults to 1 947@DESCRIPTION=WEEKNUM calculates the week number according to @{method} which defaults to 1. 948@NOTE=If @{method} is 1, then weeks start on Sundays and January 1 is in week 1. If @{method} is 2, then weeks start on Mondays and January 1 is in week 1. If @{method} is 150, then the ISO 8601 numbering is used. 949@SEEALSO=ISOWEEKNUM 950 951@CATEGORY=Date/Time 952@FUNCTION=WORKDAY 953@SHORTDESC=add working days 954@SYNTAX=WORKDAY(date,days,holidays,weekend) 955@ARGUMENTDESCRIPTION=@{date}: date serial value 956@{days}: number of days to add 957@{holidays}: array of holidays 958@{weekend}: array of 0s and 1s, indicating whether a weekday (S, M, T, W, T, F, S) is on the weekend, defaults to {1,0,0,0,0,0,1} 959@DESCRIPTION=WORKDAY adjusts @{date} by @{days} skipping over weekends and @{holidays} in the process. 960@NOTE=@{days} may be negative. If an entry of @{weekend} is non-zero, the corresponding weekday is not a work day. 961@EXCEL=This function is Excel compatible if the last argument is omitted. 962@ODF=This function is OpenFormula compatible. 963@SEEALSO=NETWORKDAYS 964 965@CATEGORY=Date/Time 966@FUNCTION=YEAR 967@SHORTDESC=the year part of a date serial value 968@SYNTAX=YEAR(date) 969@ARGUMENTDESCRIPTION=@{date}: date serial value 970@DESCRIPTION=The YEAR function returns the year part of @{date}. 971@EXCEL=This function is Excel compatible. 972@SEEALSO=DATE,MONTH,DAY 973 974@CATEGORY=Date/Time 975@FUNCTION=YEARFRAC 976@SHORTDESC=fractional number of years between dates 977@SYNTAX=YEARFRAC(start_date,end_date,basis) 978@ARGUMENTDESCRIPTION=@{start_date}: starting date serial value 979@{end_date}: ending date serial value 980@{basis}: calendar basis 981@DESCRIPTION=YEARFRAC calculates the number of days from @{start_date} to @{end_date} according to the calendar specified by @{basis}, which defaults to 0, and expresses the result as a fractional number of years. 982@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 983@SEEALSO=DATE 984 985@CATEGORY=Engineering 986@FUNCTION=BASE 987@SHORTDESC=string of digits representing the number @{n} in base @{b} 988@SYNTAX=BASE(n,b,length) 989@ARGUMENTDESCRIPTION=@{n}: integer 990@{b}: base (2 ≤ @{b} ≤ 36) 991@{length}: minimum length of the resulting string 992@DESCRIPTION=BASE converts @{n} to its string representation in base @{b}. Leading zeroes will be added to reach the minimum length given by @{length}. 993@ODF=This function is OpenFormula compatible. 994@SEEALSO=DECIMAL 995 996@CATEGORY=Engineering 997@FUNCTION=BESSELI 998@SHORTDESC=Modified Bessel function of the first kind of order @{α} at @{x} 999@SYNTAX=BESSELI(X,α) 1000@ARGUMENTDESCRIPTION=@{X}: number 1001@{α}: order (any non-negative number) 1002@NOTE=If @{x} or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. 1003@EXCEL=This function is Excel compatible if only integer orders @{α} are used. 1004@SEEALSO=BESSELJ,BESSELK,BESSELY 1005 1006@CATEGORY=Engineering 1007@FUNCTION=BESSELJ 1008@SHORTDESC=Bessel function of the first kind of order @{α} at @{x} 1009@SYNTAX=BESSELJ(X,α) 1010@ARGUMENTDESCRIPTION=@{X}: number 1011@{α}: order (any non-negative integer) 1012@NOTE=If @{x} or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. 1013@EXCEL=This function is Excel compatible if only integer orders @{α} are used. 1014@SEEALSO=BESSELI,BESSELK,BESSELY 1015 1016@CATEGORY=Engineering 1017@FUNCTION=BESSELK 1018@SHORTDESC=Modified Bessel function of the second kind of order @{α} at @{x} 1019@SYNTAX=BESSELK(X,α) 1020@ARGUMENTDESCRIPTION=@{X}: number 1021@{α}: order (any non-negative number) 1022@NOTE=If @{x} or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. 1023@EXCEL=This function is Excel compatible if only integer orders @{α} are used. 1024@SEEALSO=BESSELI,BESSELJ,BESSELY 1025 1026@CATEGORY=Engineering 1027@FUNCTION=BESSELY 1028@SHORTDESC=Bessel function of the second kind of order @{α} at @{x} 1029@SYNTAX=BESSELY(X,α) 1030@ARGUMENTDESCRIPTION=@{X}: number 1031@{α}: order (any non-negative integer) 1032@NOTE=If @{x} or @{α} are not numeric, #VALUE! is returned. If @{α} < 0, #NUM! is returned. 1033@EXCEL=This function is Excel compatible if only integer orders @{α} are used. 1034@SEEALSO=BESSELI,BESSELJ,BESSELK 1035 1036@CATEGORY=Engineering 1037@FUNCTION=BIN2DEC 1038@SHORTDESC=decimal representation of the binary number @{x} 1039@SYNTAX=BIN2DEC(x) 1040@ARGUMENTDESCRIPTION=@{x}: a binary number, either as a string or as a number involving only the digits 0 and 1 1041@EXCEL=This function is Excel compatible. 1042@SEEALSO=DEC2BIN,BIN2OCT,BIN2HEX 1043 1044@CATEGORY=Engineering 1045@FUNCTION=BIN2HEX 1046@SHORTDESC=hexadecimal representation of the binary number @{x} 1047@SYNTAX=BIN2HEX(x,places) 1048@ARGUMENTDESCRIPTION=@{x}: a binary number, either as a string or as a number involving only the digits 0 and 1 1049@{places}: number of digits 1050@DESCRIPTION=If @{places} is given, BIN2HEX pads the result with zeros to achieve exactly @{places} digits. If this is not possible, BIN2HEX returns #NUM! 1051@EXCEL=This function is Excel compatible. 1052@SEEALSO=HEX2BIN,BIN2OCT,BIN2DEC 1053 1054@CATEGORY=Engineering 1055@FUNCTION=BIN2OCT 1056@SHORTDESC=octal representation of the binary number @{x} 1057@SYNTAX=BIN2OCT(x,places) 1058@ARGUMENTDESCRIPTION=@{x}: a binary number, either as a string or as a number involving only the digits 0 and 1 1059@{places}: number of digits 1060@DESCRIPTION=If @{places} is given, BIN2OCT pads the result with zeros to achieve exactly @{places} digits. If this is not possible, BIN2OCT returns #NUM! 1061@EXCEL=This function is Excel compatible. 1062@SEEALSO=OCT2BIN,BIN2DEC,BIN2HEX 1063 1064@CATEGORY=Engineering 1065@FUNCTION=CONVERT 1066@SHORTDESC=a converted measurement 1067@SYNTAX=CONVERT(x,from,to) 1068@ARGUMENTDESCRIPTION=@{x}: number 1069@{from}: unit (string) 1070@{to}: unit (string) 1071@DESCRIPTION=CONVERT returns a conversion from one measurement system to another. @{x} is a value in @{from} units that is to be converted into @{to} units. 1072@{from} and @{to} can be any of the following: 1073 1074Weight and mass: 1075 'brton' Imperial ton 1076 'cwt' U.S. (short) hundredweight 1077 'g' Gram 1078 'grain' Grain 1079 'hweight' Imperial (long) hundredweight 1080 'LTON' Imperial ton 1081 'sg' Slug 1082 'shweight' U.S. (short) hundredweight 1083 'lbm' Pound 1084 'lcwt' Imperial (long) hundredweight 1085 'u' U (atomic mass) 1086 'uk_cwt' Imperial (long) hundredweight 1087 'uk_ton' Imperial ton 1088 'ozm' Ounce 1089 'stone' Stone 1090 'ton' Ton 1091 1092Distance: 1093 'm' Meter 1094 'mi' Statute mile 1095 'survey_mi' U.S. survey mile 1096 'Nmi' Nautical mile 1097 'in' Inch 1098 'ft' Foot 1099 'yd' Yard 1100 'ell' English Ell 1101 'ang' Angstrom 1102 'ly' Light-Year 1103 'pc' Parsec 1104 'parsec' Parsec 1105 'Pica' Pica Points 1106 'Picapt' Pica Points 1107 'picapt' Pica Points 1108 'pica' Pica 1109 1110Time: 1111 'yr' Year 1112 'day' Day 1113 'hr' Hour 1114 'mn' Minute 1115 'sec' Second 1116 1117Pressure: 1118 'Pa' Pascal 1119 'psi' PSI 1120 'atm' Atmosphere 1121 'Pa' Pascal 1122 'mmHg' mm of Mercury 1123 'Torr' Torr 1124 1125Force: 1126 'N' Newton 1127 'dyn' Dyne 1128 'pond' Pond 1129 'lbf' Pound force 1130 1131Energy: 1132 'J' Joule 1133 'e' Erg 1134 'c' Thermodynamic calorie 1135 'cal' IT calorie 1136 'eV' Electron volt 1137 'HPh' Horsepower-hour 1138 'Wh' Watt-hour 1139 'flb' Foot-pound 1140 'BTU' BTU 1141 1142Power: 1143 'HP' Horsepower 1144 'PS' Pferdestärke 1145 'W' Watt 1146 1147Magnetism: 1148 'T' Tesla 1149 'ga' Gauss 1150 1151Temperature: 1152 'C' Degree Celsius 1153 'F' Degree Fahrenheit 1154 'K' Kelvin 1155 'Rank' Degree Rankine 1156 'Reau' Degree Réaumur 1157 1158Volume (liquid measure): 1159 'tsp' Teaspoon 1160 'tspm' Teaspoon (modern, metric) 1161 'tbs' Tablespoon 1162 'oz' Fluid ounce 1163 'cup' Cup 1164 'pt' Pint 1165 'us_pt' U.S. pint 1166 'uk_pt' Imperial pint (U.K.) 1167 'qt' Quart 1168 'uk_qt' Imperial quart 1169 'gal' Gallon 1170 'uk_gal' Imperial gallon 1171 'GRT' Registered ton 1172 'regton' Registered ton 1173 'MTON' Measurement ton (freight ton) 1174 'l' Liter 1175 'L' Liter 1176 'lt' Liter 1177 'ang3' Cubic Angstrom 1178 'ang^3' Cubic Angstrom 1179 'barrel' U.S. oil barrel (bbl) 1180 'bushel' U.S. bushel 1181 'ft3' Cubic feet 1182 'ft^3' Cubic feet 1183 'in3' Cubic inch 1184 'in^3' Cubic inch 1185 'ly3' Cubic light-year 1186 'ly^3' Cubic light-year 1187 'm3' Cubic meter 1188 'm^3' Cubic meter 1189 'mi3' Cubic mile 1190 'mi^3' Cubic mile 1191 'yd3' Cubic yard 1192 'yd^3' Cubic yard 1193 'Nmi3' Cubic nautical mile 1194 'Nmi^3' Cubic nautical mile 1195 'Picapt3' Cubic Pica 1196 'Picapt^3' Cubic Pica 1197 'Pica3' Cubic Pica 1198 'Pica^3' Cubic Pica 1199 1200Area: 1201 'uk_acre' International acre 1202 'us_acre' U.S. survey/statute acre 1203 'ang2' Square angstrom 1204 'ang^2' Square angstrom 1205 'ar' Are 1206 'ha' Hectare 1207 'in2' Square inches 1208 'in^2' Square inches 1209 'ly2' Square light-year 1210 'ly^2' Square light-year 1211 'm2' Square meter 1212 'm^2' Square meter 1213 'Morgen' Morgen (North German Confederation) 1214 'mi2' Square miles 1215 'mi^2' Square miles 1216 'Nmi2' Square nautical miles 1217 'Nmi^2' Square nautical miles 1218 'Picapt2' Square Pica 1219 'Picapt^2' Square Pica 1220 'Pica2' Square Pica 1221 'Pica^2' Square Pica 1222 'yd2' Square yards 1223 'yd^2' Square yards 1224 1225Bits and Bytes: 1226 'bit' Bit 1227 'byte' Byte 1228 1229Speed: 1230 'admkn' Admiralty knot 1231 'kn' knot 1232 'm/h' Meters per hour 1233 'm/hr' Meters per hour 1234 'm/s' Meters per second 1235 'm/sec' Meters per second 1236 'mph' Miles per hour 1237 1238For metric units any of the following prefixes can be used: 1239 'Y' yotta 1E+24 1240 'Z' zetta 1E+21 1241 'E' exa 1E+18 1242 'P' peta 1E+15 1243 'T' tera 1E+12 1244 'G' giga 1E+09 1245 'M' mega 1E+06 1246 'k' kilo 1E+03 1247 'h' hecto 1E+02 1248 'e' deca (deka) 1E+01 1249 'd' deci 1E-01 1250 'c' centi 1E-02 1251 'm' milli 1E-03 1252 'u' micro 1E-06 1253 'n' nano 1E-09 1254 'p' pico 1E-12 1255 'f' femto 1E-15 1256 'a' atto 1E-18 1257 'z' zepto 1E-21 1258 'y' yocto 1E-24 1259 1260For bits and bytes any of the following prefixes can be also be used: 1261 'Yi' yobi 2^80 1262 'Zi' zebi 2^70 1263 'Ei' exbi 2^60 1264 'Pi' pebi 2^50 1265 'Ti' tebi 2^40 1266 'Gi' gibi 2^30 1267 'Mi' mebi 2^20 1268 'ki' kibi 2^10 1269@NOTE=If @{from} and @{to} are different types, CONVERT returns #N/A! 1270@EXCEL=This function is Excel compatible (except "picapt"). 1271@ODF=This function is OpenFormula compatible. 1272 1273@CATEGORY=Engineering 1274@FUNCTION=DEC2BIN 1275@SHORTDESC=binary representation of the decimal number @{x} 1276@SYNTAX=DEC2BIN(x,places) 1277@ARGUMENTDESCRIPTION=@{x}: integer (− 513 < @{x} < 512) 1278@{places}: number of digits 1279@DESCRIPTION=If @{places} is given and @{x} is non-negative, DEC2BIN pads the result with zeros to achieve exactly @{places} digits. If this is not possible, DEC2BIN returns #NUM! 1280If @{places} is given and @{x} is negative, @{places} is ignored. 1281@NOTE=If @{x} < − 512 or @{x} > 511, DEC2BIN returns #NUM! 1282@EXCEL=This function is Excel compatible. 1283@ODF=This function is OpenFormula compatible. 1284@SEEALSO=BIN2DEC,DEC2OCT,DEC2HEX 1285 1286@CATEGORY=Engineering 1287@FUNCTION=DEC2HEX 1288@SHORTDESC=hexadecimal representation of the decimal number @{x} 1289@SYNTAX=DEC2HEX(x,places) 1290@ARGUMENTDESCRIPTION=@{x}: integer 1291@{places}: number of digits 1292@DESCRIPTION=If @{places} is given, DEC2HEX pads the result with zeros to achieve exactly @{places} digits. If this is not possible, DEC2HEX returns #NUM! 1293@EXCEL=This function is Excel compatible. 1294@SEEALSO=HEX2DEC,DEC2BIN,DEC2OCT 1295 1296@CATEGORY=Engineering 1297@FUNCTION=DEC2OCT 1298@SHORTDESC=octal representation of the decimal number @{x} 1299@SYNTAX=DEC2OCT(x,places) 1300@ARGUMENTDESCRIPTION=@{x}: integer 1301@{places}: number of digits 1302@DESCRIPTION=If @{places} is given, DEC2OCT pads the result with zeros to achieve exactly @{places} digits. If this is not possible, DEC2OCT returns #NUM! 1303@EXCEL=This function is Excel compatible. 1304@SEEALSO=OCT2DEC,DEC2BIN,DEC2HEX 1305 1306@CATEGORY=Engineering 1307@FUNCTION=DECIMAL 1308@SHORTDESC=decimal representation of @{x} 1309@SYNTAX=DECIMAL(x,base) 1310@ARGUMENTDESCRIPTION=@{x}: number in base @{base} 1311@{base}: base of @{x}, (2 ≤ @{base} ≤ 36) 1312@ODF=This function is OpenFormula compatible. 1313@SEEALSO=BASE 1314 1315@CATEGORY=Engineering 1316@FUNCTION=DELTA 1317@SHORTDESC=Kronecker delta function 1318@SYNTAX=DELTA(x0,x1) 1319@ARGUMENTDESCRIPTION=@{x0}: number 1320@{x1}: number, defaults to 0 1321@DESCRIPTION=DELTA returns 1 if @{x1} = @{x0} and 0 otherwise. 1322@NOTE=If either argument is non-numeric, #VALUE! is returned. 1323@EXCEL=This function is Excel compatible. 1324@SEEALSO=EXACT,GESTEP 1325 1326@CATEGORY=Engineering 1327@FUNCTION=ERF 1328@SHORTDESC=Gauss error function 1329@SYNTAX=ERF(lower,upper) 1330@ARGUMENTDESCRIPTION=@{lower}: lower limit of the integral, defaults to 0 1331@{upper}: upper limit of the integral 1332@DESCRIPTION=ERF returns 2/sqrt(π)* integral from @{lower} to @{upper} of exp(-t*t) dt 1333@EXCEL=This function is Excel compatible if two arguments are supplied and neither is negative. 1334@SEEALSO=ERFC 1335 1336@CATEGORY=Engineering 1337@FUNCTION=ERFC 1338@SHORTDESC=Complementary Gauss error function 1339@SYNTAX=ERFC(x) 1340@ARGUMENTDESCRIPTION=@{x}: number 1341@DESCRIPTION=ERFC returns 2/sqrt(π)* integral from @{x} to ∞ of exp(-t*t) dt 1342@SEEALSO=ERF 1343 1344@CATEGORY=Engineering 1345@FUNCTION=GESTEP 1346@SHORTDESC=step function with step at @{x1} evaluated at @{x0} 1347@SYNTAX=GESTEP(x0,x1) 1348@ARGUMENTDESCRIPTION=@{x0}: number 1349@{x1}: number, defaults to 0 1350@DESCRIPTION=GESTEP returns 1 if @{x1} ≤ @{x0} and 0 otherwise. 1351@NOTE=If either argument is non-numeric, #VALUE! is returned. 1352@EXCEL=This function is Excel compatible. 1353@SEEALSO=DELTA 1354 1355@CATEGORY=Engineering 1356@FUNCTION=HEX2BIN 1357@SHORTDESC=binary representation of the hexadecimal number @{x} 1358@SYNTAX=HEX2BIN(x,places) 1359@ARGUMENTDESCRIPTION=@{x}: a hexadecimal number, either as a string or as a number if no A to F are needed 1360@{places}: number of digits 1361@DESCRIPTION=If @{places} is given, HEX2BIN pads the result with zeros to achieve exactly @{places} digits. If this is not possible, HEX2BIN returns #NUM! 1362@EXCEL=This function is Excel compatible. 1363@SEEALSO=BIN2HEX,HEX2OCT,HEX2DEC 1364 1365@CATEGORY=Engineering 1366@FUNCTION=HEX2DEC 1367@SHORTDESC=decimal representation of the hexadecimal number @{x} 1368@SYNTAX=HEX2DEC(x) 1369@ARGUMENTDESCRIPTION=@{x}: a hexadecimal number, either as a string or as a number if no A to F are needed 1370@EXCEL=This function is Excel compatible. 1371@SEEALSO=DEC2HEX,HEX2BIN,HEX2OCT 1372 1373@CATEGORY=Engineering 1374@FUNCTION=HEX2OCT 1375@SHORTDESC=octal representation of the hexadecimal number @{x} 1376@SYNTAX=HEX2OCT(x,places) 1377@ARGUMENTDESCRIPTION=@{x}: a hexadecimal number, either as a string or as a number if no A to F are needed 1378@{places}: number of digits 1379@DESCRIPTION=If @{places} is given, HEX2OCT pads the result with zeros to achieve exactly @{places} digits. If this is not possible, HEX2OCT returns #NUM! 1380@EXCEL=This function is Excel compatible. 1381@SEEALSO=OCT2HEX,HEX2BIN,HEX2DEC 1382 1383@CATEGORY=Engineering 1384@FUNCTION=HEXREP 1385@SHORTDESC=hexadecimal representation of numeric value 1386@SYNTAX=HEXREP(x) 1387@ARGUMENTDESCRIPTION=@{x}: number 1388@DESCRIPTION=HEXREP returns a hexadecimal string representation of @{x}. 1389@NOTE=This is a function meant for debugging. The layout of the result may change and even depend on how Gnumeric was compiled. 1390 1391@CATEGORY=Engineering 1392@FUNCTION=INVSUMINV 1393@SHORTDESC=the reciprocal of the sum of reciprocals of the arguments 1394@SYNTAX=INVSUMINV(x0,x1,…) 1395@ARGUMENTDESCRIPTION=@{x0}: non-negative number 1396@{x1}: non-negative number 1397@DESCRIPTION=INVSUMINV sum calculates the reciprocal (the inverse) of the sum of reciprocals (inverses) of all its arguments. 1398@NOTE=If any of the arguments is negative, #VALUE! is returned. 1399If any argument is zero, the result is zero. 1400@SEEALSO=HARMEAN 1401 1402@CATEGORY=Engineering 1403@FUNCTION=OCT2BIN 1404@SHORTDESC=binary representation of the octal number @{x} 1405@SYNTAX=OCT2BIN(x,places) 1406@ARGUMENTDESCRIPTION=@{x}: a octal number, either as a string or as a number 1407@{places}: number of digits 1408@DESCRIPTION=If @{places} is given, OCT2BIN pads the result with zeros to achieve exactly @{places} digits. If this is not possible, OCT2BIN returns #NUM! 1409@EXCEL=This function is Excel compatible. 1410@SEEALSO=BIN2OCT,OCT2DEC,OCT2HEX 1411 1412@CATEGORY=Engineering 1413@FUNCTION=OCT2DEC 1414@SHORTDESC=decimal representation of the octal number @{x} 1415@SYNTAX=OCT2DEC(x) 1416@ARGUMENTDESCRIPTION=@{x}: a octal number, either as a string or as a number 1417@EXCEL=This function is Excel compatible. 1418@SEEALSO=DEC2OCT,OCT2BIN,OCT2HEX 1419 1420@CATEGORY=Engineering 1421@FUNCTION=OCT2HEX 1422@SHORTDESC=hexadecimal representation of the octal number @{x} 1423@SYNTAX=OCT2HEX(x,places) 1424@ARGUMENTDESCRIPTION=@{x}: a octal number, either as a string or as a number 1425@{places}: number of digits 1426@DESCRIPTION=If @{places} is given, OCT2HEX pads the result with zeros to achieve exactly @{places} digits. If this is not possible, OCT2HEX returns #NUM! 1427@EXCEL=This function is Excel compatible. 1428@SEEALSO=HEX2OCT,OCT2BIN,OCT2DEC 1429 1430@CATEGORY=Erlang 1431@FUNCTION=DIMCIRC 1432@SHORTDESC=number of circuits required 1433@SYNTAX=DIMCIRC(traffic,gos) 1434@ARGUMENTDESCRIPTION=@{traffic}: number of calls 1435@{gos}: grade of service 1436@DESCRIPTION=DIMCIRC returns the number of circuits required given @{traffic} calls with grade of service @{gos}. 1437@SEEALSO=OFFCAP,OFFTRAF,PROBBLOCK 1438 1439@CATEGORY=Erlang 1440@FUNCTION=OFFCAP 1441@SHORTDESC=traffic capacity 1442@SYNTAX=OFFCAP(circuits,gos) 1443@ARGUMENTDESCRIPTION=@{circuits}: number of circuits 1444@{gos}: grade of service 1445@DESCRIPTION=OFFCAP returns the traffic capacity given @{circuits} circuits with grade of service @{gos}. 1446@SEEALSO=DIMCIRC,OFFTRAF,PROBBLOCK 1447 1448@CATEGORY=Erlang 1449@FUNCTION=OFFTRAF 1450@SHORTDESC=predicted number of offered calls 1451@SYNTAX=OFFTRAF(traffic,circuits) 1452@ARGUMENTDESCRIPTION=@{traffic}: number of carried calls 1453@{circuits}: number of circuits 1454@DESCRIPTION=OFFTRAF returns the predicted number of offered calls given @{traffic} carried calls (taken from measurements) on @{circuits} circuits. 1455@NOTE=@{traffic} cannot exceed @{circuits}. 1456@SEEALSO=PROBBLOCK,DIMCIRC,OFFCAP 1457 1458@CATEGORY=Erlang 1459@FUNCTION=PROBBLOCK 1460@SHORTDESC=probability of blocking 1461@SYNTAX=PROBBLOCK(traffic,circuits) 1462@ARGUMENTDESCRIPTION=@{traffic}: number of calls 1463@{circuits}: number of circuits 1464@DESCRIPTION=PROBBLOCK returns probability of blocking when @{traffic} calls load into @{circuits} circuits. 1465@NOTE=@{traffic} cannot exceed @{circuits}. 1466@SEEALSO=OFFTRAF,DIMCIRC,OFFCAP 1467 1468@CATEGORY=Finance 1469@FUNCTION=ACCRINT 1470@SHORTDESC=accrued interest 1471@SYNTAX=ACCRINT(issue,first_interest,settlement,rate,par,frequency,basis,calc_method) 1472@ARGUMENTDESCRIPTION=@{issue}: date of issue 1473@{first_interest}: date of first interest payment 1474@{settlement}: settlement date 1475@{rate}: nominal annual interest rate 1476@{par}: par value, defaults to $1000 1477@{frequency}: number of interest payments per year 1478@{basis}: calendar basis, defaults to 0 1479@{calc_method}: calculation method, defaults to TRUE 1480@DESCRIPTION=If @{first_interest} < @{settlement} and @{calc_method} is TRUE, then ACCRINT returns the sum of the interest accrued in all coupon periods from @{issue} date until @{settlement} date. 1481If @{first_interest} < @{settlement} and @{calc_method} is FALSE, then ACCRINT returns the sum of the interest accrued in all coupon periods from @{first_interest} date until @{settlement} date. 1482Otherwise ACCRINT returns the sum of the interest accrued in all coupon periods from @{issue} date until @{settlement} date. 1483@NOTE=@{frequency} must be one of 1, 2 or 4, but the exact value does not affect the result. @{issue} must precede both @{first_interest} and @{settlement}. @{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1484@SEEALSO=ACCRINTM 1485 1486@CATEGORY=Finance 1487@FUNCTION=ACCRINTM 1488@SHORTDESC=accrued interest 1489@SYNTAX=ACCRINTM(issue,maturity,rate,par,basis) 1490@ARGUMENTDESCRIPTION=@{issue}: date of issue 1491@{maturity}: maturity date 1492@{rate}: nominal annual interest rate 1493@{par}: par value 1494@{basis}: calendar basis 1495@DESCRIPTION=ACCRINTM calculates the accrued interest from @{issue} to @{maturity}. 1496@NOTE=@{par} defaults to $1000. If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1497@SEEALSO=ACCRINT 1498 1499@CATEGORY=Finance 1500@FUNCTION=AMORDEGRC 1501@SHORTDESC=depreciation of an asset using French accounting conventions 1502@SYNTAX=AMORDEGRC(cost,purchase_date,first_period,salvage,period,rate,basis) 1503@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 1504@{purchase_date}: date of purchase 1505@{first_period}: end of first period 1506@{salvage}: value after depreciation 1507@{period}: subject period 1508@{rate}: depreciation rate 1509@{basis}: calendar basis 1510@DESCRIPTION=AMORDEGRC calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. This is similar to AMORLINC, except that a depreciation coefficient is applied in the calculation depending on the life of the assets. 1511The depreciation coefficient used is: 15121.0 for an expected lifetime less than 3 years, 15131.5 for an expected lifetime of at least 3 years but less than 5 years, 15142.0 for an expected lifetime of at least 5 years but at most 6 years, 15152.5 for an expected lifetime of more than 6 years. 1516@NOTE=Special depreciation rules are applied for the last two periods resulting in a possible total depreciation exceeding the difference of @{cost} - @{salvage}. Named for AMORtissement DEGRessif Comptabilite. If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1517@SEEALSO=AMORLINC 1518 1519@CATEGORY=Finance 1520@FUNCTION=AMORLINC 1521@SHORTDESC=depreciation of an asset using French accounting conventions 1522@SYNTAX=AMORLINC(cost,purchase_date,first_period,salvage,period,rate,basis) 1523@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 1524@{purchase_date}: date of purchase 1525@{first_period}: end of first period 1526@{salvage}: value after depreciation 1527@{period}: subject period 1528@{rate}: depreciation rate 1529@{basis}: calendar basis 1530@DESCRIPTION=AMORLINC calculates the depreciation of an asset using French accounting conventions. Assets purchased in the middle of a period take prorated depreciation into account. 1531@NOTE=Named for AMORtissement LINeaire Comptabilite. If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1532@SEEALSO=AMORDEGRC 1533 1534@CATEGORY=Finance 1535@FUNCTION=COUPDAYBS 1536@SHORTDESC=number of days from coupon period to settlement 1537@SYNTAX=COUPDAYBS(settlement,maturity,frequency,basis,eom) 1538@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1539@{maturity}: maturity date 1540@{frequency}: number of interest payments per year 1541@{basis}: calendar basis 1542@{eom}: end-of-month flag 1543@DESCRIPTION=COUPDAYBS calculates the number of days from the beginning of the coupon period to the settlement date. 1544@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1545@SEEALSO=COUPDAYS 1546 1547@CATEGORY=Finance 1548@FUNCTION=COUPDAYS 1549@SHORTDESC=number of days in the coupon period of the settlement date 1550@SYNTAX=COUPDAYS(settlement,maturity,frequency,basis,eom) 1551@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1552@{maturity}: maturity date 1553@{frequency}: number of interest payments per year 1554@{basis}: calendar basis 1555@{eom}: end-of-month flag 1556@DESCRIPTION=COUPDAYS calculates the number of days in the coupon period of the settlement date. 1557@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1558@SEEALSO=COUPDAYBS,COUPDAYSNC 1559 1560@CATEGORY=Finance 1561@FUNCTION=COUPDAYSNC 1562@SHORTDESC=number of days from the settlement date to the next coupon period 1563@SYNTAX=COUPDAYSNC(settlement,maturity,frequency,basis,eom) 1564@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1565@{maturity}: maturity date 1566@{frequency}: number of interest payments per year 1567@{basis}: calendar basis 1568@{eom}: end-of-month flag 1569@DESCRIPTION=COUPDAYSNC calculates number of days from the settlement date to the next coupon period. 1570@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1571@SEEALSO=COUPDAYS,COUPDAYBS 1572 1573@CATEGORY=Finance 1574@FUNCTION=COUPNCD 1575@SHORTDESC=the next coupon date after settlement 1576@SYNTAX=COUPNCD(settlement,maturity,frequency,basis,eom) 1577@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1578@{maturity}: maturity date 1579@{frequency}: number of interest payments per year 1580@{basis}: calendar basis 1581@{eom}: end-of-month flag 1582@DESCRIPTION=COUPNCD calculates the coupon date following settlement. 1583@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1584@SEEALSO=COUPPCD,COUPDAYS,COUPDAYBS 1585 1586@CATEGORY=Finance 1587@FUNCTION=COUPNUM 1588@SHORTDESC=number of coupons 1589@SYNTAX=COUPNUM(settlement,maturity,frequency,basis,eom) 1590@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1591@{maturity}: maturity date 1592@{frequency}: number of interest payments per year 1593@{basis}: calendar basis 1594@{eom}: end-of-month flag 1595@DESCRIPTION=COUPNUM calculates the number of coupons to be paid between the settlement and maturity dates, rounded up. 1596@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1597@SEEALSO=COUPNCD,COUPPCD 1598 1599@CATEGORY=Finance 1600@FUNCTION=COUPPCD 1601@SHORTDESC=the last coupon date before settlement 1602@SYNTAX=COUPPCD(settlement,maturity,frequency,basis,eom) 1603@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1604@{maturity}: maturity date 1605@{frequency}: number of interest payments per year 1606@{basis}: calendar basis 1607@{eom}: end-of-month flag 1608@DESCRIPTION=COUPPCD calculates the coupon date preceding settlement. 1609@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1610@SEEALSO=COUPNCD,COUPDAYS,COUPDAYBS 1611 1612@CATEGORY=Finance 1613@FUNCTION=CUM_BIV_NORM_DIST 1614@SHORTDESC=cumulative bivariate normal distribution 1615@SYNTAX=CUM_BIV_NORM_DIST(a,b,rho) 1616@ARGUMENTDESCRIPTION=@{a}: limit for first random variable 1617@{b}: limit for second random variable 1618@{rho}: correlation of the two random variables 1619@DESCRIPTION=CUM_BIV_NORM_DIST calculates the probability that two standard normal distributed random variables with correlation @{rho} are respectively each less than @{a} and @{b}. 1620 1621@CATEGORY=Finance 1622@FUNCTION=CUMIPMT 1623@SHORTDESC=cumulative interest payment 1624@SYNTAX=CUMIPMT(rate,nper,pv,start_period,end_period,type) 1625@ARGUMENTDESCRIPTION=@{rate}: interest rate per period 1626@{nper}: number of periods 1627@{pv}: present value 1628@{start_period}: first period to accumulate for 1629@{end_period}: last period to accumulate for 1630@{type}: payment type 1631@DESCRIPTION=CUMIPMT calculates the cumulative interest paid on a loan from @{start_period} to @{end_period}. 1632@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 1633@SEEALSO=IPMT 1634 1635@CATEGORY=Finance 1636@FUNCTION=CUMPRINC 1637@SHORTDESC=cumulative principal 1638@SYNTAX=CUMPRINC(rate,nper,pv,start_period,end_period,type) 1639@ARGUMENTDESCRIPTION=@{rate}: interest rate per period 1640@{nper}: number of periods 1641@{pv}: present value 1642@{start_period}: first period to accumulate for 1643@{end_period}: last period to accumulate for 1644@{type}: payment type 1645@DESCRIPTION=CUMPRINC calculates the cumulative principal paid on a loan from @{start_period} to @{end_period}. 1646@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 1647@SEEALSO=PPMT 1648 1649@CATEGORY=Finance 1650@FUNCTION=DB 1651@SHORTDESC=depreciation of an asset 1652@SYNTAX=DB(cost,salvage,life,period,month) 1653@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 1654@{salvage}: value after depreciation 1655@{life}: number of periods 1656@{period}: subject period 1657@{month}: number of months in first year of depreciation 1658@DESCRIPTION=DB calculates the depreciation of an asset for a given period using the fixed-declining balance method. 1659@SEEALSO=DDB,SLN,SYD 1660 1661@CATEGORY=Finance 1662@FUNCTION=DDB 1663@SHORTDESC=depreciation of an asset 1664@SYNTAX=DDB(cost,salvage,life,period,factor) 1665@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 1666@{salvage}: value after depreciation 1667@{life}: number of periods 1668@{period}: subject period 1669@{factor}: factor at which the balance declines 1670@DESCRIPTION=DDB calculates the depreciation of an asset for a given period using the double-declining balance method. 1671@SEEALSO=DB,SLN,SYD 1672 1673@CATEGORY=Finance 1674@FUNCTION=DISC 1675@SHORTDESC=discount rate 1676@SYNTAX=DISC(settlement,maturity,par,redemption,basis) 1677@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1678@{maturity}: maturity date 1679@{par}: price per $100 face value 1680@{redemption}: amount received at maturity 1681@{basis}: calendar basis 1682@DESCRIPTION=DISC calculates the discount rate for a security. 1683@NOTE=@{redemption} is the redemption value per $100 face value. If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1684@SEEALSO=PRICEMAT 1685 1686@CATEGORY=Finance 1687@FUNCTION=DOLLARDE 1688@SHORTDESC=convert to decimal dollar amount 1689@SYNTAX=DOLLARDE(fractional_dollar,fraction) 1690@ARGUMENTDESCRIPTION=@{fractional_dollar}: amount to convert 1691@{fraction}: denominator 1692@DESCRIPTION=DOLLARDE converts a fractional dollar amount into a decimal amount. This is the inverse of the DOLLARFR function. 1693@SEEALSO=DOLLARFR 1694 1695@CATEGORY=Finance 1696@FUNCTION=DOLLARFR 1697@SHORTDESC=convert to dollar fraction 1698@SYNTAX=DOLLARFR(decimal_dollar,fraction) 1699@ARGUMENTDESCRIPTION=@{decimal_dollar}: amount to convert 1700@{fraction}: denominator 1701@DESCRIPTION=DOLLARFR converts a decimal dollar amount into a fractional amount which is represented as the digits after the decimal point. For example, 2/8 would be represented as .2 while 3/16 would be represented as .03. This is the inverse of the DOLLARDE function. 1702@SEEALSO=DOLLARDE 1703 1704@CATEGORY=Finance 1705@FUNCTION=DURATION 1706@SHORTDESC=the (Macaulay) duration of a security 1707@SYNTAX=DURATION(settlement,maturity,coupon,yield,frequency,basis) 1708@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1709@{maturity}: maturity date 1710@{coupon}: annual coupon rate 1711@{yield}: annual yield of security 1712@{frequency}: number of interest payments per year 1713@{basis}: calendar basis 1714@DESCRIPTION=DURATION calculates the (Macaulay) duration of a security. 1715@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1716@SEEALSO=MDURATION, G_DURATION 1717 1718@CATEGORY=Finance 1719@FUNCTION=EFFECT 1720@SHORTDESC=effective interest rate 1721@SYNTAX=EFFECT(rate,nper) 1722@ARGUMENTDESCRIPTION=@{rate}: nominal annual interest rate 1723@{nper}: number of periods used for compounding 1724@DESCRIPTION=EFFECT calculates the effective interest rate using the formula (1+@{rate}/@{nper})^@{nper}-1. 1725@SEEALSO=NOMINAL 1726 1727@CATEGORY=Finance 1728@FUNCTION=EURO 1729@SHORTDESC=equivalent of 1 EUR 1730@SYNTAX=EURO(currency) 1731@ARGUMENTDESCRIPTION=@{currency}: three-letter currency code 1732@DESCRIPTION=EURO calculates the national currency amount corresponding to 1 EUR for any of the national currencies that were replaced by the Euro on its introduction. 1733@NOTE=@{currency} must be one of ATS (Austria), BEF (Belgium), CYP (Cyprus), DEM (Germany), EEK (Estonia), ESP (Spain), EUR (Euro), FIM (Finland), FRF (France), GRD (Greece), IEP (Ireland), ITL (Italy), LUF (Luxembourg), MTL (Malta), NLG (The Netherlands), PTE (Portugal), SIT (Slovenia), or SKK (Slovakia). This function is not likely to be useful anymore. 1734@SEEALSO=EUROCONVERT 1735 1736@CATEGORY=Finance 1737@FUNCTION=EUROCONVERT 1738@SHORTDESC=pre-Euro amount from one currency to another 1739@SYNTAX=EUROCONVERT(n,source,target,full_precision,triangulation_precision) 1740@ARGUMENTDESCRIPTION=@{n}: amount 1741@{source}: three-letter source currency code 1742@{target}: three-letter target currency code 1743@{full_precision}: whether to provide the full precision; defaults to false 1744@{triangulation_precision}: number of digits (at least 3) to be rounded to after conversion of the source currency to euro; defaults to no rounding 1745@DESCRIPTION=EUROCONVERT converts @{n} units of currency @{source} to currency @{target}. The rates used are the official ones used on the introduction of the Euro. 1746@NOTE=If @{full_precision} is true, the result is not rounded; if it false the result is rounded to 0 or 2 decimals depending on the target currency; defaults to false. @{source} and @{target} must be one of the currencies listed for the EURO function. This function is not likely to be useful anymore. 1747@SEEALSO=EURO 1748 1749@CATEGORY=Finance 1750@FUNCTION=FV 1751@SHORTDESC=future value 1752@SYNTAX=FV(rate,nper,pmt,pv,type) 1753@ARGUMENTDESCRIPTION=@{rate}: effective interest rate per period 1754@{nper}: number of periods 1755@{pmt}: payment at each period 1756@{pv}: present value 1757@{type}: payment type 1758@DESCRIPTION=FV calculates the future value of @{pv} moved @{nper} periods into the future, assuming a periodic payment of @{pmt} and an interest rate of @{rate} per period. 1759@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 1760@SEEALSO=PV 1761 1762@CATEGORY=Finance 1763@FUNCTION=FVSCHEDULE 1764@SHORTDESC=future value 1765@SYNTAX=FVSCHEDULE(principal,schedule) 1766@ARGUMENTDESCRIPTION=@{principal}: initial value 1767@{schedule}: range of interest rates 1768@DESCRIPTION=FVSCHEDULE calculates the future value of @{principal} after applying a range of interest rates with compounding. 1769@SEEALSO=FV 1770 1771@CATEGORY=Finance 1772@FUNCTION=G_DURATION 1773@SHORTDESC=the duration of a investment 1774@SYNTAX=G_DURATION(rate,pv,fv) 1775@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 1776@{pv}: present value 1777@{fv}: future value 1778@DESCRIPTION=G_DURATION calculates the number of periods needed for an investment to attain a desired value. 1779@ODF=G_DURATION is the OpenFormula function PDURATION. 1780@SEEALSO=FV,PV,DURATION,MDURATION 1781 1782@CATEGORY=Finance 1783@FUNCTION=INTRATE 1784@SHORTDESC=interest rate 1785@SYNTAX=INTRATE(settlement,maturity,investment,redemption,basis) 1786@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1787@{maturity}: maturity date 1788@{investment}: amount paid on settlement 1789@{redemption}: amount received at maturity 1790@{basis}: calendar basis 1791@DESCRIPTION=INTRATE calculates the interest of a fully vested security. 1792@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1793@SEEALSO=RECEIVED 1794 1795@CATEGORY=Finance 1796@FUNCTION=IPMT 1797@SHORTDESC=interest payment for period 1798@SYNTAX=IPMT(rate,per,nper,pv,fv,type) 1799@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 1800@{per}: period number 1801@{nper}: number of periods 1802@{pv}: present value 1803@{fv}: future value 1804@{type}: payment type 1805@DESCRIPTION=IPMT calculates the interest part of an annuity's payment for period number @{per}. 1806@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 1807@SEEALSO=PPMT 1808 1809@CATEGORY=Finance 1810@FUNCTION=IRR 1811@SHORTDESC=internal rate of return 1812@SYNTAX=IRR(values,guess) 1813@ARGUMENTDESCRIPTION=@{values}: cash flow 1814@{guess}: an estimate of what the result should be 1815@DESCRIPTION=IRR calculates the internal rate of return of a cash flow with periodic payments. @{values} lists the payments (negative values) and receipts (positive values) for each period. 1816@NOTE=The optional @{guess} is needed because there can be more than one valid result. It defaults to 10%. 1817@SEEALSO=XIRR 1818 1819@CATEGORY=Finance 1820@FUNCTION=ISPMT 1821@SHORTDESC=interest payment for period 1822@SYNTAX=ISPMT(rate,per,nper,pv) 1823@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 1824@{per}: period number 1825@{nper}: number of periods 1826@{pv}: present value 1827@DESCRIPTION=ISPMT calculates the interest payment for period number @{per}. 1828@SEEALSO=PV 1829 1830@CATEGORY=Finance 1831@FUNCTION=MDURATION 1832@SHORTDESC=the modified (Macaulay) duration of a security 1833@SYNTAX=MDURATION(settlement,maturity,coupon,yield,frequency,basis) 1834@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1835@{maturity}: maturity date 1836@{coupon}: annual coupon rate 1837@{yield}: annual yield of security 1838@{frequency}: number of interest payments per year 1839@{basis}: calendar basis 1840@DESCRIPTION=MDURATION calculates the modified (Macaulay) duration of a security. 1841@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1842@SEEALSO=DURATION,G_DURATION 1843 1844@CATEGORY=Finance 1845@FUNCTION=MIRR 1846@SHORTDESC=modified internal rate of return 1847@SYNTAX=MIRR(values,finance_rate,reinvest_rate) 1848@ARGUMENTDESCRIPTION=@{values}: cash flow 1849@{finance_rate}: interest rate for financing cost 1850@{reinvest_rate}: interest rate for reinvestments 1851@DESCRIPTION=MIRR calculates the modified internal rate of return of a periodic cash flow. 1852@SEEALSO=IRR,XIRR 1853 1854@CATEGORY=Finance 1855@FUNCTION=NOMINAL 1856@SHORTDESC=nominal interest rate 1857@SYNTAX=NOMINAL(rate,nper) 1858@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 1859@{nper}: number of periods used for compounding 1860@DESCRIPTION=NOMINAL calculates the nominal interest rate from the effective rate. 1861@SEEALSO=EFFECT 1862 1863@CATEGORY=Finance 1864@FUNCTION=NPER 1865@SHORTDESC=number of periods 1866@SYNTAX=NPER(rate,pmt,pv,fv,type) 1867@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 1868@{pmt}: payment at each period 1869@{pv}: present value 1870@{fv}: future value 1871@{type}: payment type 1872@DESCRIPTION=NPER calculates the number of periods of an investment based on periodic constant payments and a constant interest rate. 1873@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 1874@SEEALSO=PV,FV 1875 1876@CATEGORY=Finance 1877@FUNCTION=NPV 1878@SHORTDESC=net present value 1879@SYNTAX=NPV(rate,value1,value2,…) 1880@ARGUMENTDESCRIPTION=@{rate}: effective interest rate per period 1881@{value1}: cash flow for period 1 1882@{value2}: cash flow for period 2 1883@DESCRIPTION=NPV calculates the net present value of a cash flow. 1884@SEEALSO=PV 1885 1886@CATEGORY=Finance 1887@FUNCTION=ODDFPRICE 1888@SHORTDESC=price of a security that has an odd first period 1889@SYNTAX=ODDFPRICE(settlement,maturity,issue,first_interest,rate,yield,redemption,frequency,basis) 1890@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1891@{maturity}: maturity date 1892@{issue}: date of issue 1893@{first_interest}: first interest date 1894@{rate}: nominal annual interest rate 1895@{yield}: annual yield of security 1896@{redemption}: amount received at maturity 1897@{frequency}: number of interest payments per year 1898@{basis}: calendar basis 1899@DESCRIPTION=ODDFPRICE calculates the price per $100 face value of a security that pays periodic interest, but has an odd first period. 1900@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1901@SEEALSO=ODDLPRICE,ODDFYIELD 1902 1903@CATEGORY=Finance 1904@FUNCTION=ODDFYIELD 1905@SHORTDESC=yield of a security that has an odd first period 1906@SYNTAX=ODDFYIELD(settlement,maturity,issue,first_interest,rate,price,redemption,frequency,basis) 1907@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1908@{maturity}: maturity date 1909@{issue}: date of issue 1910@{first_interest}: first interest date 1911@{rate}: nominal annual interest rate 1912@{price}: price of security 1913@{redemption}: amount received at maturity 1914@{frequency}: number of interest payments per year 1915@{basis}: calendar basis 1916@DESCRIPTION=ODDFYIELD calculates the yield of a security that pays periodic interest, but has an odd first period. 1917@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1918@SEEALSO=ODDFPRICE,ODDLYIELD 1919 1920@CATEGORY=Finance 1921@FUNCTION=ODDLPRICE 1922@SHORTDESC=price of a security that has an odd last period 1923@SYNTAX=ODDLPRICE(settlement,maturity,last_interest,rate,yield,redemption,frequency,basis) 1924@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1925@{maturity}: maturity date 1926@{last_interest}: last interest date 1927@{rate}: nominal annual interest rate 1928@{yield}: annual yield of security 1929@{redemption}: amount received at maturity 1930@{frequency}: number of interest payments per year 1931@{basis}: calendar basis 1932@DESCRIPTION=ODDLPRICE calculates the price per $100 face value of a security that pays periodic interest, but has an odd last period. 1933@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1934@SEEALSO=YIELD,DURATION 1935 1936@CATEGORY=Finance 1937@FUNCTION=ODDLYIELD 1938@SHORTDESC=yield of a security that has an odd last period 1939@SYNTAX=ODDLYIELD(settlement,maturity,last_interest,rate,price,redemption,frequency,basis) 1940@ARGUMENTDESCRIPTION=@{settlement}: settlement date 1941@{maturity}: maturity date 1942@{last_interest}: last interest date 1943@{rate}: nominal annual interest rate 1944@{price}: price of security 1945@{redemption}: amount received at maturity 1946@{frequency}: number of interest payments per year 1947@{basis}: calendar basis 1948@DESCRIPTION=ODDLYIELD calculates the yield of a security that pays periodic interest, but has an odd last period. 1949@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 1950@SEEALSO=YIELD,DURATION 1951 1952@CATEGORY=Finance 1953@FUNCTION=OPT_2_ASSET_CORRELATION 1954@SHORTDESC=theoretical price of options on 2 assets with correlation @{rho} 1955@SYNTAX=OPT_2_ASSET_CORRELATION(call_put_flag,spot1,spot2,strike1,strike2,time,cost_of_carry1,cost_of_carry2,rate,volatility1,volatility2,rho) 1956@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 1957@{spot1}: spot price of the underlying asset of the first option 1958@{spot2}: spot price of the underlying asset of the second option 1959@{strike1}: strike prices of the first option 1960@{strike2}: strike prices of the second option 1961@{time}: time to maturity in years 1962@{cost_of_carry1}: net cost of holding the underlying asset of the first option (for common stocks, the risk free rate less the dividend yield) 1963@{cost_of_carry2}: net cost of holding the underlying asset of the second option (for common stocks, the risk free rate less the dividend yield) 1964@{rate}: annualized risk-free interest rate 1965@{volatility1}: annualized volatility in price of the underlying asset of the first option 1966@{volatility2}: annualized volatility in price of the underlying asset of the second option 1967@{rho}: correlation between the two underlying assets 1968@DESCRIPTION=OPT_2_ASSET_CORRELATION models the theoretical price of options on 2 assets with correlation @{rho}. The payoff for a call is max(@{spot2} - @{strike2},0) if @{spot1} > @{strike1} or 0 otherwise. The payoff for a put is max (@{strike2} - @{spot2}, 0) if @{spot1} < @{strike1} or 0 otherwise. 1969@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 1970 1971@CATEGORY=Finance 1972@FUNCTION=OPT_AMER_EXCHANGE 1973@SHORTDESC=theoretical price of an American option to exchange assets 1974@SYNTAX=OPT_AMER_EXCHANGE(spot1,spot2,qty1,qty2,time,rate,cost_of_carry1,cost_of_carry2,volatility1,volatility2,rho) 1975@ARGUMENTDESCRIPTION=@{spot1}: spot price of asset 1 1976@{spot2}: spot price of asset 2 1977@{qty1}: quantity of asset 1 1978@{qty2}: quantity of asset 2 1979@{time}: time to maturity in years 1980@{rate}: annualized risk-free interest rate 1981@{cost_of_carry1}: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield) 1982@{cost_of_carry2}: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield) 1983@{volatility1}: annualized volatility in price of asset 1 1984@{volatility2}: annualized volatility in price of asset 2 1985@{rho}: correlation between the prices of the two assets 1986@DESCRIPTION=OPT_AMER_EXCHANGE models the theoretical price of an American option to exchange one asset with quantity @{qty2} and spot price @{spot2} for another with quantity @{qty1} and spot price @{spot1}. 1987@SEEALSO=OPT_EURO_EXCHANGE,OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 1988 1989@CATEGORY=Finance 1990@FUNCTION=OPT_BAW_AMER 1991@SHORTDESC=theoretical price of an option according to the Barone Adesie & Whaley approximation 1992@SYNTAX=OPT_BAW_AMER(call_put_flag,spot,strike,time,rate,cost_of_carry,volatility) 1993@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 1994@{spot}: spot price 1995@{strike}: strike price 1996@{time}: time to maturity in days 1997@{rate}: annualized risk-free interest rate 1998@{cost_of_carry}: net cost of holding the underlying asset 1999@{volatility}: annualized volatility of the asset 2000@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2001 2002@CATEGORY=Finance 2003@FUNCTION=OPT_BINOMIAL 2004@SHORTDESC=theoretical price of either an American or European style option using a binomial tree 2005@SYNTAX=OPT_BINOMIAL(amer_euro_flag,call_put_flag,num_time_steps,spot,strike,time,rate,volatility,cost_of_carry) 2006@ARGUMENTDESCRIPTION=@{amer_euro_flag}: 'a' for an American style option or 'e' for a European style option 2007@{call_put_flag}: 'c' for a call and 'p' for a put 2008@{num_time_steps}: number of time steps used in the valuation 2009@{spot}: spot price 2010@{strike}: strike price 2011@{time}: time to maturity in years 2012@{rate}: annualized risk-free interest rate 2013@{volatility}: annualized volatility of the asset 2014@{cost_of_carry}: net cost of holding the underlying asset 2015@NOTE=A larger @{num_time_steps} yields greater accuracy but OPT_BINOMIAL is slower to calculate. 2016@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2017 2018@CATEGORY=Finance 2019@FUNCTION=OPT_BJER_STENS 2020@SHORTDESC=theoretical price of American options according to the Bjerksund & Stensland approximation technique 2021@SYNTAX=OPT_BJER_STENS(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2022@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2023@{spot}: spot price 2024@{strike}: strike price 2025@{time}: time to maturity in days 2026@{rate}: annualized risk-free interest rate 2027@{volatility}: annualized volatility of the asset 2028@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2029@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2030 2031@CATEGORY=Finance 2032@FUNCTION=OPT_BS 2033@SHORTDESC=price of a European option 2034@SYNTAX=OPT_BS(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2035@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2036@{spot}: spot price 2037@{strike}: strike price 2038@{time}: time to maturity in years 2039@{rate}: risk-free interest rate to the exercise date in percent 2040@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2041@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2042@DESCRIPTION=OPT_BS uses the Black-Scholes model to calculate the price of a European option struck at @{strike} on an asset with spot price @{spot}. 2043@NOTE=The returned value will be expressed in the same units as @{strike} and @{spot}. 2044@SEEALSO=OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_VEGA,OPT_BS_GAMMA 2045 2046@CATEGORY=Finance 2047@FUNCTION=OPT_BS_CARRYCOST 2048@SHORTDESC=elasticity of a European option 2049@SYNTAX=OPT_BS_CARRYCOST(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2050@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2051@{spot}: spot price 2052@{strike}: strike price 2053@{time}: time to maturity in years 2054@{rate}: risk-free interest rate to the exercise date in percent 2055@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2056@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2057@DESCRIPTION=OPT_BS_CARRYCOST uses the Black-Scholes model to calculate the 'elasticity' of a European option struck at @{strike} on an asset with spot price @{spot}. The elasticity of an option is the rate of change of its price with respect to its @{cost_of_carry}. 2058@NOTE=Elasticity is expressed as the rate of change of the option value, per 100% volatility. 2059@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2060 2061@CATEGORY=Finance 2062@FUNCTION=OPT_BS_DELTA 2063@SHORTDESC=delta of a European option 2064@SYNTAX=OPT_BS_DELTA(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2065@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2066@{spot}: spot price 2067@{strike}: strike price 2068@{time}: time to maturity in years 2069@{rate}: risk-free interest rate to the exercise date in percent 2070@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2071@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2072@DESCRIPTION=OPT_BS_DELTA uses the Black-Scholes model to calculate the 'delta' of a European option struck at @{strike} on an asset with spot price @{spot}. 2073@NOTE=The returned value will be expressed in the same units as @{strike} and @{spot}. 2074@SEEALSO=OPT_BS,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_VEGA,OPT_BS_GAMMA 2075 2076@CATEGORY=Finance 2077@FUNCTION=OPT_BS_GAMMA 2078@SHORTDESC=gamma of a European option 2079@SYNTAX=OPT_BS_GAMMA(spot,strike,time,rate,volatility,cost_of_carry) 2080@ARGUMENTDESCRIPTION=@{spot}: spot price 2081@{strike}: strike price 2082@{time}: time to maturity in years 2083@{rate}: risk-free interest rate to the exercise date in percent 2084@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2085@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2086@DESCRIPTION=OPT_BS_GAMMA uses the Black-Scholes model to calculate the 'gamma' of a European option struck at @{strike} on an asset with spot price @{spot}. The gamma of an option is the second derivative of its price with respect to the price of the underlying asset. 2087@NOTE=Gamma is expressed as the rate of change of delta per unit change in @{spot}. Gamma is the same for calls and puts. 2088@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_VEGA 2089 2090@CATEGORY=Finance 2091@FUNCTION=OPT_BS_RHO 2092@SHORTDESC=rho of a European option 2093@SYNTAX=OPT_BS_RHO(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2094@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2095@{spot}: spot price 2096@{strike}: strike price 2097@{time}: time to maturity in years 2098@{rate}: risk-free interest rate to the exercise date in percent 2099@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2100@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2101@DESCRIPTION=OPT_BS_RHO uses the Black-Scholes model to calculate the 'rho' of a European option struck at @{strike} on an asset with spot price @{spot}. The rho of an option is the rate of change of its price with respect to the risk free interest rate. 2102@NOTE=Rho is expressed as the rate of change of the option value, per 100% change in @{rate}. 2103@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_THETA,OPT_BS_VEGA,OPT_BS_GAMMA 2104 2105@CATEGORY=Finance 2106@FUNCTION=OPT_BS_THETA 2107@SHORTDESC=theta of a European option 2108@SYNTAX=OPT_BS_THETA(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry) 2109@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2110@{spot}: spot price 2111@{strike}: strike price 2112@{time}: time to maturity in years 2113@{rate}: risk-free interest rate to the exercise date in percent 2114@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2115@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2116@DESCRIPTION=OPT_BS_THETA uses the Black-Scholes model to calculate the 'theta' of a European option struck at @{strike} on an asset with spot price @{spot}. The theta of an option is the rate of change of its price with respect to time to expiry. 2117@NOTE=Theta is expressed as the negative of the rate of change of the option value, per 365.25 days. 2118@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_VEGA,OPT_BS_GAMMA 2119 2120@CATEGORY=Finance 2121@FUNCTION=OPT_BS_VEGA 2122@SHORTDESC=vega of a European option 2123@SYNTAX=OPT_BS_VEGA(spot,strike,time,rate,volatility,cost_of_carry) 2124@ARGUMENTDESCRIPTION=@{spot}: spot price 2125@{strike}: strike price 2126@{time}: time to maturity in years 2127@{rate}: risk-free interest rate to the exercise date in percent 2128@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2129@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2130@DESCRIPTION=OPT_BS_VEGA uses the Black-Scholes model to calculate the 'vega' of a European option struck at @{strike} on an asset with spot price @{spot}. The vega of an option is the rate of change of its price with respect to volatility. 2131@NOTE=Vega is the same for calls and puts. Vega is expressed as the rate of change of option value, per 100% volatility. 2132@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2133 2134@CATEGORY=Finance 2135@FUNCTION=OPT_COMPLEX_CHOOSER 2136@SHORTDESC=theoretical price of a complex chooser option 2137@SYNTAX=OPT_COMPLEX_CHOOSER(spot,strike_call,strike_put,time,time_call,time_put,rate,cost_of_carry,volatility) 2138@ARGUMENTDESCRIPTION=@{spot}: spot price 2139@{strike_call}: strike price, if exercised as a call option 2140@{strike_put}: strike price, if exercised as a put option 2141@{time}: time in years until the holder chooses a put or a call option 2142@{time_call}: time in years to maturity of the call option if chosen 2143@{time_put}: time in years to maturity of the put option if chosen 2144@{rate}: annualized risk-free interest rate 2145@{cost_of_carry}: net cost of holding the underlying asset 2146@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2147@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2148 2149@CATEGORY=Finance 2150@FUNCTION=OPT_EURO_EXCHANGE 2151@SHORTDESC=theoretical price of a European option to exchange assets 2152@SYNTAX=OPT_EURO_EXCHANGE(spot1,spot2,qty1,qty2,time,rate,cost_of_carry1,cost_of_carry2,volatility1,volatility2,rho) 2153@ARGUMENTDESCRIPTION=@{spot1}: spot price of asset 1 2154@{spot2}: spot price of asset 2 2155@{qty1}: quantity of asset 1 2156@{qty2}: quantity of asset 2 2157@{time}: time to maturity in years 2158@{rate}: annualized risk-free interest rate 2159@{cost_of_carry1}: net cost of holding asset 1 (for common stocks, the risk free rate less the dividend yield) 2160@{cost_of_carry2}: net cost of holding asset 2 (for common stocks, the risk free rate less the dividend yield) 2161@{volatility1}: annualized volatility in price of asset 1 2162@{volatility2}: annualized volatility in price of asset 2 2163@{rho}: correlation between the prices of the two assets 2164@DESCRIPTION=OPT_EURO_EXCHANGE models the theoretical price of a European option to exchange one asset with quantity @{qty2} and spot price @{spot2} for another with quantity @{qty1} and spot price @{spot1}. 2165@SEEALSO=OPT_AMER_EXCHANGE,OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2166 2167@CATEGORY=Finance 2168@FUNCTION=OPT_EXEC 2169@SHORTDESC=theoretical price of executive stock options 2170@SYNTAX=OPT_EXEC(call_put_flag,spot,strike,time,rate,volatility,cost_of_carry,lambda) 2171@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2172@{spot}: spot price 2173@{strike}: strike price 2174@{time}: time to maturity in days 2175@{rate}: annualized risk-free interest rate 2176@{volatility}: annualized volatility of the asset 2177@{cost_of_carry}: net cost of holding the underlying asset 2178@{lambda}: jump rate for executives 2179@NOTE=The model assumes executives forfeit their options if they leave the company. 2180@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2181 2182@CATEGORY=Finance 2183@FUNCTION=OPT_EXTENDIBLE_WRITER 2184@SHORTDESC=theoretical price of extendible writer options 2185@SYNTAX=OPT_EXTENDIBLE_WRITER(call_put_flag,spot,strike1,strike2,time1,time2,rate,cost_of_carry,volatility) 2186@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2187@{spot}: spot price 2188@{strike1}: strike price at which the option is struck 2189@{strike2}: strike price at which the option is re-struck if out of the money at @{time1} 2190@{time1}: initial maturity of the option in years 2191@{time2}: extended maturity in years if chosen 2192@{rate}: annualized risk-free interest rate 2193@{cost_of_carry}: net cost of holding the underlying asset 2194@{volatility}: annualized volatility of the asset 2195@DESCRIPTION=OPT_EXTENDIBLE_WRITER models the theoretical price of extendible writer options. These are options that have their maturity extended to @{time2} if the option is out of the money at @{time1}. 2196@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2197 2198@CATEGORY=Finance 2199@FUNCTION=OPT_FIXED_STRK_LKBK 2200@SHORTDESC=theoretical price of a fixed-strike lookback option 2201@SYNTAX=OPT_FIXED_STRK_LKBK(call_put_flag,spot,spot_min,spot_max,strike,time,rate,cost_of_carry,volatility) 2202@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2203@{spot}: spot price 2204@{spot_min}: minimum spot price of the underlying asset so far observed 2205@{spot_max}: maximum spot price of the underlying asset so far observed 2206@{strike}: strike price 2207@{time}: time to maturity in years 2208@{rate}: annualized risk-free interest rate 2209@{cost_of_carry}: net cost of holding the underlying asset 2210@{volatility}: annualized volatility of the asset 2211@DESCRIPTION=OPT_FIXED_STRK_LKBK determines the theoretical price of a fixed-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset. 2212@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2213 2214@CATEGORY=Finance 2215@FUNCTION=OPT_FLOAT_STRK_LKBK 2216@SHORTDESC=theoretical price of floating-strike lookback option 2217@SYNTAX=OPT_FLOAT_STRK_LKBK(call_put_flag,spot,spot_min,spot_max,time,rate,cost_of_carry,volatility) 2218@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2219@{spot}: spot price 2220@{spot_min}: minimum spot price of the underlying asset so far observed 2221@{spot_max}: maximum spot price of the underlying asset so far observed 2222@{time}: time to maturity in years 2223@{rate}: annualized risk-free interest rate 2224@{cost_of_carry}: net cost of holding the underlying asset 2225@{volatility}: annualized volatility of the asset 2226@DESCRIPTION=OPT_FLOAT_STRK_LKBK determines the theoretical price of a floating-strike lookback option where the holder of the option may exercise on expiry at the most favourable price observed during the options life of the underlying asset. 2227@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2228 2229@CATEGORY=Finance 2230@FUNCTION=OPT_FORWARD_START 2231@SHORTDESC=theoretical price of forward start options 2232@SYNTAX=OPT_FORWARD_START(call_put_flag,spot,alpha,time_start,time,rate,volatility,cost_of_carry) 2233@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2234@{spot}: spot price 2235@{alpha}: fraction setting the strike price at the future date @{time_start} 2236@{time_start}: time until the option starts in days 2237@{time}: time to maturity in days 2238@{rate}: annualized risk-free interest rate 2239@{volatility}: annualized volatility of the asset 2240@{cost_of_carry}: net cost of holding the underlying asset 2241@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2242 2243@CATEGORY=Finance 2244@FUNCTION=OPT_FRENCH 2245@SHORTDESC=theoretical price of a European option adjusted for trading day volatility 2246@SYNTAX=OPT_FRENCH(call_put_flag,spot,strike,time,ttime,rate,volatility,cost_of_carry) 2247@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2248@{spot}: spot price 2249@{strike}: strike price 2250@{time}: ratio of the number of calendar days to exercise and the number of calendar days in the year 2251@{ttime}: ratio of the number of trading days to exercise and the number of trading days in the year 2252@{rate}: risk-free interest rate to the exercise date in percent 2253@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2254@{cost_of_carry}: net cost of holding the underlying asset (for common stocks, the risk free rate less the dividend yield), defaults to 0 2255@DESCRIPTION=OPT_FRENCH values the theoretical price of a European option adjusted for trading day volatility, struck at @{strike} on an asset with spot price @{spot}. 2256@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2257 2258@CATEGORY=Finance 2259@FUNCTION=OPT_GARMAN_KOHLHAGEN 2260@SHORTDESC=theoretical price of a European currency option 2261@SYNTAX=OPT_GARMAN_KOHLHAGEN(call_put_flag,spot,strike,time,domestic_rate,foreign_rate,volatility) 2262@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2263@{spot}: spot price 2264@{strike}: strike price 2265@{time}: number of days to exercise 2266@{domestic_rate}: domestic risk-free interest rate to the exercise date in percent 2267@{foreign_rate}: foreign risk-free interest rate to the exercise date in percent 2268@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2269@DESCRIPTION=OPT_GARMAN_KOHLHAGEN values the theoretical price of a European currency option struck at @{strike} on an asset with spot price @{spot}. 2270@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2271 2272@CATEGORY=Finance 2273@FUNCTION=OPT_JUMP_DIFF 2274@SHORTDESC=theoretical price of an option according to the Jump Diffusion process 2275@SYNTAX=OPT_JUMP_DIFF(call_put_flag,spot,strike,time,rate,volatility,lambda,gamma) 2276@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2277@{spot}: spot price 2278@{strike}: strike price 2279@{time}: time to maturity in years 2280@{rate}: the annualized rate of interest 2281@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2282@{lambda}: expected number of 'jumps' per year 2283@{gamma}: proportion of volatility explained by the 'jumps' 2284@DESCRIPTION=OPT_JUMP_DIFF models the theoretical price of an option according to the Jump Diffusion process (Merton). 2285@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2286 2287@CATEGORY=Finance 2288@FUNCTION=OPT_MILTERSEN_SCHWARTZ 2289@SHORTDESC=theoretical price of options on commodities futures according to Miltersen & Schwartz 2290@SYNTAX=OPT_MILTERSEN_SCHWARTZ(call_put_flag,p_t,f_t,strike,t1,t2,v_s,v_e,v_f,rho_se,rho_sf,rho_ef,kappa_e,kappa_f) 2291@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2292@{p_t}: zero coupon bond with expiry at option maturity 2293@{f_t}: futures price 2294@{strike}: strike price 2295@{t1}: time to maturity of the option 2296@{t2}: time to maturity of the underlying commodity futures contract 2297@{v_s}: volatility of the spot commodity price 2298@{v_e}: volatility of the future convenience yield 2299@{v_f}: volatility of the forward rate of interest 2300@{rho_se}: correlation between the spot commodity price and the convenience yield 2301@{rho_sf}: correlation between the spot commodity price and the forward interest rate 2302@{rho_ef}: correlation between the forward interest rate and the convenience yield 2303@{kappa_e}: speed of mean reversion of the convenience yield 2304@{kappa_f}: speed of mean reversion of the forward interest rate 2305@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2306 2307@CATEGORY=Finance 2308@FUNCTION=OPT_ON_OPTIONS 2309@SHORTDESC=theoretical price of options on options 2310@SYNTAX=OPT_ON_OPTIONS(type_flag,spot,strike1,strike2,time1,time2,rate,cost_of_carry,volatility) 2311@ARGUMENTDESCRIPTION=@{type_flag}: 'cc' for calls on calls, 'cp' for calls on puts, and so on for 'pc', and 'pp' 2312@{spot}: spot price 2313@{strike1}: strike price at which the option being valued is struck 2314@{strike2}: strike price at which the underlying option is struck 2315@{time1}: time in years to maturity of the option 2316@{time2}: time in years to the maturity of the underlying option 2317@{rate}: annualized risk-free interest rate 2318@{cost_of_carry}: net cost of holding the underlying asset of the underlying option 2319@{volatility}: annualized volatility in price of the underlying asset of the underlying option 2320@NOTE=For common stocks, @{cost_of_carry} is the risk free rate less the dividend yield. @{time2} ≥ @{time1} 2321@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2322 2323@CATEGORY=Finance 2324@FUNCTION=OPT_RGW 2325@SHORTDESC=theoretical price of an American option according to the Roll-Geske-Whaley approximation 2326@SYNTAX=OPT_RGW(spot,strike,time_payout,time_exp,rate,d,volatility) 2327@ARGUMENTDESCRIPTION=@{spot}: spot price 2328@{strike}: strike price 2329@{time_payout}: time to dividend payout 2330@{time_exp}: time to expiration 2331@{rate}: annualized interest rate 2332@{d}: amount of the dividend to be paid expressed in currency 2333@{volatility}: annualized volatility of the asset in percent for the period through to the exercise date 2334@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2335 2336@CATEGORY=Finance 2337@FUNCTION=OPT_SIMPLE_CHOOSER 2338@SHORTDESC=theoretical price of a simple chooser option 2339@SYNTAX=OPT_SIMPLE_CHOOSER(call_put_flag,spot,strike,time1,time2,cost_of_carry,volatility) 2340@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2341@{spot}: spot price 2342@{strike}: strike price 2343@{time1}: time in years until the holder chooses a put or a call option 2344@{time2}: time in years until the chosen option expires 2345@{cost_of_carry}: net cost of holding the underlying asset 2346@{volatility}: annualized volatility of the asset 2347@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2348 2349@CATEGORY=Finance 2350@FUNCTION=OPT_SPREAD_APPROX 2351@SHORTDESC=theoretical price of a European option on the spread between two futures contracts 2352@SYNTAX=OPT_SPREAD_APPROX(call_put_flag,fut_price1,fut_price2,strike,time,rate,volatility1,volatility2,rho) 2353@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2354@{fut_price1}: price of the first futures contract 2355@{fut_price2}: price of the second futures contract 2356@{strike}: strike price 2357@{time}: time to maturity in years 2358@{rate}: annualized risk-free interest rate 2359@{volatility1}: annualized volatility in price of the first underlying futures contract 2360@{volatility2}: annualized volatility in price of the second underlying futures contract 2361@{rho}: correlation between the two futures contracts 2362@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2363 2364@CATEGORY=Finance 2365@FUNCTION=OPT_TIME_SWITCH 2366@SHORTDESC=theoretical price of time switch options 2367@SYNTAX=OPT_TIME_SWITCH(call_put_flag,spot,strike,a,time,m,dt,rate,cost_of_carry,volatility) 2368@ARGUMENTDESCRIPTION=@{call_put_flag}: 'c' for a call and 'p' for a put 2369@{spot}: spot price 2370@{strike}: strike price 2371@{a}: amount received for each time period 2372@{time}: time to maturity in years 2373@{m}: number of time units the option has already met the condition 2374@{dt}: agreed upon discrete time period expressed as a fraction of a year 2375@{rate}: annualized risk-free interest rate 2376@{cost_of_carry}: net cost of holding the underlying asset 2377@{volatility}: annualized volatility of the asset 2378@DESCRIPTION=OPT_TIME_SWITCH models the theoretical price of time switch options. (Pechtl 1995). The holder receives @{a} * @{dt} for each period that the asset price was greater than @{strike} (for a call) or below it (for a put). 2379@SEEALSO=OPT_BS,OPT_BS_DELTA,OPT_BS_RHO,OPT_BS_THETA,OPT_BS_GAMMA 2380 2381@CATEGORY=Finance 2382@FUNCTION=PMT 2383@SHORTDESC=payment for annuity 2384@SYNTAX=PMT(rate,nper,pv,fv,type) 2385@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 2386@{nper}: number of periods 2387@{pv}: present value 2388@{fv}: future value 2389@{type}: payment type 2390@DESCRIPTION=PMT calculates the payment amount for an annuity. 2391@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 2392@SEEALSO=PV,FV,RATE,ISPMT 2393 2394@CATEGORY=Finance 2395@FUNCTION=PPMT 2396@SHORTDESC=interest payment for period 2397@SYNTAX=PPMT(rate,per,nper,pv,fv,type) 2398@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 2399@{per}: period number 2400@{nper}: number of periods 2401@{pv}: present value 2402@{fv}: future value 2403@{type}: payment type 2404@DESCRIPTION=PPMT calculates the principal part of an annuity's payment for period number @{per}. 2405@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 2406@SEEALSO=IPMT 2407 2408@CATEGORY=Finance 2409@FUNCTION=PRICE 2410@SHORTDESC=price of a security 2411@SYNTAX=PRICE(settlement,maturity,rate,yield,redemption,frequency,basis) 2412@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2413@{maturity}: maturity date 2414@{rate}: nominal annual interest rate 2415@{yield}: annual yield of security 2416@{redemption}: amount received at maturity 2417@{frequency}: number of interest payments per year 2418@{basis}: calendar basis 2419@DESCRIPTION=PRICE calculates the price per $100 face value of a security that pays periodic interest. 2420@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2421@SEEALSO=YIELD,DURATION 2422 2423@CATEGORY=Finance 2424@FUNCTION=PRICEDISC 2425@SHORTDESC=discounted price 2426@SYNTAX=PRICEDISC(settlement,maturity,discount,redemption,basis) 2427@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2428@{maturity}: maturity date 2429@{discount}: annual rate at which to discount 2430@{redemption}: amount received at maturity 2431@{basis}: calendar basis 2432@DESCRIPTION=PRICEDISC calculates the price per $100 face value of a bond that does not pay interest at maturity. 2433@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2434@SEEALSO=PRICEMAT 2435 2436@CATEGORY=Finance 2437@FUNCTION=PRICEMAT 2438@SHORTDESC=price at maturity 2439@SYNTAX=PRICEMAT(settlement,maturity,issue,discount,yield,basis) 2440@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2441@{maturity}: maturity date 2442@{issue}: date of issue 2443@{discount}: annual rate at which to discount 2444@{yield}: annual yield of security 2445@{basis}: calendar basis 2446@DESCRIPTION=PRICEMAT calculates the price per $100 face value of a bond that pays interest at maturity. 2447@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2448@SEEALSO=PRICEDISC 2449 2450@CATEGORY=Finance 2451@FUNCTION=PV 2452@SHORTDESC=present value 2453@SYNTAX=PV(rate,nper,pmt,fv,type) 2454@ARGUMENTDESCRIPTION=@{rate}: effective interest rate per period 2455@{nper}: number of periods 2456@{pmt}: payment at each period 2457@{fv}: future value 2458@{type}: payment type 2459@DESCRIPTION=PV calculates the present value of @{fv} which is @{nper} periods into the future, assuming a periodic payment of @{pmt} and an interest rate of @{rate} per period. 2460@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 2461@SEEALSO=FV 2462 2463@CATEGORY=Finance 2464@FUNCTION=RATE 2465@SHORTDESC=rate of investment 2466@SYNTAX=RATE(nper,pmt,pv,fv,type,guess) 2467@ARGUMENTDESCRIPTION=@{nper}: number of periods 2468@{pmt}: payment at each period 2469@{pv}: present value 2470@{fv}: future value 2471@{type}: payment type 2472@{guess}: an estimate of what the result should be 2473@DESCRIPTION=RATE calculates the rate of return. 2474@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. The optional @{guess} is needed because there can be more than one valid result. It defaults to 10%. 2475@SEEALSO=PV,FV 2476 2477@CATEGORY=Finance 2478@FUNCTION=RECEIVED 2479@SHORTDESC=amount to be received at maturity 2480@SYNTAX=RECEIVED(settlement,maturity,investment,rate,basis) 2481@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2482@{maturity}: maturity date 2483@{investment}: amount paid on settlement 2484@{rate}: nominal annual interest rate 2485@{basis}: calendar basis 2486@DESCRIPTION=RECEIVED calculates the amount to be received when a security matures. 2487@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2488@SEEALSO=INTRATE 2489 2490@CATEGORY=Finance 2491@FUNCTION=RRI 2492@SHORTDESC=equivalent interest rate for an investment increasing in value 2493@SYNTAX=RRI(p,pv,fv) 2494@ARGUMENTDESCRIPTION=@{p}: number of periods 2495@{pv}: present value 2496@{fv}: future value 2497@DESCRIPTION=RRI determines an equivalent interest rate for an investment that increases in value. The interest is compounded after each complete period. 2498@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. Note that @{p} need not be an integer but for fractional value the calculated rate is only approximate. 2499@ODF=This function is OpenFormula compatible. 2500@SEEALSO=PV,FV,RATE 2501 2502@CATEGORY=Finance 2503@FUNCTION=SLN 2504@SHORTDESC=depreciation of an asset 2505@SYNTAX=SLN(cost,salvage,life) 2506@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 2507@{salvage}: value after depreciation 2508@{life}: number of periods 2509@DESCRIPTION=SLN calculates the depreciation of an asset using the straight-line method. 2510@SEEALSO=DB,DDB,SYD 2511 2512@CATEGORY=Finance 2513@FUNCTION=SYD 2514@SHORTDESC=sum-of-years depreciation 2515@SYNTAX=SYD(cost,salvage,life,period) 2516@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 2517@{salvage}: value after depreciation 2518@{life}: number of periods 2519@{period}: subject period 2520@DESCRIPTION=SYD calculates the depreciation of an asset using the sum-of-years method. 2521@SEEALSO=DB,DDB,SLN 2522 2523@CATEGORY=Finance 2524@FUNCTION=TBILLEQ 2525@SHORTDESC=bond-equivalent yield for a treasury bill 2526@SYNTAX=TBILLEQ(settlement,maturity,discount) 2527@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2528@{maturity}: maturity date 2529@{discount}: annual rate at which to discount 2530@DESCRIPTION=TBILLEQ calculates the bond-equivalent yield for a treasury bill. 2531@SEEALSO=TBILLPRICE,TBILLYIELD 2532 2533@CATEGORY=Finance 2534@FUNCTION=TBILLPRICE 2535@SHORTDESC=price of a treasury bill 2536@SYNTAX=TBILLPRICE(settlement,maturity,discount) 2537@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2538@{maturity}: maturity date 2539@{discount}: annual rate at which to discount 2540@DESCRIPTION=TBILLPRICE calculates the price per $100 face value for a treasury bill. 2541@SEEALSO=TBILLEQ,TBILLYIELD 2542 2543@CATEGORY=Finance 2544@FUNCTION=TBILLYIELD 2545@SHORTDESC=yield of a treasury bill 2546@SYNTAX=TBILLYIELD(settlement,maturity,price) 2547@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2548@{maturity}: maturity date 2549@{price}: price 2550@DESCRIPTION=TBILLYIELD calculates the yield of a treasury bill. 2551@SEEALSO=TBILLEQ,TBILLPRICE 2552 2553@CATEGORY=Finance 2554@FUNCTION=VDB 2555@SHORTDESC=depreciation of an asset 2556@SYNTAX=VDB(cost,salvage,life,start_period,end_period,factor,no_switch) 2557@ARGUMENTDESCRIPTION=@{cost}: initial cost of asset 2558@{salvage}: value after depreciation 2559@{life}: number of periods 2560@{start_period}: first period to accumulate for 2561@{end_period}: last period to accumulate for 2562@{factor}: factor at which the balance declines 2563@{no_switch}: do not switch to straight-line depreciation 2564@DESCRIPTION=VDB calculates the depreciation of an asset for a given period range using the variable-rate declining balance method. 2565@NOTE=If @{no_switch} is FALSE, the calculation switches to straight-line depreciation when depreciation is greater than the declining balance calculation. 2566@SEEALSO=DB,DDB 2567 2568@CATEGORY=Finance 2569@FUNCTION=XIRR 2570@SHORTDESC=internal rate of return 2571@SYNTAX=XIRR(values,dates,guess) 2572@ARGUMENTDESCRIPTION=@{values}: cash flow 2573@{dates}: dates of cash flow 2574@{guess}: an estimate of what the result should be 2575@DESCRIPTION=XIRR calculates the annualized internal rate of return of a cash flow at arbitrary points in time. @{values} lists the payments (negative values) and receipts (positive values) with one value for each entry in @{dates}. 2576@NOTE=The optional @{guess} is needed because there can be more than one valid result. It defaults to 10%. 2577@SEEALSO=IRR 2578 2579@CATEGORY=Finance 2580@FUNCTION=XNPV 2581@SHORTDESC=net present value 2582@SYNTAX=XNPV(rate,values,dates) 2583@ARGUMENTDESCRIPTION=@{rate}: effective annual interest rate 2584@{values}: cash flow 2585@{dates}: dates of cash flow 2586@DESCRIPTION=XNPV calculates the net present value of a cash flow at irregular times. 2587@NOTE=If @{type} is 0, the default, payment is at the end of each period. If @{type} is 1, payment is at the beginning of each period. 2588@SEEALSO=NPV 2589 2590@CATEGORY=Finance 2591@FUNCTION=YIELD 2592@SHORTDESC=yield of a security 2593@SYNTAX=YIELD(settlement,maturity,rate,price,redemption,frequency,basis) 2594@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2595@{maturity}: maturity date 2596@{rate}: nominal annual interest rate 2597@{price}: price of security 2598@{redemption}: amount received at maturity 2599@{frequency}: number of interest payments per year 2600@{basis}: calendar basis 2601@DESCRIPTION=YIELD calculates the yield of a security that pays periodic interest. 2602@NOTE=@{frequency} may be 1 (annual), 2 (semi-annual), or 4 (quarterly). If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2603@SEEALSO=PRICE,DURATION 2604 2605@CATEGORY=Finance 2606@FUNCTION=YIELDDISC 2607@SHORTDESC=yield of a discounted security 2608@SYNTAX=YIELDDISC(settlement,maturity,price,redemption,basis) 2609@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2610@{maturity}: maturity date 2611@{price}: price of security 2612@{redemption}: amount received at maturity 2613@{basis}: calendar basis 2614@DESCRIPTION=YIELDDISC calculates the yield of a discounted security. 2615@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2616@SEEALSO=PRICE,DURATION 2617 2618@CATEGORY=Finance 2619@FUNCTION=YIELDMAT 2620@SHORTDESC=yield of a security 2621@SYNTAX=YIELDMAT(settlement,maturity,issue,rate,price,basis) 2622@ARGUMENTDESCRIPTION=@{settlement}: settlement date 2623@{maturity}: maturity date 2624@{issue}: date of issue 2625@{rate}: nominal annual interest rate 2626@{price}: price of security 2627@{basis}: calendar basis 2628@DESCRIPTION=YIELDMAT calculates the yield of a security for which the interest is paid at maturity date. 2629@NOTE=If @{basis} is 0, then the US 30/360 method is used. If @{basis} is 1, then actual number of days is used. If @{basis} is 2, then actual number of days is used within a month, but years are considered only 360 days. If @{basis} is 3, then actual number of days is used within a month, but years are always considered 365 days. If @{basis} is 4, then the European 30/360 method is used. 2630@SEEALSO=YIELDDISC,YIELD 2631 2632@CATEGORY=Gnumeric 2633@FUNCTION=GNUMERIC_VERSION 2634@SHORTDESC=the current version of Gnumeric 2635@SYNTAX=GNUMERIC_VERSION() 2636@DESCRIPTION=GNUMERIC_VERSION returns the version of gnumeric as a string. 2637 2638@CATEGORY=Information 2639@FUNCTION=CELL 2640@SHORTDESC=information of @{type} about @{cell} 2641@SYNTAX=CELL(type,cell) 2642@ARGUMENTDESCRIPTION=@{type}: string specifying the type of information requested 2643@{cell}: cell reference 2644@DESCRIPTION=@{type} specifies the type of information you want to obtain: 2645 address Returns the given cell reference as text. 2646 col Returns the number of the column in @{cell}. 2647 color Returns 0. 2648 contents Returns the contents of the cell in @{cell}. 2649 column Returns the number of the column in @{cell}. 2650 columnwidth Returns the column width. 2651 coord Returns the absolute address of @{cell}. 2652 datatype same as type 2653 filename Returns the name of the file of @{cell}. 2654 format Returns the code of the format of the cell. 2655 formulatype same as type 2656 locked Returns 1 if @{cell} is locked. 2657 parentheses Returns 1 if @{cell} contains a negative value 2658 and its format displays it with parentheses. 2659 prefix Returns a character indicating the horizontal 2660 alignment of @{cell}. 2661 prefixcharacter same as prefix 2662 protect Returns 1 if @{cell} is locked. 2663 row Returns the number of the row in @{cell}. 2664 sheetname Returns the name of the sheet of @{cell}. 2665 type Returns "l" if @{cell} contains a string, 2666 "v" if it contains some other value, and 2667 "b" if @{cell} is blank. 2668 value Returns the contents of the cell in @{cell}. 2669 width Returns the column width. 2670@EXCEL=This function is Excel compatible. 2671@SEEALSO=INDIRECT 2672 2673@CATEGORY=Information 2674@FUNCTION=COUNTBLANK 2675@SHORTDESC=the number of blank cells in @{range} 2676@SYNTAX=COUNTBLANK(range) 2677@ARGUMENTDESCRIPTION=@{range}: a cell range 2678@EXCEL=This function is Excel compatible. 2679@SEEALSO=COUNT 2680 2681@CATEGORY=Information 2682@FUNCTION=ERROR 2683@SHORTDESC=the error with the given @{name} 2684@SYNTAX=ERROR(name) 2685@ARGUMENTDESCRIPTION=@{name}: string 2686@SEEALSO=ISERROR 2687 2688@CATEGORY=Information 2689@FUNCTION=ERROR.TYPE 2690@SHORTDESC=the type of @{error} 2691@SYNTAX=ERROR.TYPE(error) 2692@ARGUMENTDESCRIPTION=@{error}: an error 2693@DESCRIPTION=ERROR.TYPE returns an error number corresponding to the given error value. The error numbers for error values are: 2694 2695 #DIV/0! 2 2696 #VALUE! 3 2697 #REF! 4 2698 #NAME? 5 2699 #NUM! 6 2700 #N/A 7 2701@EXCEL=This function is Excel compatible. 2702@SEEALSO=ISERROR 2703 2704@CATEGORY=Information 2705@FUNCTION=EXPRESSION 2706@SHORTDESC=expression in @{cell} as a string 2707@SYNTAX=EXPRESSION(cell) 2708@ARGUMENTDESCRIPTION=@{cell}: a cell reference 2709@NOTE=If @{cell} contains no expression, EXPRESSION returns empty. 2710@SEEALSO=TEXT 2711 2712@CATEGORY=Information 2713@FUNCTION=GET.FORMULA 2714@SHORTDESC=the formula in @{cell} as a string 2715@SYNTAX=GET.FORMULA(cell) 2716@ARGUMENTDESCRIPTION=@{cell}: the referenced cell 2717@ODF=GET.FORMULA is the OpenFormula function FORMULA. 2718@SEEALSO=EXPRESSION,ISFORMULA 2719 2720@CATEGORY=Information 2721@FUNCTION=GET.LINK 2722@SHORTDESC=the target of the hyperlink attached to @{cell} as a string 2723@SYNTAX=GET.LINK(cell) 2724@ARGUMENTDESCRIPTION=@{cell}: the referenced cell 2725@NOTE=The value return is not updated automatically when the link attached to @{cell} changes but requires a recalculation. 2726@SEEALSO=HYPERLINK 2727 2728@CATEGORY=Information 2729@FUNCTION=GETENV 2730@SHORTDESC=the value of execution environment variable @{name} 2731@SYNTAX=GETENV(name) 2732@ARGUMENTDESCRIPTION=@{name}: the name of the environment variable 2733@NOTE=If a variable called @{name} does not exist, #N/A will be returned. Variable names are case sensitive. 2734 2735@CATEGORY=Information 2736@FUNCTION=INFO 2737@SHORTDESC=information about the current operating environment according to @{type} 2738@SYNTAX=INFO(type) 2739@ARGUMENTDESCRIPTION=@{type}: string giving the type of information requested 2740@DESCRIPTION=INFO returns information about the current operating environment according to @{type}: 2741 memavail Returns the amount of memory available, bytes. 2742 memused Returns the amount of memory used (bytes). 2743 numfile Returns the number of active worksheets. 2744 osversion Returns the operating system version. 2745 recalc Returns the recalculation mode (automatic). 2746 release Returns the version of Gnumeric as text. 2747 system Returns the name of the environment. 2748 totmem Returns the amount of total memory available. 2749@EXCEL=This function is Excel compatible. 2750@SEEALSO=CELL 2751 2752@CATEGORY=Information 2753@FUNCTION=ISBLANK 2754@SHORTDESC=TRUE if @{value} is blank 2755@SYNTAX=ISBLANK(value) 2756@ARGUMENTDESCRIPTION=@{value}: a value 2757@DESCRIPTION=This function checks if a value is blank. Empty cells are blank, but empty strings are not. 2758@EXCEL=This function is Excel compatible. 2759 2760@CATEGORY=Information 2761@FUNCTION=ISERR 2762@SHORTDESC=TRUE if @{value} is any error value except #N/A 2763@SYNTAX=ISERR(value) 2764@ARGUMENTDESCRIPTION=@{value}: a value 2765@EXCEL=This function is Excel compatible. 2766@SEEALSO=ISERROR 2767 2768@CATEGORY=Information 2769@FUNCTION=ISERROR 2770@SHORTDESC=TRUE if @{value} is any error value 2771@SYNTAX=ISERROR(value) 2772@ARGUMENTDESCRIPTION=@{value}: a value 2773@EXCEL=This function is Excel compatible. 2774@SEEALSO=ISERR,ISNA 2775 2776@CATEGORY=Information 2777@FUNCTION=ISEVEN 2778@SHORTDESC=TRUE if @{n} is even 2779@SYNTAX=ISEVEN(n) 2780@ARGUMENTDESCRIPTION=@{n}: number 2781@EXCEL=This function is Excel compatible. 2782@SEEALSO=ISODD 2783 2784@CATEGORY=Information 2785@FUNCTION=ISFORMULA 2786@SHORTDESC=TRUE if @{cell} contains a formula 2787@SYNTAX=ISFORMULA(cell) 2788@ARGUMENTDESCRIPTION=@{cell}: the referenced cell 2789@ODF=ISFORMULA is OpenFormula compatible. 2790@SEEALSO=GET.FORMULA 2791 2792@CATEGORY=Information 2793@FUNCTION=ISLOGICAL 2794@SHORTDESC=TRUE if @{value} is a logical value 2795@SYNTAX=ISLOGICAL(value) 2796@ARGUMENTDESCRIPTION=@{value}: a value 2797@DESCRIPTION=This function checks if a value is either TRUE or FALSE. 2798@EXCEL=This function is Excel compatible. 2799 2800@CATEGORY=Information 2801@FUNCTION=ISNA 2802@SHORTDESC=TRUE if @{value} is the #N/A error value 2803@SYNTAX=ISNA(value) 2804@ARGUMENTDESCRIPTION=@{value}: a value 2805@EXCEL=This function is Excel compatible. 2806@SEEALSO=NA 2807 2808@CATEGORY=Information 2809@FUNCTION=ISNONTEXT 2810@SHORTDESC=TRUE if @{value} is not text 2811@SYNTAX=ISNONTEXT(value) 2812@ARGUMENTDESCRIPTION=@{value}: a value 2813@EXCEL=This function is Excel compatible. 2814@SEEALSO=ISTEXT 2815 2816@CATEGORY=Information 2817@FUNCTION=ISNUMBER 2818@SHORTDESC=TRUE if @{value} is a number 2819@SYNTAX=ISNUMBER(value) 2820@ARGUMENTDESCRIPTION=@{value}: a value 2821@DESCRIPTION=This function checks if a value is a number. Neither TRUE nor FALSE are numbers for this purpose. 2822@EXCEL=This function is Excel compatible. 2823 2824@CATEGORY=Information 2825@FUNCTION=ISODD 2826@SHORTDESC=TRUE if @{n} is odd 2827@SYNTAX=ISODD(n) 2828@ARGUMENTDESCRIPTION=@{n}: number 2829@EXCEL=This function is Excel compatible. 2830@SEEALSO=ISEVEN 2831 2832@CATEGORY=Information 2833@FUNCTION=ISREF 2834@SHORTDESC=TRUE if @{value} is a reference 2835@SYNTAX=ISREF(value,…) 2836@ARGUMENTDESCRIPTION=@{value}: a value 2837@DESCRIPTION=This function checks if a value is a cell reference. 2838@EXCEL=This function is Excel compatible. 2839 2840@CATEGORY=Information 2841@FUNCTION=ISTEXT 2842@SHORTDESC=TRUE if @{value} is text 2843@SYNTAX=ISTEXT(value) 2844@ARGUMENTDESCRIPTION=@{value}: a value 2845@EXCEL=This function is Excel compatible. 2846@SEEALSO=ISNONTEXT 2847 2848@CATEGORY=Information 2849@FUNCTION=N 2850@SHORTDESC=@{text} converted to a number 2851@SYNTAX=N(text) 2852@ARGUMENTDESCRIPTION=@{text}: string 2853@NOTE=If @{text} contains non-numerical text, 0 is returned. 2854@EXCEL=This function is Excel compatible. 2855 2856@CATEGORY=Information 2857@FUNCTION=NA 2858@SHORTDESC=the error value #N/A 2859@SYNTAX=NA() 2860@EXCEL=This function is Excel compatible. 2861@SEEALSO=ISNA 2862 2863@CATEGORY=Information 2864@FUNCTION=TYPE 2865@SHORTDESC=a number indicating the data type of @{value} 2866@SYNTAX=TYPE(value) 2867@ARGUMENTDESCRIPTION=@{value}: a value 2868@DESCRIPTION=TYPE returns a number indicating the data type of @{value}: 28691 = number 28702 = text 28714 = boolean 287216 = error 287364 = array 2874@EXCEL=This function is Excel compatible. 2875 2876@CATEGORY=Logic 2877@FUNCTION=AND 2878@SHORTDESC=logical conjunction 2879@SYNTAX=AND(b0,b1,…) 2880@ARGUMENTDESCRIPTION=@{b0}: logical value 2881@{b1}: logical value 2882@DESCRIPTION=AND calculates the logical conjunction of its arguments @{b0},@{b1},... 2883@NOTE=If an argument is numerical, zero is considered FALSE and anything else TRUE. Strings and empty values are ignored. If no logical values are provided, then the error #VALUE! is returned. This function is strict: if any argument is an error, the result will be the first such error. 2884@EXCEL=This function is Excel compatible. 2885@SEEALSO=OR,NOT,IF 2886 2887@CATEGORY=Logic 2888@FUNCTION=FALSE 2889@SHORTDESC=the value FALSE 2890@SYNTAX=FALSE() 2891@DESCRIPTION=FALSE returns the value FALSE. 2892@EXCEL=This function is Excel compatible. 2893@SEEALSO=TRUE,IF 2894 2895@CATEGORY=Logic 2896@FUNCTION=IF 2897@SHORTDESC=conditional expression 2898@SYNTAX=IF(cond,trueval,falseval) 2899@ARGUMENTDESCRIPTION=@{cond}: condition 2900@{trueval}: value to use if condition is true 2901@{falseval}: value to use if condition is false 2902@DESCRIPTION=This function first evaluates the condition. If the result is true, it will then evaluate and return the second argument. Otherwise, it will evaluate and return the last argument. 2903@SEEALSO=AND,OR,XOR,NOT,IFERROR 2904 2905@CATEGORY=Logic 2906@FUNCTION=IFERROR 2907@SHORTDESC=test for error 2908@SYNTAX=IFERROR(x,y) 2909@ARGUMENTDESCRIPTION=@{x}: value to test for error 2910@{y}: alternate value 2911@DESCRIPTION=This function returns the first value, unless that is an error, in which case it returns the second. 2912@SEEALSO=IF,ISERROR 2913 2914@CATEGORY=Logic 2915@FUNCTION=IFNA 2916@SHORTDESC=test for #N/A error 2917@SYNTAX=IFNA(x,y) 2918@ARGUMENTDESCRIPTION=@{x}: value to test for #N/A error 2919@{y}: alternate value 2920@DESCRIPTION=This function returns the first value, unless that is #N/A, in which case it returns the second. 2921@SEEALSO=IF,ISERROR 2922 2923@CATEGORY=Logic 2924@FUNCTION=IFS 2925@SHORTDESC=multi-branch conditional 2926@SYNTAX=IFS(cond1,value1,cond2,value2,…) 2927@ARGUMENTDESCRIPTION=@{cond1}: condition 2928@{value1}: value if @{condition1} is true 2929@{cond2}: condition 2930@{value2}: value if @{condition2} is true 2931@DESCRIPTION=This function returns the value after the first true conditional. If no conditional is true, #VALUE! is returned. 2932@SEEALSO=IF 2933 2934@CATEGORY=Logic 2935@FUNCTION=NOT 2936@SHORTDESC=logical negation 2937@SYNTAX=NOT(b) 2938@ARGUMENTDESCRIPTION=@{b}: logical value 2939@DESCRIPTION=NOT calculates the logical negation of its argument. 2940@NOTE=If the argument is numerical, zero is considered FALSE and anything else TRUE. Strings and empty values are ignored. 2941@EXCEL=This function is Excel compatible. 2942@SEEALSO=AND,OR,IF 2943 2944@CATEGORY=Logic 2945@FUNCTION=OR 2946@SHORTDESC=logical disjunction 2947@SYNTAX=OR(b0,b1,…) 2948@ARGUMENTDESCRIPTION=@{b0}: logical value 2949@{b1}: logical value 2950@DESCRIPTION=OR calculates the logical disjunction of its arguments @{b0},@{b1},... 2951@NOTE=If an argument is numerical, zero is considered FALSE and anything else TRUE. Strings and empty values are ignored. If no logical values are provided, then the error #VALUE! is returned. This function is strict: if any argument is an error, the result will be the first such error. 2952@EXCEL=This function is Excel compatible. 2953@SEEALSO=AND,XOR,NOT,IF 2954 2955@CATEGORY=Logic 2956@FUNCTION=SWITCH 2957@SHORTDESC=multi-branch selector 2958@SYNTAX=SWITCH(ref,choice1,value1,choice2,value2,…) 2959@ARGUMENTDESCRIPTION=@{ref}: value 2960@{choice1}: first choice value 2961@{value1}: first result value 2962@{choice2}: second choice value 2963@{value2}: second result value 2964@DESCRIPTION=This function compares the reference value, @{ref}, against the choice values, @{choice1} etc., and returns the corresponding result value when it finds a match. The choices may be followed by a default value to use. If there are no choices that match and no default value, #N/A is return. 2965@SEEALSO=IF,IFS 2966 2967@CATEGORY=Logic 2968@FUNCTION=TRUE 2969@SHORTDESC=the value TRUE 2970@SYNTAX=TRUE() 2971@DESCRIPTION=TRUE returns the value TRUE. 2972@EXCEL=This function is Excel compatible. 2973@SEEALSO=FALSE,IF 2974 2975@CATEGORY=Logic 2976@FUNCTION=XOR 2977@SHORTDESC=logical exclusive disjunction 2978@SYNTAX=XOR(b0,b1,…) 2979@ARGUMENTDESCRIPTION=@{b0}: logical value 2980@{b1}: logical value 2981@DESCRIPTION=XOR calculates the logical exclusive disjunction of its arguments @{b0},@{b1},... 2982@NOTE=If an argument is numerical, zero is considered FALSE and anything else TRUE. Strings and empty values are ignored. If no logical values are provided, then the error #VALUE! is returned. This function is strict: if any argument is an error, the result will be the first such error. 2983@SEEALSO=OR,AND,NOT,IF 2984 2985@CATEGORY=Lookup 2986@FUNCTION=ADDRESS 2987@SHORTDESC=cell address as text 2988@SYNTAX=ADDRESS(row_num,col_num,abs_num,a1,text) 2989@ARGUMENTDESCRIPTION=@{row_num}: row number 2990@{col_num}: column number 2991@{abs_num}: 1 for an absolute, 2 for a row absolute and column relative, 3 for a row relative and column absolute, and 4 for a relative reference; defaults to 1 2992@{a1}: if TRUE, an A1-style reference is provided, otherwise an R1C1-style reference; defaults to TRUE 2993@{text}: name of the worksheet, defaults to no sheet 2994@NOTE=If @{row_num} or @{col_num} is less than one, ADDRESS returns #VALUE! If @{abs_num} is greater than 4 ADDRESS returns #VALUE! 2995@SEEALSO=COLUMNNUMBER 2996 2997@CATEGORY=Lookup 2998@FUNCTION=AREAS 2999@SHORTDESC=number of areas in @{reference} 3000@SYNTAX=AREAS(reference,…) 3001@ARGUMENTDESCRIPTION=@{reference}: range 3002@SEEALSO=ADDRESS,INDEX,INDIRECT,OFFSET 3003 3004@CATEGORY=Lookup 3005@FUNCTION=ARRAY 3006@SHORTDESC=vertical array of the arguments 3007@SYNTAX=ARRAY(v,…) 3008@ARGUMENTDESCRIPTION=@{v}: value 3009@SEEALSO=TRANSPOSE 3010 3011@CATEGORY=Lookup 3012@FUNCTION=CHOOSE 3013@SHORTDESC=the (@{index}+1)th argument 3014@SYNTAX=CHOOSE(index,value1,value2,…) 3015@ARGUMENTDESCRIPTION=@{index}: positive number 3016@{value1}: first value 3017@{value2}: second value 3018@DESCRIPTION=CHOOSE returns its (@{index}+1)th argument. 3019@NOTE=@{index} is truncated to an integer. If @{index} < 1 or the truncated @{index} > number of values, CHOOSE returns #VALUE! 3020@SEEALSO=IF 3021 3022@CATEGORY=Lookup 3023@FUNCTION=COLUMN 3024@SHORTDESC=vector of column numbers 3025@SYNTAX=COLUMN(x) 3026@ARGUMENTDESCRIPTION=@{x}: reference, defaults to the position of the current expression 3027@DESCRIPTION=COLUMN function returns a Nx1 array containing the sequence of integers from the first column to the last column of @{x}. 3028@NOTE=If @{x} is neither an array nor a reference nor a range, returns #VALUE! 3029@SEEALSO=COLUMNS,ROW,ROWS 3030 3031@CATEGORY=Lookup 3032@FUNCTION=COLUMNNUMBER 3033@SHORTDESC=column number for the given column called @{name} 3034@SYNTAX=COLUMNNUMBER(name) 3035@ARGUMENTDESCRIPTION=@{name}: column name such as "IV" 3036@NOTE=If @{name} is invalid, COLUMNNUMBER returns #VALUE! 3037@SEEALSO=ADDRESS 3038 3039@CATEGORY=Lookup 3040@FUNCTION=COLUMNS 3041@SHORTDESC=number of columns in @{reference} 3042@SYNTAX=COLUMNS(reference) 3043@ARGUMENTDESCRIPTION=@{reference}: array or area 3044@NOTE=If @{reference} is neither an array nor a reference nor a range, COLUMNS returns #VALUE! 3045@SEEALSO=COLUMN,ROW,ROWS 3046 3047@CATEGORY=Lookup 3048@FUNCTION=FLIP 3049@SHORTDESC=@{matrix} flipped 3050@SYNTAX=FLIP(matrix,vertical) 3051@ARGUMENTDESCRIPTION=@{matrix}: range 3052@{vertical}: if true, @{matrix} is flipped vertically, otherwise horizontally; defaults to TRUE 3053@SEEALSO=TRANSPOSE 3054 3055@CATEGORY=Lookup 3056@FUNCTION=HLOOKUP 3057@SHORTDESC=search the first row of @{range} for @{value} 3058@SYNTAX=HLOOKUP(value,range,row,approximate,as_index) 3059@ARGUMENTDESCRIPTION=@{value}: search value 3060@{range}: range to search 3061@{row}: 1-based row offset indicating the return values 3062@{approximate}: if false, an exact match of @{value} must be found; defaults to TRUE 3063@{as_index}: if true, the 0-based column offset is returned; defaults to FALSE 3064@DESCRIPTION=HLOOKUP function finds the row in @{range} that has a first cell similar to @{value}. If @{approximate} is not true it finds the column with an exact equality. If @{approximate} is true, it finds the last column with first value less than or equal to @{value}. If @{as_index} is true the 0-based column offset is returned. 3065@NOTE=If @{approximate} is true, then the values must be sorted in order of ascending value. HLOOKUP returns #REF! if @{row} falls outside @{range}. 3066@SEEALSO=VLOOKUP 3067 3068@CATEGORY=Lookup 3069@FUNCTION=HYPERLINK 3070@SHORTDESC=second or first arguments 3071@SYNTAX=HYPERLINK(link_location,label) 3072@ARGUMENTDESCRIPTION=@{link_location}: string 3073@{label}: string, optional 3074@DESCRIPTION=HYPERLINK function currently returns its 2nd argument, or if that is omitted the 1st argument. 3075 3076@CATEGORY=Lookup 3077@FUNCTION=INDEX 3078@SHORTDESC=reference to a cell in the given @{array} 3079@SYNTAX=INDEX(array,row,col,area,…) 3080@ARGUMENTDESCRIPTION=@{array}: cell or inline array 3081@{row}: desired row, defaults to 1 3082@{col}: desired column, defaults to 1 3083@{area}: from which area to select a cell, defaults to 1 3084@DESCRIPTION=INDEX gives a reference to a cell in the given @{array}. The cell is selected by @{row} and @{col}, which count the rows and columns in the array. 3085@NOTE=If the reference falls outside the range of @{array}, INDEX returns #REF! 3086 3087@CATEGORY=Lookup 3088@FUNCTION=INDIRECT 3089@SHORTDESC=contents of the cell pointed to by the @{ref_text} string 3090@SYNTAX=INDIRECT(ref_text,format) 3091@ARGUMENTDESCRIPTION=@{ref_text}: textual reference 3092@{format}: if true, @{ref_text} is given in A1-style, otherwise it is given in R1C1 style; defaults to true 3093@NOTE=If @{ref_text} is not a valid reference in the style determined by @{format}, INDIRECT returns #REF! 3094@SEEALSO=AREAS,INDEX,CELL 3095 3096@CATEGORY=Lookup 3097@FUNCTION=LOOKUP 3098@SHORTDESC=contents of @{vector2} at the corresponding location to @{value} in @{vector1} 3099@SYNTAX=LOOKUP(value,vector1,vector2) 3100@ARGUMENTDESCRIPTION=@{value}: value to look up 3101@{vector1}: range to search: 3102@{vector2}: range of return values 3103@DESCRIPTION=If @{vector1} has more rows than columns, LOOKUP searches the first row of @{vector1}, otherwise the first column. If @{vector2} is omitted the return value is taken from the last row or column of @{vector1}. 3104@NOTE=If LOOKUP can't find @{value} it uses the largest value less than @{value}. The data must be sorted. If @{value} is smaller than the first value it returns #N/A. If the corresponding location does not exist in @{vector2}, it returns #N/A. 3105@SEEALSO=VLOOKUP,HLOOKUP 3106 3107@CATEGORY=Lookup 3108@FUNCTION=MATCH 3109@SHORTDESC=the index of @{seek} in @{vector} 3110@SYNTAX=MATCH(seek,vector,type) 3111@ARGUMENTDESCRIPTION=@{seek}: value to find 3112@{vector}: n by 1 or 1 by n range to be searched 3113@{type}: +1 (the default) to find the largest value ≤ @{seek}, 0 to find the first value = @{seek}, or -1 to find the smallest value ≥ @{seek} 3114@DESCRIPTION=MATCH searches @{vector} for @{seek} and returns the 1-based index. 3115@NOTE=For @{type} = -1 the data must be sorted in descending order; for @{type} = +1 the data must be sorted in ascending order. If @{seek} could not be found, #N/A is returned. If @{vector} is neither n by 1 nor 1 by n, #N/A is returned. 3116@SEEALSO=LOOKUP 3117 3118@CATEGORY=Lookup 3119@FUNCTION=OFFSET 3120@SHORTDESC=an offset cell range 3121@SYNTAX=OFFSET(range,row,col,height,width) 3122@ARGUMENTDESCRIPTION=@{range}: reference or range 3123@{row}: number of rows to offset @{range} 3124@{col}: number of columns to offset @{range} 3125@{height}: height of the offset range, defaults to height of @{range} 3126@{width}: width of the offset range, defaults to width of @{range} 3127@DESCRIPTION=OFFSET returns the cell range starting at offset (@{row},@{col}) from @{range} of height @{height} and width @{width}. 3128@NOTE=If @{range} is neither a reference nor a range, OFFSET returns #VALUE! 3129@SEEALSO=COLUMN,COLUMNS,ROWS,INDEX,INDIRECT,ADDRESS 3130 3131@CATEGORY=Lookup 3132@FUNCTION=ROW 3133@SHORTDESC=vector of row numbers 3134@SYNTAX=ROW(x) 3135@ARGUMENTDESCRIPTION=@{x}: reference, defaults to the position of the current expression 3136@DESCRIPTION=ROW function returns a 1xN array containing the sequence of integers from the first row to the last row of @{x}. 3137@NOTE=If @{x} is neither an array nor a reference nor a range, returns #VALUE! 3138@SEEALSO=COLUMN,COLUMNS,ROWS 3139 3140@CATEGORY=Lookup 3141@FUNCTION=ROWS 3142@SHORTDESC=number of rows in @{reference} 3143@SYNTAX=ROWS(reference) 3144@ARGUMENTDESCRIPTION=@{reference}: array, reference, or range 3145@NOTE=If @{reference} is neither an array nor a reference nor a range, ROWS returns #VALUE! 3146@SEEALSO=COLUMN,COLUMNS,ROW 3147 3148@CATEGORY=Lookup 3149@FUNCTION=SHEET 3150@SHORTDESC=sheet number of @{reference} 3151@SYNTAX=SHEET(reference) 3152@ARGUMENTDESCRIPTION=@{reference}: reference or literal sheet name, defaults to the current sheet 3153@NOTE=If @{reference} is neither a reference nor a literal sheet name, SHEET returns #VALUE! 3154@SEEALSO=SHEETS,ROW,COLUMNNUMBER 3155 3156@CATEGORY=Lookup 3157@FUNCTION=SHEETS 3158@SHORTDESC=number of sheets in @{reference} 3159@SYNTAX=SHEETS(reference) 3160@ARGUMENTDESCRIPTION=@{reference}: array, reference, or range, defaults to the maximum range 3161@NOTE=If @{reference} is neither an array nor a reference nor a range, SHEETS returns #VALUE! 3162@SEEALSO=COLUMNS,ROWS 3163 3164@CATEGORY=Lookup 3165@FUNCTION=SORT 3166@SHORTDESC=sorted list of numbers as vertical array 3167@SYNTAX=SORT(ref,order) 3168@ARGUMENTDESCRIPTION=@{ref}: list of numbers 3169@{order}: 0 (descending order) or 1 (ascending order); defaults to 0 3170@NOTE=Strings, booleans, and empty cells are ignored. 3171@SEEALSO=ARRAY 3172 3173@CATEGORY=Lookup 3174@FUNCTION=TRANSPOSE 3175@SHORTDESC=the transpose of @{matrix} 3176@SYNTAX=TRANSPOSE(matrix) 3177@ARGUMENTDESCRIPTION=@{matrix}: range 3178@SEEALSO=FLIP,MMULT 3179 3180@CATEGORY=Lookup 3181@FUNCTION=VLOOKUP 3182@SHORTDESC=search the first column of @{range} for @{value} 3183@SYNTAX=VLOOKUP(value,range,column,approximate,as_index) 3184@ARGUMENTDESCRIPTION=@{value}: search value 3185@{range}: range to search 3186@{column}: 1-based column offset indicating the return values 3187@{approximate}: if false, an exact match of @{value} must be found; defaults to TRUE 3188@{as_index}: if true, the 0-based row offset is returned; defaults to FALSE 3189@DESCRIPTION=VLOOKUP function finds the row in @{range} that has a first cell similar to @{value}. If @{approximate} is not true it finds the row with an exact equality. If @{approximate} is true, it finds the last row with first value less than or equal to @{value}. If @{as_index} is true the 0-based row offset is returned. 3190@NOTE=If @{approximate} is true, then the values must be sorted in order of ascending value. VLOOKUP returns #REF! if @{column} falls outside @{range}. 3191@SEEALSO=HLOOKUP 3192 3193@CATEGORY=Mathematics 3194@FUNCTION=ABS 3195@SHORTDESC=absolute value 3196@SYNTAX=ABS(x) 3197@ARGUMENTDESCRIPTION=@{x}: number 3198@DESCRIPTION=ABS gives the absolute value of @{x}, i.e. the non-negative number of the same magnitude as @{x}. 3199@EXCEL=This function is Excel compatible. 3200@SEEALSO=CEIL,CEILING,FLOOR,INT,MOD 3201 3202@CATEGORY=Mathematics 3203@FUNCTION=ACOS 3204@SHORTDESC=the arc cosine of @{x} 3205@SYNTAX=ACOS(x) 3206@ARGUMENTDESCRIPTION=@{x}: number 3207@EXCEL=This function is Excel compatible. 3208@SEEALSO=COS,SIN,DEGREES,RADIANS 3209 3210@CATEGORY=Mathematics 3211@FUNCTION=ACOSH 3212@SHORTDESC=the hyperbolic arc cosine of @{x} 3213@SYNTAX=ACOSH(x) 3214@ARGUMENTDESCRIPTION=@{x}: number 3215@EXCEL=This function is Excel compatible. 3216@SEEALSO=ACOS,ASINH 3217 3218@CATEGORY=Mathematics 3219@FUNCTION=ACOT 3220@SHORTDESC=inverse cotangent of @{x} 3221@SYNTAX=ACOT(x) 3222@ARGUMENTDESCRIPTION=@{x}: value 3223@SEEALSO=COT,TAN 3224 3225@CATEGORY=Mathematics 3226@FUNCTION=ACOTH 3227@SHORTDESC=the inverse hyperbolic cotangent of @{x} 3228@SYNTAX=ACOTH(x) 3229@ARGUMENTDESCRIPTION=@{x}: number 3230@SEEALSO=COTH,TANH 3231 3232@CATEGORY=Mathematics 3233@FUNCTION=AGM 3234@SHORTDESC=the arithmetic-geometric mean 3235@SYNTAX=AGM(a,b) 3236@ARGUMENTDESCRIPTION=@{a}: value 3237@{b}: value 3238@DESCRIPTION=AGM computes the arithmetic-geometric mean of the two values. 3239@SEEALSO=AVERAGE,GEOMEAN 3240 3241@CATEGORY=Mathematics 3242@FUNCTION=ARABIC 3243@SHORTDESC=the Roman numeral @{roman} as number 3244@SYNTAX=ARABIC(roman) 3245@ARGUMENTDESCRIPTION=@{roman}: Roman numeral 3246@DESCRIPTION=Any Roman symbol to the left of a larger symbol (directly or indirectly) reduces the final value by the symbol amount, otherwise, it increases the final amount by the symbol's amount. 3247@ODF=This function is OpenFormula compatible. 3248@SEEALSO=ROMAN 3249 3250@CATEGORY=Mathematics 3251@FUNCTION=ASIN 3252@SHORTDESC=the arc sine of @{x} 3253@SYNTAX=ASIN(x) 3254@ARGUMENTDESCRIPTION=@{x}: number 3255@DESCRIPTION=ASIN calculates the arc sine of @{x}; that is the value whose sine is @{x}. 3256@NOTE=If @{x} falls outside the range -1 to 1, ASIN returns #NUM! 3257@EXCEL=This function is Excel compatible. 3258@SEEALSO=SIN,COS,ASINH,DEGREES,RADIANS 3259 3260@CATEGORY=Mathematics 3261@FUNCTION=ASINH 3262@SHORTDESC=the inverse hyperbolic sine of @{x} 3263@SYNTAX=ASINH(x) 3264@ARGUMENTDESCRIPTION=@{x}: number 3265@DESCRIPTION=ASINH calculates the inverse hyperbolic sine of @{x}; that is the value whose hyperbolic sine is @{x}. 3266@EXCEL=This function is Excel compatible. 3267@SEEALSO=ASIN,ACOSH,SIN,COS 3268 3269@CATEGORY=Mathematics 3270@FUNCTION=ATAN 3271@SHORTDESC=the arc tangent of @{x} 3272@SYNTAX=ATAN(x) 3273@ARGUMENTDESCRIPTION=@{x}: number 3274@DESCRIPTION=ATAN calculates the arc tangent of @{x}; that is the value whose tangent is @{x}. 3275@NOTE=The result will be between −π/2 and +π/2. 3276@EXCEL=This function is Excel compatible. 3277@SEEALSO=TAN,COS,SIN,DEGREES,RADIANS 3278 3279@CATEGORY=Mathematics 3280@FUNCTION=ATAN2 3281@SHORTDESC=the arc tangent of the ratio @{y}/@{x} 3282@SYNTAX=ATAN2(x,y) 3283@ARGUMENTDESCRIPTION=@{x}: x-coordinate 3284@{y}: y-coordinate 3285@DESCRIPTION=ATAN2 calculates the direction from the origin to the point (@{x},@{y}) as an angle from the x-axis in radians. 3286@NOTE=The result will be between −π and +π. The order of the arguments may be unexpected. 3287@EXCEL=This function is Excel compatible. 3288@ODF=This function is OpenFormula compatible. 3289@SEEALSO=ATAN,ATANH,COS,SIN 3290 3291@CATEGORY=Mathematics 3292@FUNCTION=ATANH 3293@SHORTDESC=the inverse hyperbolic tangent of @{x} 3294@SYNTAX=ATANH(x) 3295@ARGUMENTDESCRIPTION=@{x}: number 3296@DESCRIPTION=ATANH calculates the inverse hyperbolic tangent of @{x}; that is the value whose hyperbolic tangent is @{x}. 3297@NOTE=If the absolute value of @{x} is greater than 1.0, ATANH returns #NUM! 3298@EXCEL=This function is Excel compatible. 3299@SEEALSO=ATAN,COS,SIN 3300 3301@CATEGORY=Mathematics 3302@FUNCTION=AVERAGEIF 3303@SHORTDESC=average of the cells in @{actual range} for which the corresponding cells in the range meet the given @{criteria} 3304@SYNTAX=AVERAGEIF(range,criteria,actual_range) 3305@ARGUMENTDESCRIPTION=@{range}: cell area 3306@{criteria}: condition for a cell to be included 3307@{actual_range}: cell area, defaults to @{range} 3308@EXCEL=This function is Excel compatible. 3309@SEEALSO=SUMIF,COUNTIF 3310 3311@CATEGORY=Mathematics 3312@FUNCTION=AVERAGEIFS 3313@SHORTDESC=average of the cells in @{actual_range} for which the corresponding cells in the range meet the given criteria 3314@SYNTAX=AVERAGEIFS(actual_range,range1,criteria1,…) 3315@ARGUMENTDESCRIPTION=@{actual_range}: cell area 3316@{range1}: cell area 3317@{criteria1}: condition for a cell to be included 3318@EXCEL=This function is Excel compatible. 3319@SEEALSO=AVERAGE,AVERAGEIF 3320 3321@CATEGORY=Mathematics 3322@FUNCTION=BETA 3323@SHORTDESC=Euler beta function 3324@SYNTAX=BETA(x,y) 3325@ARGUMENTDESCRIPTION=@{x}: number 3326@{y}: number 3327@DESCRIPTION=BETA function returns the value of the Euler beta function extended to all real numbers except 0 and negative integers. 3328@NOTE=If @{x}, @{y}, or (@{x} + @{y}) are non-positive integers, BETA returns #NUM! 3329@SEEALSO=BETALN,GAMMALN 3330 3331@CATEGORY=Mathematics 3332@FUNCTION=BETALN 3333@SHORTDESC=natural logarithm of the absolute value of the Euler beta function 3334@SYNTAX=BETALN(x,y) 3335@ARGUMENTDESCRIPTION=@{x}: number 3336@{y}: number 3337@DESCRIPTION=BETALN function returns the natural logarithm of the absolute value of the Euler beta function extended to all real numbers except 0 and negative integers. 3338@NOTE=If @{x}, @{y}, or (@{x} + @{y}) are non-positive integers, BETALN returns #NUM! 3339@SEEALSO=BETA,GAMMALN 3340 3341@CATEGORY=Mathematics 3342@FUNCTION=CEIL 3343@SHORTDESC=smallest integer larger than or equal to @{x} 3344@SYNTAX=CEIL(x) 3345@ARGUMENTDESCRIPTION=@{x}: number 3346@DESCRIPTION=CEIL(@{x}) is the smallest integer that is at least as large as @{x}. 3347@ODF=This function is the OpenFormula function CEILING(@{x}). 3348@SEEALSO=CEILING,FLOOR,ABS,INT,MOD 3349 3350@CATEGORY=Mathematics 3351@FUNCTION=CEILING 3352@SHORTDESC=nearest multiple of @{significance} whose absolute value is at least ABS(@{x}) 3353@SYNTAX=CEILING(x,significance) 3354@ARGUMENTDESCRIPTION=@{x}: number 3355@{significance}: base multiple (defaults to 1 for @{x} > 0 and -1 for @{x} < 0) 3356@DESCRIPTION=CEILING(@{x},@{significance}) is the nearest multiple of @{significance} whose absolute value is at least ABS(@{x}). 3357@NOTE=If @{x} or @{significance} is non-numeric, CEILING returns a #VALUE! error. If @{x} and @{significance} have different signs, CEILING returns a #NUM! error. 3358@EXCEL=This function is Excel compatible. 3359@ODF=CEILING(@{x}) is exported to ODF as CEILING(@{x},SIGN(@{x}),1). CEILING(@{x},@{significance}) is the OpenFormula function CEILING(@{x},@{significance},1). 3360@SEEALSO=CEIL,FLOOR,ABS,INT,MOD 3361 3362@CATEGORY=Mathematics 3363@FUNCTION=CHOLESKY 3364@SHORTDESC=the Cholesky decomposition of the symmetric positive-definite @{matrix} 3365@SYNTAX=CHOLESKY(matrix) 3366@ARGUMENTDESCRIPTION=@{matrix}: a symmetric positive definite matrix 3367@NOTE=If the Cholesky-Banachiewicz algorithm applied to @{matrix} fails, Cholesky returns #NUM! If @{matrix} does not contain an equal number of columns and rows, CHOLESKY returns #VALUE! 3368@SEEALSO=MINVERSE,MMULT,MDETERM 3369 3370@CATEGORY=Mathematics 3371@FUNCTION=COMBIN 3372@SHORTDESC=binomial coefficient 3373@SYNTAX=COMBIN(n,k) 3374@ARGUMENTDESCRIPTION=@{n}: non-negative integer 3375@{k}: non-negative integer 3376@DESCRIPTION=COMBIN returns the binomial coefficient "@{n} choose @{k}", the number of @{k}-combinations of an @{n}-element set without repetition. 3377@NOTE=If @{n} is less than @{k} COMBIN returns #NUM! 3378@EXCEL=This function is Excel compatible. 3379@ODF=This function is OpenFormula compatible. 3380 3381@CATEGORY=Mathematics 3382@FUNCTION=COMBINA 3383@SHORTDESC=the number of @{k}-combinations of an @{n}-element set with repetition 3384@SYNTAX=COMBINA(n,k) 3385@ARGUMENTDESCRIPTION=@{n}: non-negative integer 3386@{k}: non-negative integer 3387@ODF=This function is OpenFormula compatible. 3388@SEEALSO=COMBIN 3389 3390@CATEGORY=Mathematics 3391@FUNCTION=COS 3392@SHORTDESC=the cosine of @{x} 3393@SYNTAX=COS(x) 3394@ARGUMENTDESCRIPTION=@{x}: angle in radians 3395@DESCRIPTION=This function is Excel compatible. 3396@SEEALSO=SIN,TAN,SINH,COSH,TANH,RADIANS,DEGREES 3397 3398@CATEGORY=Mathematics 3399@FUNCTION=COSH 3400@SHORTDESC=the hyperbolic cosine of @{x} 3401@SYNTAX=COSH(x) 3402@ARGUMENTDESCRIPTION=@{x}: number 3403@EXCEL=This function is Excel compatible. 3404@SEEALSO=SIN,TAN,SINH,COSH,TANH 3405 3406@CATEGORY=Mathematics 3407@FUNCTION=COSPI 3408@SHORTDESC=the cosine of Pi*@{x} 3409@SYNTAX=COSPI(x) 3410@ARGUMENTDESCRIPTION=@{x}: number of half turns 3411@SEEALSO=COS 3412 3413@CATEGORY=Mathematics 3414@FUNCTION=COT 3415@SHORTDESC=the cotangent of @{x} 3416@SYNTAX=COT(x) 3417@ARGUMENTDESCRIPTION=@{x}: number 3418@SEEALSO=TAN,ACOT 3419 3420@CATEGORY=Mathematics 3421@FUNCTION=COTH 3422@SHORTDESC=the hyperbolic cotangent of @{x} 3423@SYNTAX=COTH(x) 3424@ARGUMENTDESCRIPTION=@{x}: number 3425@SEEALSO=TANH,ACOTH 3426 3427@CATEGORY=Mathematics 3428@FUNCTION=COTPI 3429@SHORTDESC=the cotangent of Pi*@{x} 3430@SYNTAX=COTPI(x) 3431@ARGUMENTDESCRIPTION=@{x}: number of half turns 3432@SEEALSO=COT 3433 3434@CATEGORY=Mathematics 3435@FUNCTION=COUNTIF 3436@SHORTDESC=count of the cells meeting the given @{criteria} 3437@SYNTAX=COUNTIF(range,criteria) 3438@ARGUMENTDESCRIPTION=@{range}: cell area 3439@{criteria}: condition for a cell to be counted 3440@EXCEL=This function is Excel compatible. 3441@SEEALSO=COUNT,SUMIF 3442 3443@CATEGORY=Mathematics 3444@FUNCTION=COUNTIFS 3445@SHORTDESC=count of the cells meeting the given @{criteria} 3446@SYNTAX=COUNTIFS(range,criteria,…) 3447@ARGUMENTDESCRIPTION=@{range}: cell area 3448@{criteria}: condition for a cell to be counted 3449@EXCEL=This function is Excel compatible. 3450@SEEALSO=COUNT,SUMIF 3451 3452@CATEGORY=Mathematics 3453@FUNCTION=CSC 3454@SHORTDESC=the cosecant of @{x} 3455@SYNTAX=CSC(x) 3456@ARGUMENTDESCRIPTION=@{x}: angle in radians 3457@EXCEL=This function is not Excel compatible. 3458@ODF=This function is OpenFormula compatible. 3459@SEEALSO=SIN,COS,TAN,SEC,SINH,COSH,TANH,RADIANS,DEGREES 3460 3461@CATEGORY=Mathematics 3462@FUNCTION=CSCH 3463@SHORTDESC=the hyperbolic cosecant of @{x} 3464@SYNTAX=CSCH(x) 3465@ARGUMENTDESCRIPTION=@{x}: number 3466@EXCEL=This function is not Excel compatible. 3467@ODF=This function is OpenFormula compatible. 3468@SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH 3469 3470@CATEGORY=Mathematics 3471@FUNCTION=DEGREES 3472@SHORTDESC=equivalent degrees to @{x} radians 3473@SYNTAX=DEGREES(x) 3474@ARGUMENTDESCRIPTION=@{x}: angle in radians 3475@EXCEL=This function is Excel compatible. 3476@SEEALSO=RADIANS,PI 3477 3478@CATEGORY=Mathematics 3479@FUNCTION=EIGEN 3480@SHORTDESC=eigenvalues and eigenvectors of the symmetric @{matrix} 3481@SYNTAX=EIGEN(matrix) 3482@ARGUMENTDESCRIPTION=@{matrix}: a symmetric matrix 3483@NOTE=If @{matrix} is not symmetric, matching off-diagonal cells will be averaged on the assumption that the non-symmetry is caused by unimportant rounding errors. If @{matrix} does not contain an equal number of columns and rows, EIGEN returns #VALUE! 3484 3485@CATEGORY=Mathematics 3486@FUNCTION=EVEN 3487@SHORTDESC=@{x} rounded away from 0 to the next even integer 3488@SYNTAX=EVEN(x) 3489@ARGUMENTDESCRIPTION=@{x}: number 3490@EXCEL=This function is Excel compatible. 3491@SEEALSO=ODD 3492 3493@CATEGORY=Mathematics 3494@FUNCTION=EXP 3495@SHORTDESC=e raised to the power of @{x} 3496@SYNTAX=EXP(x) 3497@ARGUMENTDESCRIPTION=@{x}: number 3498@NOTE=e is the base of the natural logarithm. 3499@EXCEL=This function is Excel compatible. 3500@SEEALSO=LOG,LOG2,LOG10 3501 3502@CATEGORY=Mathematics 3503@FUNCTION=EXPM1 3504@SHORTDESC=EXP(@{x})-1 3505@SYNTAX=EXPM1(x) 3506@ARGUMENTDESCRIPTION=@{x}: number 3507@NOTE=This function has a higher resulting precision than evaluating EXP(@{x})-1. 3508@SEEALSO=EXP,LN1P 3509 3510@CATEGORY=Mathematics 3511@FUNCTION=FACT 3512@SHORTDESC=the factorial of @{x}, i.e. @{x}! 3513@SYNTAX=FACT(x) 3514@ARGUMENTDESCRIPTION=@{x}: number 3515@NOTE=The domain of this function has been extended using the GAMMA function. 3516@EXCEL=This function is Excel compatible. 3517 3518@CATEGORY=Mathematics 3519@FUNCTION=FACTDOUBLE 3520@SHORTDESC=double factorial 3521@SYNTAX=FACTDOUBLE(x) 3522@ARGUMENTDESCRIPTION=@{x}: non-negative integer 3523@DESCRIPTION=FACTDOUBLE function returns the double factorial @{x}!! 3524@NOTE=If @{x} is not an integer, it is truncated. If @{x} is negative, FACTDOUBLE returns #NUM! 3525@EXCEL=This function is Excel compatible. 3526@SEEALSO=FACT 3527 3528@CATEGORY=Mathematics 3529@FUNCTION=FIB 3530@SHORTDESC=Fibonacci numbers 3531@SYNTAX=FIB(n) 3532@ARGUMENTDESCRIPTION=@{n}: positive integer 3533@DESCRIPTION=FIB(@{n}) is the @{n}th Fibonacci number. 3534@NOTE=If @{n} is not an integer, it is truncated. If it is negative or zero FIB returns #NUM! 3535 3536@CATEGORY=Mathematics 3537@FUNCTION=FLOOR 3538@SHORTDESC=nearest multiple of @{significance} whose absolute value is at most ABS(@{x}) 3539@SYNTAX=FLOOR(x,significance) 3540@ARGUMENTDESCRIPTION=@{x}: number 3541@{significance}: base multiple (defaults to 1 for @{x} > 0 and -1 for @{x} < 0) 3542@DESCRIPTION=FLOOR(@{x},@{significance}) is the nearest multiple of @{significance} whose absolute value is at most ABS(@{x}) 3543@EXCEL=This function is Excel compatible. 3544@ODF=FLOOR(@{x}) is exported to ODF as FLOOR(@{x},SIGN(@{x}),1). FLOOR(@{x},@{significance}) is the OpenFormula function FLOOR(@{x},@{significance},1). 3545@SEEALSO=CEIL,CEILING,ABS,INT,MOD 3546 3547@CATEGORY=Mathematics 3548@FUNCTION=G_PRODUCT 3549@SHORTDESC=product of all the values and cells referenced 3550@SYNTAX=G_PRODUCT(x1,x2,…) 3551@ARGUMENTDESCRIPTION=@{x1}: number 3552@{x2}: number 3553@NOTE=Empty cells are ignored and the empty product is 1. 3554@SEEALSO=SUM,COUNT 3555 3556@CATEGORY=Mathematics 3557@FUNCTION=GAMMA 3558@SHORTDESC=the Gamma function 3559@SYNTAX=GAMMA(x) 3560@ARGUMENTDESCRIPTION=@{x}: number 3561@SEEALSO=GAMMALN 3562 3563@CATEGORY=Mathematics 3564@FUNCTION=GAMMALN 3565@SHORTDESC=natural logarithm of the Gamma function 3566@SYNTAX=GAMMALN(x) 3567@ARGUMENTDESCRIPTION=@{x}: number 3568@EXCEL=This function is Excel compatible. 3569@SEEALSO=GAMMA 3570 3571@CATEGORY=Mathematics 3572@FUNCTION=GCD 3573@SHORTDESC=the greatest common divisor 3574@SYNTAX=GCD(n0,n1,…) 3575@ARGUMENTDESCRIPTION=@{n0}: positive integer 3576@{n1}: positive integer 3577@DESCRIPTION=GCD calculates the greatest common divisor of the given numbers @{n0},@{n1},..., the greatest integer that is a divisor of each argument. 3578@NOTE=If any of the arguments is not an integer, it is truncated. 3579@EXCEL=This function is Excel compatible. 3580@SEEALSO=LCM 3581 3582@CATEGORY=Mathematics 3583@FUNCTION=GD 3584@SHORTDESC=Gudermannian function 3585@SYNTAX=GD(x) 3586@ARGUMENTDESCRIPTION=@{x}: value 3587@SEEALSO=TAN,TANH 3588 3589@CATEGORY=Mathematics 3590@FUNCTION=HYPOT 3591@SHORTDESC=the square root of the sum of the squares of the arguments 3592@SYNTAX=HYPOT(n0,n1,…) 3593@ARGUMENTDESCRIPTION=@{n0}: number 3594@{n1}: number 3595@SEEALSO=MIN,MAX 3596 3597@CATEGORY=Mathematics 3598@FUNCTION=IGAMMA 3599@SHORTDESC=the incomplete Gamma function 3600@SYNTAX=IGAMMA(a,x,lower,regularize,real) 3601@ARGUMENTDESCRIPTION=@{a}: number 3602@{x}: number 3603@{lower}: if true (the default), the lower incomplete gamma function, otherwise the upper incomplete gamma function 3604@{regularize}: if true (the default), the regularized version of the incomplete gamma function 3605@{real}: if true (the default), the real part of the result, otherwise the imaginary part 3606@NOTE=The regularized incomplete gamma function is the unregularized incomplete gamma function divided by GAMMA(@{a}) This is a real valued function as long as neither @{a} nor @{z} are negative. 3607@SEEALSO=GAMMA,IMIGAMMA 3608 3609@CATEGORY=Mathematics 3610@FUNCTION=INT 3611@SHORTDESC=largest integer not larger than @{x} 3612@SYNTAX=INT(x) 3613@ARGUMENTDESCRIPTION=@{x}: number 3614@EXCEL=This function is Excel compatible. 3615@SEEALSO=CEIL,CEILING,FLOOR,ABS,MOD 3616 3617@CATEGORY=Mathematics 3618@FUNCTION=LAMBERTW 3619@SHORTDESC=the Lambert W function 3620@SYNTAX=LAMBERTW(x,k) 3621@ARGUMENTDESCRIPTION=@{x}: number 3622@{k}: branch 3623@NOTE=@{k} defaults to 0, the principal branch. @{k} must be either 0 or -1. 3624@SEEALSO=EXP 3625 3626@CATEGORY=Mathematics 3627@FUNCTION=LCM 3628@SHORTDESC=the least common multiple 3629@SYNTAX=LCM(n0,n1,…) 3630@ARGUMENTDESCRIPTION=@{n0}: positive integer 3631@{n1}: positive integer 3632@DESCRIPTION=LCM calculates the least common multiple of the given numbers @{n0},@{n1},..., the smallest integer that is a multiple of each argument. 3633@NOTE=If any of the arguments is not an integer, it is truncated. 3634@EXCEL=This function is Excel compatible. 3635@SEEALSO=GCD 3636 3637@CATEGORY=Mathematics 3638@FUNCTION=LINSOLVE 3639@SHORTDESC=solve linear equation 3640@SYNTAX=LINSOLVE(A,B) 3641@ARGUMENTDESCRIPTION=@{A}: a matrix 3642@{B}: a matrix 3643@DESCRIPTION=Solves the equation @{A}*X=@{B} and returns X. 3644@NOTE=If the matrix @{A} is singular, #VALUE! is returned. 3645@SEEALSO=MINVERSE 3646 3647@CATEGORY=Mathematics 3648@FUNCTION=LN 3649@SHORTDESC=the natural logarithm of @{x} 3650@SYNTAX=LN(x) 3651@ARGUMENTDESCRIPTION=@{x}: positive number 3652@NOTE=If @{x} ≤ 0, LN returns #NUM! error. 3653@EXCEL=This function is Excel compatible. 3654@SEEALSO=EXP,LOG2,LOG10 3655 3656@CATEGORY=Mathematics 3657@FUNCTION=LN1P 3658@SHORTDESC=LN(1+@{x}) 3659@SYNTAX=LN1P(x) 3660@ARGUMENTDESCRIPTION=@{x}: positive number 3661@DESCRIPTION=LN1P calculates LN(1+@{x}) but yielding a higher precision than evaluating LN(1+@{x}). 3662@NOTE=If @{x} ≤ -1, LN returns #NUM! error. 3663@EXCEL=This function is Excel compatible. 3664@SEEALSO=EXP,LN,EXPM1 3665 3666@CATEGORY=Mathematics 3667@FUNCTION=LOG 3668@SHORTDESC=logarithm of @{x} with base @{base} 3669@SYNTAX=LOG(x,base) 3670@ARGUMENTDESCRIPTION=@{x}: positive number 3671@{base}: base of the logarithm, defaults to 10 3672@NOTE=@{base} must be positive and not equal to 1. If @{x} ≤ 0, LOG returns #NUM! error. 3673@EXCEL=This function is Excel compatible. 3674@SEEALSO=LN,LOG2,LOG10 3675 3676@CATEGORY=Mathematics 3677@FUNCTION=LOG10 3678@SHORTDESC=the base-10 logarithm of @{x} 3679@SYNTAX=LOG10(x) 3680@ARGUMENTDESCRIPTION=@{x}: positive number 3681@NOTE=If @{x} ≤ 0, LOG10 returns #NUM! 3682@SEEALSO=EXP,LOG2,LOG 3683 3684@CATEGORY=Mathematics 3685@FUNCTION=LOG2 3686@SHORTDESC=the base-2 logarithm of @{x} 3687@SYNTAX=LOG2(x) 3688@ARGUMENTDESCRIPTION=@{x}: positive number 3689@NOTE=If @{x} ≤ 0, LOG2 returns #NUM! 3690@SEEALSO=EXP,LOG10,LOG 3691 3692@CATEGORY=Mathematics 3693@FUNCTION=MAXIFS 3694@SHORTDESC=maximum of the cells in @{actual_range} for which the corresponding cells in the range meet the given criteria 3695@SYNTAX=MAXIFS(actual_range,range1,criteria1,…) 3696@ARGUMENTDESCRIPTION=@{actual_range}: cell area 3697@{range1}: cell area 3698@{criteria1}: condition for a cell to be included 3699@EXCEL=This function is Excel compatible. 3700@SEEALSO=MIN,MINIFS 3701 3702@CATEGORY=Mathematics 3703@FUNCTION=MDETERM 3704@SHORTDESC=the determinant of the matrix @{matrix} 3705@SYNTAX=MDETERM(matrix) 3706@ARGUMENTDESCRIPTION=@{matrix}: a square matrix 3707@EXCEL=This function is Excel compatible. 3708@SEEALSO=MMULT,MINVERSE 3709 3710@CATEGORY=Mathematics 3711@FUNCTION=MINIFS 3712@SHORTDESC=minimum of the cells in @{actual_range} for which the corresponding cells in the range meet the given criteria 3713@SYNTAX=MINIFS(actual_range,range1,criteria1,…) 3714@ARGUMENTDESCRIPTION=@{actual_range}: cell area 3715@{range1}: cell area 3716@{criteria1}: condition for a cell to be included 3717@EXCEL=This function is Excel compatible. 3718@SEEALSO=MIN,MAXIFS 3719 3720@CATEGORY=Mathematics 3721@FUNCTION=MINVERSE 3722@SHORTDESC=the inverse matrix of @{matrix} 3723@SYNTAX=MINVERSE(matrix) 3724@ARGUMENTDESCRIPTION=@{matrix}: a square matrix 3725@NOTE=If @{matrix} is not invertible, MINVERSE returns #NUM! If @{matrix} does not contain an equal number of columns and rows, MINVERSE returns #VALUE! 3726@EXCEL=This function is Excel compatible. 3727@SEEALSO=MMULT,MDETERM,LINSOLVE 3728 3729@CATEGORY=Mathematics 3730@FUNCTION=MMULT 3731@SHORTDESC=the matrix product of @{mat1} and @{mat2} 3732@SYNTAX=MMULT(mat1,mat2) 3733@ARGUMENTDESCRIPTION=@{mat1}: a matrix 3734@{mat2}: a matrix 3735@NOTE=The number of columns in @{mat1} must equal the number of rows in @{mat2}; otherwise #VALUE! is returned. The result of MMULT is an array, in which the number of rows is the same as in @{mat1}), and the number of columns is the same as in (@{mat2}). 3736@EXCEL=This function is Excel compatible. 3737@SEEALSO=TRANSPOSE,MINVERSE 3738 3739@CATEGORY=Mathematics 3740@FUNCTION=MOD 3741@SHORTDESC=the remainder of @{x} under division by @{n} 3742@SYNTAX=MOD(x,n) 3743@ARGUMENTDESCRIPTION=@{x}: integer 3744@{n}: integer 3745@DESCRIPTION=MOD function returns the remainder when @{x} is divided by @{n}. 3746@NOTE=If @{n} is 0, MOD returns #DIV/0! 3747@EXCEL=This function is Excel compatible. 3748@SEEALSO=CEIL,CEILING,FLOOR,ABS,INT,ABS 3749 3750@CATEGORY=Mathematics 3751@FUNCTION=MPSEUDOINVERSE 3752@SHORTDESC=the pseudo-inverse matrix of @{matrix} 3753@SYNTAX=MPSEUDOINVERSE(matrix,threshold) 3754@ARGUMENTDESCRIPTION=@{matrix}: a matrix 3755@{threshold}: a relative size threshold for discarding eigenvalues 3756@SEEALSO=MINVERSE 3757 3758@CATEGORY=Mathematics 3759@FUNCTION=MROUND 3760@SHORTDESC=@{x} rounded to a multiple of @{m} 3761@SYNTAX=MROUND(x,m) 3762@ARGUMENTDESCRIPTION=@{x}: number 3763@{m}: number 3764@NOTE=If @{x} and @{m} have different sign, MROUND returns #NUM! 3765@EXCEL=This function is Excel compatible. 3766@SEEALSO=ROUNDDOWN,ROUND,ROUNDUP 3767 3768@CATEGORY=Mathematics 3769@FUNCTION=MULTINOMIAL 3770@SHORTDESC=multinomial coefficient (@{x1}+⋯+@{xn}) choose (@{x1},…,@{xn}) 3771@SYNTAX=MULTINOMIAL(x1,x2,xn,…) 3772@ARGUMENTDESCRIPTION=@{x1}: first number 3773@{x2}: second number 3774@{xn}: nth number 3775@EXCEL=This function is Excel compatible. 3776@SEEALSO=COMBIN,SUM 3777 3778@CATEGORY=Mathematics 3779@FUNCTION=MUNIT 3780@SHORTDESC=the @{n} by @{n} identity matrix 3781@SYNTAX=MUNIT(n) 3782@ARGUMENTDESCRIPTION=@{n}: size of the matrix 3783@ODF=This function is OpenFormula compatible. 3784@SEEALSO=MMULT,MDETERM,MINVERSE 3785 3786@CATEGORY=Mathematics 3787@FUNCTION=ODD 3788@SHORTDESC=@{x} rounded away from 0 to the next odd integer 3789@SYNTAX=ODD(x) 3790@ARGUMENTDESCRIPTION=@{x}: number 3791@EXCEL=This function is Excel compatible. 3792@SEEALSO=EVEN 3793 3794@CATEGORY=Mathematics 3795@FUNCTION=ODF.SUMPRODUCT 3796@SHORTDESC=multiplies components and adds the results 3797@SYNTAX=ODF.SUMPRODUCT(,…) 3798@DESCRIPTION=Multiplies corresponding data entries in the given arrays or ranges, and then returns the sum of those products. 3799@NOTE=If an entry is not numeric or logical, the value zero is used instead. If arrays or range arguments do not have the same dimensions, return #VALUE! error. This function differs from SUMPRODUCT by considering booleans. 3800@EXCEL=This function is not Excel compatible. Use SUMPRODUCT instead. 3801@ODF=This function is OpenFormula compatible. 3802@SEEALSO=SUMPRODUCT,SUM,PRODUCT,G_PRODUCT 3803 3804@CATEGORY=Mathematics 3805@FUNCTION=PI 3806@SHORTDESC=the constant �� 3807@SYNTAX=PI() 3808@EXCEL=This function is Excel compatible, but it returns �� with a better precision. 3809@SEEALSO=SQRTPI 3810 3811@CATEGORY=Mathematics 3812@FUNCTION=POCHHAMMER 3813@SHORTDESC=the value of GAMMA(@{x}+@{n})/GAMMA(@{x}) 3814@SYNTAX=POCHHAMMER(x,n) 3815@ARGUMENTDESCRIPTION=@{x}: number 3816@{n}: number 3817@SEEALSO=GAMMA 3818 3819@CATEGORY=Mathematics 3820@FUNCTION=POWER 3821@SHORTDESC=the value of @{x} raised to the power @{y} raised to the power of 1/@{z} 3822@SYNTAX=POWER(x,y,z) 3823@ARGUMENTDESCRIPTION=@{x}: number 3824@{y}: number 3825@{z}: number 3826@NOTE=If both @{x} and @{y} equal 0, POWER returns #NUM! If @{x} = 0 and @{y} < 0, POWER returns #DIV/0! If @{x} < 0 and @{y} is not an integer, POWER returns #NUM! @{z} defaults to 1 If @{z} is not a positive integer, POWER returns #NUM! If @{x} < 0, @{y} is odd, and @{z} is even, POWER returns #NUM! 3827@SEEALSO=EXP 3828 3829@CATEGORY=Mathematics 3830@FUNCTION=PRODUCT 3831@SHORTDESC=product of the given values 3832@SYNTAX=PRODUCT(values,…) 3833@ARGUMENTDESCRIPTION=@{values}: a list of values to multiply 3834@DESCRIPTION=PRODUCT computes the product of all the values and cells referenced in the argument list. 3835@NOTE=If all cells are empty, the result will be 0. 3836@EXCEL=This function is Excel compatible. 3837@ODF=This function is OpenFormula compatible. 3838@SEEALSO=SUM,COUNT,G_PRODUCT 3839 3840@CATEGORY=Mathematics 3841@FUNCTION=QUOTIENT 3842@SHORTDESC=integer portion of a division 3843@SYNTAX=QUOTIENT(numerator,denominator) 3844@ARGUMENTDESCRIPTION=@{numerator}: integer 3845@{denominator}: non-zero integer 3846@DESCRIPTION=QUOTIENT yields the integer portion of the division @{numerator}/@{denominator}. 3847QUOTIENT (@{numerator},@{denominator})⨉@{denominator}+MOD(@{numerator},@{denominator})=@{numerator} 3848@EXCEL=This function is Excel compatible. 3849@SEEALSO=MOD 3850 3851@CATEGORY=Mathematics 3852@FUNCTION=RADIANS 3853@SHORTDESC=the number of radians equivalent to @{x} degrees 3854@SYNTAX=RADIANS(x) 3855@ARGUMENTDESCRIPTION=@{x}: angle in degrees 3856@EXCEL=This function is Excel compatible. 3857@SEEALSO=PI,DEGREES 3858 3859@CATEGORY=Mathematics 3860@FUNCTION=REDUCEPI 3861@SHORTDESC=reduce modulo Pi divided by a power of 2 3862@SYNTAX=REDUCEPI(x,e,q) 3863@ARGUMENTDESCRIPTION=@{x}: number 3864@{e}: scale 3865@{q}: get lower bits of quotient, defaults to FALSE 3866@NOTE=This function returns a value, xr, such that @{x}=xr+j*Pi/2^@{e} where j is an integer and the absolute value of xr does not exceed Pi/2^(@{e}+1). If optional argument @{q} is TRUE, returns instead the @e+1 lower bits of j. The reduction is performed as-if using an exact value of Pi. The lowest valid @{e} is -1 representing reduction modulo 2*Pi; the highest is 7 representing reduction modulo Pi/256. 3867@SEEALSO=PI 3868 3869@CATEGORY=Mathematics 3870@FUNCTION=ROMAN 3871@SHORTDESC=@{n} as a roman numeral text 3872@SYNTAX=ROMAN(n,type) 3873@ARGUMENTDESCRIPTION=@{n}: non-negative integer 3874@{type}: 0,1,2,3,or 4, defaults to 0 3875@DESCRIPTION=ROMAN returns the arabic number @{n} as a roman numeral text. 3876If @{type} is 0 or it is omitted, ROMAN returns classic roman numbers. 3877Type 1 is more concise than classic type, type 2 is more concise than type 1, and type 3 is more concise than type 2. Type 4 is a simplified type. 3878@EXCEL=This function is Excel compatible. 3879 3880@CATEGORY=Mathematics 3881@FUNCTION=ROUND 3882@SHORTDESC=rounded @{x} 3883@SYNTAX=ROUND(x,d) 3884@ARGUMENTDESCRIPTION=@{x}: number 3885@{d}: integer, defaults to 0 3886@DESCRIPTION=If @{d} is greater than zero, @{x} is rounded to the given number of digits. 3887If @{d} is zero, @{x} is rounded to the next integer. 3888If @{d} is less than zero, @{x} is rounded to the left of the decimal point 3889@EXCEL=This function is Excel compatible. 3890@SEEALSO=ROUNDDOWN,ROUNDUP 3891 3892@CATEGORY=Mathematics 3893@FUNCTION=ROUNDDOWN 3894@SHORTDESC=@{x} rounded towards 0 3895@SYNTAX=ROUNDDOWN(x,d) 3896@ARGUMENTDESCRIPTION=@{x}: number 3897@{d}: integer, defaults to 0 3898@DESCRIPTION=If @{d} is greater than zero, @{x} is rounded toward 0 to the given number of digits. 3899If @{d} is zero, @{x} is rounded toward 0 to the next integer. 3900If @{d} is less than zero, @{x} is rounded toward 0 to the left of the decimal point 3901@EXCEL=This function is Excel compatible. 3902@SEEALSO=ROUND,ROUNDUP 3903 3904@CATEGORY=Mathematics 3905@FUNCTION=ROUNDUP 3906@SHORTDESC=@{x} rounded away from 0 3907@SYNTAX=ROUNDUP(x,d) 3908@ARGUMENTDESCRIPTION=@{x}: number 3909@{d}: integer, defaults to 0 3910@DESCRIPTION=If @{d} is greater than zero, @{x} is rounded away from 0 to the given number of digits. 3911If @{d} is zero, @{x} is rounded away from 0 to the next integer. 3912If @{d} is less than zero, @{x} is rounded away from 0 to the left of the decimal point 3913@EXCEL=This function is Excel compatible. 3914@SEEALSO=ROUND,ROUNDDOWN,INT 3915 3916@CATEGORY=Mathematics 3917@FUNCTION=SEC 3918@SHORTDESC=Secant 3919@SYNTAX=SEC(x) 3920@ARGUMENTDESCRIPTION=@{x}: angle in radians 3921@EXCEL=This function is not Excel compatible. 3922@ODF=SEC(@{x}) is exported to OpenFormula as 1/COS(@{x}). 3923@SEEALSO=SIN,COS,TAN,CSC,SINH,COSH,TANH,RADIANS,DEGREES 3924 3925@CATEGORY=Mathematics 3926@FUNCTION=SECH 3927@SHORTDESC=the hyperbolic secant of @{x} 3928@SYNTAX=SECH(x) 3929@ARGUMENTDESCRIPTION=@{x}: number 3930@EXCEL=This function is not Excel compatible. 3931@ODF=SECH(@{x}) is exported to OpenFormula as 1/COSH(@{x}). 3932@SEEALSO=SIN,COS,TAN,CSC,SEC,SINH,COSH,TANH 3933 3934@CATEGORY=Mathematics 3935@FUNCTION=SERIESSUM 3936@SHORTDESC=sum of a power series at @{x} 3937@SYNTAX=SERIESSUM(x,n,m,coeff) 3938@ARGUMENTDESCRIPTION=@{x}: number where to evaluate the power series 3939@{n}: non-negative integer, exponent of the lowest term of the series 3940@{m}: increment to each exponent 3941@{coeff}: coefficients of the power series 3942@EXCEL=This function is Excel compatible. 3943@SEEALSO=COUNT,SUM 3944 3945@CATEGORY=Mathematics 3946@FUNCTION=SIGN 3947@SHORTDESC=sign of @{x} 3948@SYNTAX=SIGN(x) 3949@ARGUMENTDESCRIPTION=@{x}: number 3950@DESCRIPTION=SIGN returns 1 if the @{x} is positive and it returns -1 if @{x} is negative. 3951@EXCEL=This function is Excel compatible. 3952@SEEALSO=ABS 3953 3954@CATEGORY=Mathematics 3955@FUNCTION=SIN 3956@SHORTDESC=the sine of @{x} 3957@SYNTAX=SIN(x) 3958@ARGUMENTDESCRIPTION=@{x}: angle in radians 3959@EXCEL=This function is Excel compatible. 3960@SEEALSO=COS,TAN,CSC,SEC,SINH,COSH,TANH,RADIANS,DEGREES 3961 3962@CATEGORY=Mathematics 3963@FUNCTION=SINH 3964@SHORTDESC=the hyperbolic sine of @{x} 3965@SYNTAX=SINH(x) 3966@ARGUMENTDESCRIPTION=@{x}: number 3967@EXCEL=This function is Excel compatible. 3968@SEEALSO=SIN,COSH,ASINH 3969 3970@CATEGORY=Mathematics 3971@FUNCTION=SINPI 3972@SHORTDESC=the sine of Pi*@{x} 3973@SYNTAX=SINPI(x) 3974@ARGUMENTDESCRIPTION=@{x}: number of half turns 3975@SEEALSO=SIN 3976 3977@CATEGORY=Mathematics 3978@FUNCTION=SQRT 3979@SHORTDESC=square root of @{x} 3980@SYNTAX=SQRT(x) 3981@ARGUMENTDESCRIPTION=@{x}: non-negative number 3982@NOTE=If @{x} is negative, SQRT returns #NUM! 3983@EXCEL=This function is Excel compatible. 3984@SEEALSO=POWER 3985 3986@CATEGORY=Mathematics 3987@FUNCTION=SQRTPI 3988@SHORTDESC=the square root of @{x} times �� 3989@SYNTAX=SQRTPI(x) 3990@ARGUMENTDESCRIPTION=@{x}: non-negative number 3991@EXCEL=This function is Excel compatible. 3992@SEEALSO=PI 3993 3994@CATEGORY=Mathematics 3995@FUNCTION=SUM 3996@SHORTDESC=sum of the given values 3997@SYNTAX=SUM(values,…) 3998@ARGUMENTDESCRIPTION=@{values}: a list of values to add 3999@DESCRIPTION=SUM computes the sum of all the values and cells referenced in the argument list. 4000@EXCEL=This function is Excel compatible. 4001@ODF=This function is OpenFormula compatible. 4002@SEEALSO=AVERAGE,COUNT 4003 4004@CATEGORY=Mathematics 4005@FUNCTION=SUMA 4006@SHORTDESC=sum of all values and cells referenced 4007@SYNTAX=SUMA(area0,area1,…) 4008@ARGUMENTDESCRIPTION=@{area0}: first cell area 4009@{area1}: second cell area 4010@DESCRIPTION=Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). 4011@SEEALSO=AVERAGE,SUM,COUNT 4012 4013@CATEGORY=Mathematics 4014@FUNCTION=SUMIF 4015@SHORTDESC=sum of the cells in @{actual_range} for which the corresponding cells in the range meet the given @{criteria} 4016@SYNTAX=SUMIF(range,criteria,actual_range) 4017@ARGUMENTDESCRIPTION=@{range}: cell area 4018@{criteria}: condition for a cell to be summed 4019@{actual_range}: cell area, defaults to @{range} 4020@NOTE=If the @{actual_range} has a size that differs from the size of @{range}, @{actual_range} is resized (retaining the top-left corner) to match the size of @{range}. 4021@EXCEL=This function is Excel compatible. 4022@SEEALSO=SUM,SUMIFS,COUNTIF 4023 4024@CATEGORY=Mathematics 4025@FUNCTION=SUMIFS 4026@SHORTDESC=sum of the cells in @{actual_range} for which the corresponding cells in the range meet the given criteria 4027@SYNTAX=SUMIFS(actual_range,range1,criteria1,…) 4028@ARGUMENTDESCRIPTION=@{actual_range}: cell area 4029@{range1}: cell area 4030@{criteria1}: condition for a cell to be included 4031@EXCEL=This function is Excel compatible. 4032@SEEALSO=SUM,SUMIF 4033 4034@CATEGORY=Mathematics 4035@FUNCTION=SUMPRODUCT 4036@SHORTDESC=multiplies components and adds the results 4037@SYNTAX=SUMPRODUCT(,…) 4038@DESCRIPTION=Multiplies corresponding data entries in the given arrays or ranges, and then returns the sum of those products. 4039@NOTE=If an entry is not numeric, the value zero is used instead. If arrays or range arguments do not have the same dimensions, return #VALUE! error. This function ignores logicals, so using SUMPRODUCT(A1:A5>0) will not work. Instead use SUMPRODUCT(--(A1:A5>0)) 4040@EXCEL=This function is Excel compatible. 4041@ODF=This function is not OpenFormula compatible. Use ODF.SUMPRODUCT instead. 4042@SEEALSO=SUM,PRODUCT,G_PRODUCT,ODF.SUMPRODUCT 4043 4044@CATEGORY=Mathematics 4045@FUNCTION=SUMSQ 4046@SHORTDESC=sum of the squares of all values and cells referenced 4047@SYNTAX=SUMSQ(area0,area1,…) 4048@ARGUMENTDESCRIPTION=@{area0}: first cell area 4049@{area1}: second cell area 4050@EXCEL=This function is Excel compatible. 4051@SEEALSO=SUM,COUNT 4052 4053@CATEGORY=Mathematics 4054@FUNCTION=SUMX2MY2 4055@SHORTDESC=sum of the difference of squares 4056@SYNTAX=SUMX2MY2(array0,array1) 4057@ARGUMENTDESCRIPTION=@{array0}: first cell area 4058@{array1}: second cell area 4059@DESCRIPTION=SUMX2MY2 function returns the sum of the difference of squares of corresponding values in two arrays. The equation of SUMX2MY2 is SUM(x^2-y^2). 4060@EXCEL=This function is Excel compatible. 4061@SEEALSO=SUMSQ,SUMX2PY2 4062 4063@CATEGORY=Mathematics 4064@FUNCTION=SUMX2PY2 4065@SHORTDESC=sum of the sum of squares 4066@SYNTAX=SUMX2PY2(array0,array1) 4067@ARGUMENTDESCRIPTION=@{array0}: first cell area 4068@{array1}: second cell area 4069@DESCRIPTION=SUMX2PY2 function returns the sum of the sum of squares of corresponding values in two arrays. The equation of SUMX2PY2 is SUM(x^2+y^2). 4070@NOTE=If @{array0} and @{array1} have different number of data points, SUMX2PY2 returns #N/A. 4071Strings and empty cells are simply ignored. 4072@EXCEL=This function is Excel compatible. 4073@SEEALSO=SUMSQ,SUMX2MY2 4074 4075@CATEGORY=Mathematics 4076@FUNCTION=SUMXMY2 4077@SHORTDESC=sum of the squares of differences 4078@SYNTAX=SUMXMY2(array0,array1) 4079@ARGUMENTDESCRIPTION=@{array0}: first cell area 4080@{array1}: second cell area 4081@DESCRIPTION=SUMXMY2 function returns the sum of the squares of the differences of corresponding values in two arrays. The equation of SUMXMY2 is SUM((x-y)^2). 4082@NOTE=If @{array0} and @{array1} have different number of data points, SUMXMY2 returns #N/A. 4083Strings and empty cells are simply ignored. 4084@EXCEL=This function is Excel compatible. 4085@SEEALSO=SUMSQ,SUMX2MY2,SUMX2PY2 4086 4087@CATEGORY=Mathematics 4088@FUNCTION=TAN 4089@SHORTDESC=the tangent of @{x} 4090@SYNTAX=TAN(x) 4091@ARGUMENTDESCRIPTION=@{x}: angle in radians 4092@EXCEL=This function is Excel compatible. 4093@SEEALSO=TANH,COS,COSH,SIN,SINH,DEGREES,RADIANS 4094 4095@CATEGORY=Mathematics 4096@FUNCTION=TANH 4097@SHORTDESC=the hyperbolic tangent of @{x} 4098@SYNTAX=TANH(x) 4099@ARGUMENTDESCRIPTION=@{x}: number 4100@EXCEL=This function is Excel compatible. 4101@SEEALSO=TAN,SIN,SINH,COS,COSH 4102 4103@CATEGORY=Mathematics 4104@FUNCTION=TANPI 4105@SHORTDESC=the tangent of Pi*@{x} 4106@SYNTAX=TANPI(x) 4107@ARGUMENTDESCRIPTION=@{x}: number of half turns 4108@SEEALSO=TAN 4109 4110@CATEGORY=Mathematics 4111@FUNCTION=TRUNC 4112@SHORTDESC=@{x} truncated to @{d} digits 4113@SYNTAX=TRUNC(x,d) 4114@ARGUMENTDESCRIPTION=@{x}: number 4115@{d}: non-negative integer, defaults to 0 4116@NOTE=If @{d} is omitted or negative then it defaults to zero. If it is not an integer then it is truncated to an integer. 4117@EXCEL=This function is Excel compatible. 4118@SEEALSO=INT 4119 4120@CATEGORY=Number Theory 4121@FUNCTION=ISPRIME 4122@SHORTDESC=whether @{n} is prime 4123@SYNTAX=ISPRIME(n) 4124@ARGUMENTDESCRIPTION=@{n}: positive integer 4125@DESCRIPTION=ISPRIME returns TRUE if @{n} is prime and FALSE otherwise. 4126@SEEALSO=NT_D, NT_SIGMA 4127 4128@CATEGORY=Number Theory 4129@FUNCTION=ITHPRIME 4130@SHORTDESC=@{i}th prime 4131@SYNTAX=ITHPRIME(i) 4132@ARGUMENTDESCRIPTION=@{i}: positive integer 4133@DESCRIPTION=ITHPRIME finds the @{i}th prime. 4134@SEEALSO=NT_D,NT_SIGMA 4135 4136@CATEGORY=Number Theory 4137@FUNCTION=NT_D 4138@SHORTDESC=number of divisors 4139@SYNTAX=NT_D(n) 4140@ARGUMENTDESCRIPTION=@{n}: positive integer 4141@DESCRIPTION=NT_D calculates the number of divisors of @{n}. 4142@SEEALSO=ITHPRIME,NT_PHI,NT_SIGMA 4143 4144@CATEGORY=Number Theory 4145@FUNCTION=NT_MU 4146@SHORTDESC=Möbius mu function 4147@SYNTAX=NT_MU(n) 4148@ARGUMENTDESCRIPTION=@{n}: positive integer 4149@DESCRIPTION=NT_MU function (Möbius mu function) returns 0 if @{n} is divisible by the square of a prime. Otherwise, if @{n} has an odd number of different prime factors, NT_MU returns -1, and if @{n} has an even number of different prime factors, it returns 1. If @{n} = 1, NT_MU returns 1. 4150@SEEALSO=ITHPRIME,NT_PHI,NT_SIGMA,NT_D 4151 4152@CATEGORY=Number Theory 4153@FUNCTION=NT_OMEGA 4154@SHORTDESC=Number of distinct prime factors 4155@SYNTAX=NT_OMEGA(n) 4156@ARGUMENTDESCRIPTION=@{n}: positive integer 4157@NOTE=Returns the number of distinct prime factors without multiplicity. 4158@SEEALSO=NT_D,ITHPRIME,NT_SIGMA 4159 4160@CATEGORY=Number Theory 4161@FUNCTION=NT_PHI 4162@SHORTDESC=Euler's totient function 4163@SYNTAX=NT_PHI(n) 4164@ARGUMENTDESCRIPTION=@{n}: positive integer 4165@NOTE=Euler's totient function gives the number of integers less than or equal to @{n} that are relatively prime (coprime) to @{n}. 4166@SEEALSO=NT_D,ITHPRIME,NT_SIGMA 4167 4168@CATEGORY=Number Theory 4169@FUNCTION=NT_PI 4170@SHORTDESC=number of primes upto @{n} 4171@SYNTAX=NT_PI(n) 4172@ARGUMENTDESCRIPTION=@{n}: positive integer 4173@DESCRIPTION=NT_PI returns the number of primes less than or equal to @{n}. 4174@SEEALSO=ITHPRIME,NT_PHI,NT_D,NT_SIGMA 4175 4176@CATEGORY=Number Theory 4177@FUNCTION=NT_RADICAL 4178@SHORTDESC=Radical function 4179@SYNTAX=NT_RADICAL(n) 4180@ARGUMENTDESCRIPTION=@{n}: positive integer 4181@NOTE=The function computes the product of its distinct prime factors 4182@SEEALSO=NT_D,ITHPRIME,NT_SIGMA 4183 4184@CATEGORY=Number Theory 4185@FUNCTION=NT_SIGMA 4186@SHORTDESC=sigma function 4187@SYNTAX=NT_SIGMA(n) 4188@ARGUMENTDESCRIPTION=@{n}: positive integer 4189@DESCRIPTION=NT_SIGMA calculates the sum of the divisors of @{n}. 4190@SEEALSO=NT_D,ITHPRIME,NT_PHI 4191 4192@CATEGORY=Number Theory 4193@FUNCTION=PFACTOR 4194@SHORTDESC=smallest prime factor 4195@SYNTAX=PFACTOR(n) 4196@ARGUMENTDESCRIPTION=@{n}: positive integer 4197@DESCRIPTION=PFACTOR finds the smallest prime factor of its argument. 4198@NOTE=The argument @{n} must be at least 2. Otherwise a #VALUE! error is returned. 4199@SEEALSO=ITHPRIME 4200 4201@CATEGORY=Random Numbers 4202@FUNCTION=RAND 4203@SHORTDESC=a random number between zero and one 4204@SYNTAX=RAND() 4205@EXCEL=This function is Excel compatible. 4206@SEEALSO=RANDBETWEEN 4207 4208@CATEGORY=Random Numbers 4209@FUNCTION=RANDBERNOULLI 4210@SHORTDESC=random variate from a Bernoulli distribution 4211@SYNTAX=RANDBERNOULLI(p) 4212@ARGUMENTDESCRIPTION=@{p}: probability of success 4213@NOTE=If @{p} < 0 or @{p} > 1 RANDBERNOULLI returns #NUM! 4214@SEEALSO=RAND,RANDBETWEEN 4215 4216@CATEGORY=Random Numbers 4217@FUNCTION=RANDBETA 4218@SHORTDESC=random variate from a Beta distribution 4219@SYNTAX=RANDBETA(a,b) 4220@ARGUMENTDESCRIPTION=@{a}: parameter of the Beta distribution 4221@{b}: parameter of the Beta distribution 4222@SEEALSO=RAND,RANDGAMMA 4223 4224@CATEGORY=Random Numbers 4225@FUNCTION=RANDBETWEEN 4226@SHORTDESC=a random integer number between and including @{bottom} and @{top} 4227@SYNTAX=RANDBETWEEN(bottom,top) 4228@ARGUMENTDESCRIPTION=@{bottom}: lower limit 4229@{top}: upper limit 4230@NOTE=If @{bottom} > @{top}, RANDBETWEEN returns #NUM! 4231@EXCEL=This function is Excel compatible. 4232@SEEALSO=RAND,RANDUNIFORM 4233 4234@CATEGORY=Random Numbers 4235@FUNCTION=RANDBINOM 4236@SHORTDESC=random variate from a binomial distribution 4237@SYNTAX=RANDBINOM(p,n) 4238@ARGUMENTDESCRIPTION=@{p}: probability of success in a single trial 4239@{n}: number of trials 4240@NOTE=If @{p} < 0 or @{p} > 1 RANDBINOM returns #NUM! If @{n} < 0 RANDBINOM returns #NUM! 4241@SEEALSO=RAND,RANDBETWEEN 4242 4243@CATEGORY=Random Numbers 4244@FUNCTION=RANDCAUCHY 4245@SHORTDESC=random variate from a Cauchy or Lorentz distribution 4246@SYNTAX=RANDCAUCHY(a) 4247@ARGUMENTDESCRIPTION=@{a}: scale parameter of the distribution 4248@NOTE=If @{a} < 0 RANDCAUCHY returns #NUM! 4249@SEEALSO=RAND 4250 4251@CATEGORY=Random Numbers 4252@FUNCTION=RANDCHISQ 4253@SHORTDESC=random variate from a Chi-square distribution 4254@SYNTAX=RANDCHISQ(df) 4255@ARGUMENTDESCRIPTION=@{df}: degrees of freedom 4256@SEEALSO=RAND,RANDGAMMA 4257 4258@CATEGORY=Random Numbers 4259@FUNCTION=RANDDISCRETE 4260@SHORTDESC=random variate from a finite discrete distribution 4261@SYNTAX=RANDDISCRETE(val_range,prob_range) 4262@ARGUMENTDESCRIPTION=@{val_range}: possible values of the random variable 4263@{prob_range}: probabilities of the corresponding values in @{val_range}, defaults to equal probabilities 4264@DESCRIPTION=RANDDISCRETE returns one of the values in the @{val_range}. The probabilities for each value are given in the @{prob_range}. 4265@NOTE=If the sum of all values in @{prob_range} is not one, RANDDISCRETE returns #NUM! If @{val_range} and @{prob_range} are not the same size, RANDDISCRETE returns #NUM! If @{val_range} or @{prob_range} is not a range, RANDDISCRETE returns #VALUE! 4266@SEEALSO=RANDBETWEEN,RAND 4267 4268@CATEGORY=Random Numbers 4269@FUNCTION=RANDEXP 4270@SHORTDESC=random variate from an exponential distribution 4271@SYNTAX=RANDEXP(b) 4272@ARGUMENTDESCRIPTION=@{b}: parameter of the exponential distribution 4273@SEEALSO=RAND,RANDBETWEEN 4274 4275@CATEGORY=Random Numbers 4276@FUNCTION=RANDEXPPOW 4277@SHORTDESC=random variate from an exponential power distribution 4278@SYNTAX=RANDEXPPOW(a,b) 4279@ARGUMENTDESCRIPTION=@{a}: scale parameter of the exponential power distribution 4280@{b}: exponent of the exponential power distribution 4281@DESCRIPTION=For @{b} = 1 the exponential power distribution reduces to the Laplace distribution. 4282For @{b} = 2 the exponential power distribution reduces to the normal distribution with σ = a/sqrt(2) 4283@SEEALSO=RAND 4284 4285@CATEGORY=Random Numbers 4286@FUNCTION=RANDFDIST 4287@SHORTDESC=random variate from an F distribution 4288@SYNTAX=RANDFDIST(df1,df2) 4289@ARGUMENTDESCRIPTION=@{df1}: numerator degrees of freedom 4290@{df2}: denominator degrees of freedom 4291@SEEALSO=RAND,RANDGAMMA 4292 4293@CATEGORY=Random Numbers 4294@FUNCTION=RANDGAMMA 4295@SHORTDESC=random variate from a Gamma distribution 4296@SYNTAX=RANDGAMMA(a,b) 4297@ARGUMENTDESCRIPTION=@{a}: shape parameter of the Gamma distribution 4298@{b}: scale parameter of the Gamma distribution 4299@NOTE=If @{a} ≤ 0, RANDGAMMA returns #NUM! 4300@SEEALSO=RAND 4301 4302@CATEGORY=Random Numbers 4303@FUNCTION=RANDGEOM 4304@SHORTDESC=random variate from a geometric distribution 4305@SYNTAX=RANDGEOM(p) 4306@ARGUMENTDESCRIPTION=@{p}: probability of success in a single trial 4307@NOTE=If @{p} < 0 or @{p} > 1 RANDGEOM returns #NUM! 4308@SEEALSO=RAND 4309 4310@CATEGORY=Random Numbers 4311@FUNCTION=RANDGUMBEL 4312@SHORTDESC=random variate from a Gumbel distribution 4313@SYNTAX=RANDGUMBEL(a,b,type) 4314@ARGUMENTDESCRIPTION=@{a}: parameter of the Gumbel distribution 4315@{b}: parameter of the Gumbel distribution 4316@{type}: type of the Gumbel distribution, defaults to 1 4317@NOTE=If @{type} is neither 1 nor 2, RANDGUMBEL returns #NUM! 4318@SEEALSO=RAND 4319 4320@CATEGORY=Random Numbers 4321@FUNCTION=RANDHYPERG 4322@SHORTDESC=random variate from a hypergeometric distribution 4323@SYNTAX=RANDHYPERG(n1,n2,t) 4324@ARGUMENTDESCRIPTION=@{n1}: number of objects of type 1 4325@{n2}: number of objects of type 2 4326@{t}: total number of objects selected 4327@SEEALSO=RAND 4328 4329@CATEGORY=Random Numbers 4330@FUNCTION=RANDLANDAU 4331@SHORTDESC=random variate from the Landau distribution 4332@SYNTAX=RANDLANDAU() 4333@SEEALSO=RAND 4334 4335@CATEGORY=Random Numbers 4336@FUNCTION=RANDLAPLACE 4337@SHORTDESC=random variate from a Laplace distribution 4338@SYNTAX=RANDLAPLACE(a) 4339@ARGUMENTDESCRIPTION=@{a}: parameter of the Laplace distribution 4340@SEEALSO=RAND 4341 4342@CATEGORY=Random Numbers 4343@FUNCTION=RANDLEVY 4344@SHORTDESC=random variate from a Lévy distribution 4345@SYNTAX=RANDLEVY(c,α,β) 4346@ARGUMENTDESCRIPTION=@{c}: parameter of the Lévy distribution 4347@{α}: parameter of the Lévy distribution 4348@{β}: parameter of the Lévy distribution, defaults to 0 4349@DESCRIPTION=For @{α} = 1, @{β}=0, the Lévy distribution reduces to the Cauchy (or Lorentzian) distribution. 4350For @{α} = 2, @{β}=0, the Lévy distribution reduces to the normal distribution. 4351@NOTE=If @{α} ≤ 0 or @{α} > 2, RANDLEVY returns #NUM! If @{β} < -1 or @{β} > 1, RANDLEVY returns #NUM! 4352@SEEALSO=RAND 4353 4354@CATEGORY=Random Numbers 4355@FUNCTION=RANDLOG 4356@SHORTDESC=random variate from a logarithmic distribution 4357@SYNTAX=RANDLOG(p) 4358@ARGUMENTDESCRIPTION=@{p}: probability 4359@NOTE=If @{p} < 0 or @{p} > 1 RANDLOG returns #NUM! 4360@SEEALSO=RAND 4361 4362@CATEGORY=Random Numbers 4363@FUNCTION=RANDLOGISTIC 4364@SHORTDESC=random variate from a logistic distribution 4365@SYNTAX=RANDLOGISTIC(a) 4366@ARGUMENTDESCRIPTION=@{a}: parameter of the logistic distribution 4367@SEEALSO=RAND 4368 4369@CATEGORY=Random Numbers 4370@FUNCTION=RANDLOGNORM 4371@SHORTDESC=random variate from a lognormal distribution 4372@SYNTAX=RANDLOGNORM(ζ,σ) 4373@ARGUMENTDESCRIPTION=@{ζ}: parameter of the lognormal distribution 4374@{σ}: standard deviation of the distribution 4375@NOTE=If @{σ} < 0, RANDLOGNORM returns #NUM! 4376@SEEALSO=RAND 4377 4378@CATEGORY=Random Numbers 4379@FUNCTION=RANDNEGBINOM 4380@SHORTDESC=random variate from a negative binomial distribution 4381@SYNTAX=RANDNEGBINOM(p,n) 4382@ARGUMENTDESCRIPTION=@{p}: probability of success in a single trial 4383@{n}: number of failures 4384@NOTE=If @{p} < 0 or @{p} > 1 RANDNEGBINOM returns #NUM! If @{n} < 1 RANDNEGBINOM returns #NUM! 4385@SEEALSO=RAND,RANDBETWEEN 4386 4387@CATEGORY=Random Numbers 4388@FUNCTION=RANDNORM 4389@SHORTDESC=random variate from a normal distribution 4390@SYNTAX=RANDNORM(μ,σ) 4391@ARGUMENTDESCRIPTION=@{μ}: mean of the distribution 4392@{σ}: standard deviation of the distribution 4393@NOTE=If @{σ} < 0, RANDNORM returns #NUM! 4394@SEEALSO=RAND 4395 4396@CATEGORY=Random Numbers 4397@FUNCTION=RANDNORMTAIL 4398@SHORTDESC=random variate from the upper tail of a normal distribution with mean 0 4399@SYNTAX=RANDNORMTAIL(a,σ) 4400@ARGUMENTDESCRIPTION=@{a}: lower limit of the tail 4401@{σ}: standard deviation of the normal distribution 4402@NOTE=The method is based on Marsaglia's famous rectangle-wedge-tail algorithm (Ann Math Stat 32, 894-899 (1961)), with this aspect explained in Knuth, v2, 3rd ed, p139, 586 (exercise 11). 4403@SEEALSO=RAND 4404 4405@CATEGORY=Random Numbers 4406@FUNCTION=RANDPARETO 4407@SHORTDESC=random variate from a Pareto distribution 4408@SYNTAX=RANDPARETO(a,b) 4409@ARGUMENTDESCRIPTION=@{a}: parameter of the Pareto distribution 4410@{b}: parameter of the Pareto distribution 4411@SEEALSO=RAND 4412 4413@CATEGORY=Random Numbers 4414@FUNCTION=RANDPOISSON 4415@SHORTDESC=random variate from a Poisson distribution 4416@SYNTAX=RANDPOISSON(λ) 4417@ARGUMENTDESCRIPTION=@{λ}: parameter of the Poisson distribution 4418@NOTE=If @{λ} < 0 RANDPOISSON returns #NUM! 4419@SEEALSO=RAND,RANDBETWEEN 4420 4421@CATEGORY=Random Numbers 4422@FUNCTION=RANDRAYLEIGH 4423@SHORTDESC=random variate from a Rayleigh distribution 4424@SYNTAX=RANDRAYLEIGH(σ) 4425@ARGUMENTDESCRIPTION=@{σ}: scale parameter of the Rayleigh distribution 4426@SEEALSO=RAND 4427 4428@CATEGORY=Random Numbers 4429@FUNCTION=RANDRAYLEIGHTAIL 4430@SHORTDESC=random variate from the tail of a Rayleigh distribution 4431@SYNTAX=RANDRAYLEIGHTAIL(a,σ) 4432@ARGUMENTDESCRIPTION=@{a}: lower limit of the tail 4433@{σ}: scale parameter of the Rayleigh distribution 4434@SEEALSO=RAND,RANDRAYLEIGH 4435 4436@CATEGORY=Random Numbers 4437@FUNCTION=RANDSNORM 4438@SHORTDESC=random variate from a skew-normal distribution 4439@SYNTAX=RANDSNORM(��,��,��) 4440@ARGUMENTDESCRIPTION=@{��}: shape parameter of the skew-normal distribution, defaults to 0 4441@{��}: location parameter of the skew-normal distribution, defaults to 0 4442@{��}: scale parameter of the skew-normal distribution, defaults to 1 4443@DESCRIPTION=The random variates are drawn from a skew-normal distribution with shape parameter @{��}. When @{��}=0, the skewness vanishes, and we obtain the standard normal density; as �� increases (in absolute value), the skewness of the distribution increases; when @{��} approaches infinity the density converges to the so-called half-normal (or folded normal) density function; if the sign of @{��} changes, the density is reflected on the opposite side of the vertical axis. 4444@NOTE=The mean of a skew-normal distribution with location parameter @{��}=0 is not 0. The standard deviation of a skew-normal distribution with scale parameter @{��}=1 is not 1. The skewness of a skew-normal distribution is in general not @{��}. If @{��} < 0, RANDSNORM returns #NUM! 4445@SEEALSO=RANDNORM,RANDSTDIST 4446 4447@CATEGORY=Random Numbers 4448@FUNCTION=RANDSTDIST 4449@SHORTDESC=random variate from a skew-t distribution 4450@SYNTAX=RANDSTDIST(df,��) 4451@ARGUMENTDESCRIPTION=@{df}: degrees of freedom 4452@{��}: shape parameter of the skew-t distribution, defaults to 0 4453@NOTE=The mean of a skew-t distribution is not 0. The standard deviation of a skew-t distribution is not 1. The skewness of a skew-t distribution is in general not @{��}. 4454@SEEALSO=RANDTDIST,RANDSNORM 4455 4456@CATEGORY=Random Numbers 4457@FUNCTION=RANDTDIST 4458@SHORTDESC=random variate from a Student t distribution 4459@SYNTAX=RANDTDIST(df) 4460@ARGUMENTDESCRIPTION=@{df}: degrees of freedom 4461@SEEALSO=RAND 4462 4463@CATEGORY=Random Numbers 4464@FUNCTION=RANDUNIFORM 4465@SHORTDESC=random variate from the uniform distribution from @{a} to @{b} 4466@SYNTAX=RANDUNIFORM(a,b) 4467@ARGUMENTDESCRIPTION=@{a}: lower limit of the uniform distribution 4468@{b}: upper limit of the uniform distribution 4469@NOTE=If @{a} > @{b} RANDUNIFORM returns #NUM! 4470@SEEALSO=RANDBETWEEN,RAND 4471 4472@CATEGORY=Random Numbers 4473@FUNCTION=RANDWEIBULL 4474@SHORTDESC=random variate from a Weibull distribution 4475@SYNTAX=RANDWEIBULL(a,b) 4476@ARGUMENTDESCRIPTION=@{a}: scale parameter of the Weibull distribution 4477@{b}: shape parameter of the Weibull distribution 4478@SEEALSO=RAND 4479 4480@CATEGORY=Random Numbers 4481@FUNCTION=SIMTABLE 4482@SHORTDESC=one of the values in the given argument list depending on the round number of the simulation tool 4483@SYNTAX=SIMTABLE(d1,d2,…) 4484@ARGUMENTDESCRIPTION=@{d1}: first value 4485@{d2}: second value 4486@DESCRIPTION=SIMTABLE returns one of the values in the given argument list depending on the round number of the simulation tool. When the simulation tool is not activated, SIMTABLE returns @{d1}. 4487With the simulation tool and the SIMTABLE function you can test given decision variables. Each SIMTABLE function contains the possible values of a simulation variable. In most valid simulation models you should have the same number of values @{dN} for all decision variables. If the simulation is run more rounds than there are values defined, SIMTABLE returns #N/A error (e.g. if A1 contains `=SIMTABLE(1)' and A2 `=SIMTABLE(1,2)', A1 yields #N/A error on the second round). 4488The successive use of the simulation tool also requires that you give to the tool at least one input variable having RAND() or any other RAND<distribution name>() function in it. On each round, the simulation tool iterates for the given number of rounds over all the input variables to reevaluate them. On each iteration, the values of the output variables are stored, and when the round is completed, descriptive statistical information is created according to the values. 4489 4490@CATEGORY=Statistics 4491@FUNCTION=ADTEST 4492@SHORTDESC=Anderson-Darling Test of Normality 4493@SYNTAX=ADTEST(x) 4494@ARGUMENTDESCRIPTION=@{x}: array of sample values 4495@DESCRIPTION=This function returns an array with the first row giving the p-value of the Anderson-Darling Test, the second row the test statistic of the test, and the third the number of observations in the sample. 4496@NOTE=If there are less than 8 sample values, ADTEST returns #VALUE! 4497@SEEALSO=CHITEST,CVMTEST,LKSTEST,SFTEST 4498 4499@CATEGORY=Statistics 4500@FUNCTION=AVEDEV 4501@SHORTDESC=average of the absolute deviations of a data set 4502@SYNTAX=AVEDEV(number1,number2,…) 4503@ARGUMENTDESCRIPTION=@{number1}: first value 4504@{number2}: second value 4505@EXCEL=This function is Excel compatible. 4506@SEEALSO=STDEV 4507 4508@CATEGORY=Statistics 4509@FUNCTION=AVERAGE 4510@SHORTDESC=average of all the numeric values and cells 4511@SYNTAX=AVERAGE(number1,number2,…) 4512@ARGUMENTDESCRIPTION=@{number1}: first value 4513@{number2}: second value 4514@EXCEL=This function is Excel compatible. 4515@SEEALSO=SUM, COUNT 4516 4517@CATEGORY=Statistics 4518@FUNCTION=AVERAGEA 4519@SHORTDESC=average of all the values and cells 4520@SYNTAX=AVERAGEA(number1,number2,…) 4521@ARGUMENTDESCRIPTION=@{number1}: first value 4522@{number2}: second value 4523@DESCRIPTION=Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 4524@EXCEL=This function is Excel compatible. 4525@SEEALSO=AVERAGE 4526 4527@CATEGORY=Statistics 4528@FUNCTION=BERNOULLI 4529@SHORTDESC=probability mass function of a Bernoulli distribution 4530@SYNTAX=BERNOULLI(k,p) 4531@ARGUMENTDESCRIPTION=@{k}: integer 4532@{p}: probability of success 4533@NOTE=If @{k} != 0 and @{k} != 1 this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. 4534@SEEALSO=RANDBERNOULLI 4535 4536@CATEGORY=Statistics 4537@FUNCTION=BETA.DIST 4538@SHORTDESC=cumulative distribution function of the beta distribution 4539@SYNTAX=BETA.DIST(x,alpha,beta,cumulative,a,b) 4540@ARGUMENTDESCRIPTION=@{x}: number 4541@{alpha}: scale parameter 4542@{beta}: scale parameter 4543@{cumulative}: whether to evaluate the density function or the cumulative distribution function 4544@{a}: optional lower bound, defaults to 0 4545@{b}: optional upper bound, defaults to 1 4546@NOTE=If @{x} < @{a} or @{x} > @{b} this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0, this function returns a #NUM! error. If @{a} >= @{b} this function returns a #NUM! error. 4547@EXCEL=This function is Excel compatible. 4548@SEEALSO=BETAINV,BETADIST 4549 4550@CATEGORY=Statistics 4551@FUNCTION=BETADIST 4552@SHORTDESC=cumulative distribution function of the beta distribution 4553@SYNTAX=BETADIST(x,alpha,beta,a,b) 4554@ARGUMENTDESCRIPTION=@{x}: number 4555@{alpha}: scale parameter 4556@{beta}: scale parameter 4557@{a}: optional lower bound, defaults to 0 4558@{b}: optional upper bound, defaults to 1 4559@NOTE=If @{x} < @{a} or @{x} > @{b} this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0, this function returns a #NUM! error. If @{a} >= @{b} this function returns a #NUM! error. 4560@EXCEL=This function is Excel compatible. 4561@SEEALSO=BETAINV, BETA.DIST 4562 4563@CATEGORY=Statistics 4564@FUNCTION=BETAINV 4565@SHORTDESC=inverse of the cumulative distribution function of the beta distribution 4566@SYNTAX=BETAINV(p,alpha,beta,a,b) 4567@ARGUMENTDESCRIPTION=@{p}: probability 4568@{alpha}: scale parameter 4569@{beta}: scale parameter 4570@{a}: optional lower bound, defaults to 0 4571@{b}: optional upper bound, defaults to 1 4572@NOTE=If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0, this function returns a #NUM! error. If @{a} >= @{b} this function returns a #NUM! error. 4573@EXCEL=This function is Excel compatible. 4574@SEEALSO=BETADIST,BETA.DIST 4575 4576@CATEGORY=Statistics 4577@FUNCTION=BINOM.DIST.RANGE 4578@SHORTDESC=probability of the binomial distribution over an interval 4579@SYNTAX=BINOM.DIST.RANGE(trials,p,start,end) 4580@ARGUMENTDESCRIPTION=@{trials}: number of trials 4581@{p}: probability of success in each trial 4582@{start}: start of the interval 4583@{end}: end of the interval, defaults to @{start} 4584@NOTE=If @{start}, @{end} or @{trials} are non-integer they are truncated. If @{trials} < 0 this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{start} > @{end} this function returns 0. 4585@ODF=This function is OpenFormula compatible. 4586@SEEALSO=BINOMDIST,R.PBINOM 4587 4588@CATEGORY=Statistics 4589@FUNCTION=BINOMDIST 4590@SHORTDESC=probability mass or cumulative distribution function of the binomial distribution 4591@SYNTAX=BINOMDIST(n,trials,p,cumulative) 4592@ARGUMENTDESCRIPTION=@{n}: number of successes 4593@{trials}: number of trials 4594@{p}: probability of success in each trial 4595@{cumulative}: whether to evaluate the mass function or the cumulative distribution function 4596@NOTE=If @{n} or @{trials} are non-integer they are truncated. If @{n} < 0 or @{trials} < 0 this function returns a #NUM! error. If @{n} > @{trials} this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. 4597@EXCEL=This function is Excel compatible. 4598@SEEALSO=POISSON 4599 4600@CATEGORY=Statistics 4601@FUNCTION=CAUCHY 4602@SHORTDESC=probability density or cumulative distribution function of the Cauchy, Lorentz or Breit-Wigner distribution 4603@SYNTAX=CAUCHY(x,a,cumulative) 4604@ARGUMENTDESCRIPTION=@{x}: number 4605@{a}: scale parameter 4606@{cumulative}: whether to evaluate the density function or the cumulative distribution function 4607@NOTE=If @{a} < 0 this function returns a #NUM! error. If @{cumulative} is neither TRUE nor FALSE this function returns a #VALUE! error. 4608@SEEALSO=RANDCAUCHY 4609 4610@CATEGORY=Statistics 4611@FUNCTION=CHIDIST 4612@SHORTDESC=survival function of the chi-squared distribution 4613@SYNTAX=CHIDIST(x,dof) 4614@ARGUMENTDESCRIPTION=@{x}: number 4615@{dof}: number of degrees of freedom 4616@DESCRIPTION=The survival function is 1 minus the cumulative distribution function. 4617@NOTE=If @{dof} is non-integer it is truncated. If @{dof} < 1 this function returns a #NUM! error. 4618@EXCEL=This function is Excel compatible. 4619@ODF=CHIDIST(@{x},@{dof}) is the OpenFormula function LEGACY.CHIDIST(@{x},@{dof}). 4620@SEEALSO=CHIINV,CHITEST 4621 4622@CATEGORY=Statistics 4623@FUNCTION=CHIINV 4624@SHORTDESC=inverse of the survival function of the chi-squared distribution 4625@SYNTAX=CHIINV(p,dof) 4626@ARGUMENTDESCRIPTION=@{p}: probability 4627@{dof}: number of degrees of freedom 4628@DESCRIPTION=The survival function is 1 minus the cumulative distribution function. 4629@NOTE=If @{p} < 0 or @{p} > 1 or @{dof} < 1 this function returns a #NUM! error. 4630@EXCEL=This function is Excel compatible. 4631@ODF=CHIINV(@{p},@{dof}) is the OpenFormula function LEGACY.CHIDIST(@{p},@{dof}). 4632@SEEALSO=CHIDIST,CHITEST 4633 4634@CATEGORY=Statistics 4635@FUNCTION=CHITEST 4636@SHORTDESC=p value of the Goodness of Fit Test 4637@SYNTAX=CHITEST(actual_range,theoretical_range) 4638@ARGUMENTDESCRIPTION=@{actual_range}: observed data 4639@{theoretical_range}: expected values 4640@NOTE=If the actual range is not an n by 1 or 1 by n range, but an n by m range, then CHITEST uses (n-1) times (m-1) as degrees of freedom. This is useful if the expected values were calculated from the observed value in a test of independence or test of homogeneity. 4641@EXCEL=This function is Excel compatible. 4642@ODF=CHITEST is the OpenFormula function LEGACY.CHITEST. 4643@SEEALSO=CHIDIST,CHIINV 4644 4645@CATEGORY=Statistics 4646@FUNCTION=CONFIDENCE 4647@SHORTDESC=margin of error of a confidence interval for the population mean 4648@SYNTAX=CONFIDENCE(alpha,stddev,size) 4649@ARGUMENTDESCRIPTION=@{alpha}: significance level 4650@{stddev}: population standard deviation 4651@{size}: sample size 4652@NOTE=This function requires the usually unknown population standard deviation. If @{size} is non-integer it is truncated. If @{size} < 0 this function returns a #NUM! error. If @{size} is 0 this function returns a #DIV/0! error. 4653@EXCEL=This function is Excel compatible. 4654@SEEALSO=AVERAGE,CONFIDENCE.T 4655 4656@CATEGORY=Statistics 4657@FUNCTION=CONFIDENCE.T 4658@SHORTDESC=margin of error of a confidence interval for the population mean using the Student's t-distribution 4659@SYNTAX=CONFIDENCE.T(alpha,stddev,size) 4660@ARGUMENTDESCRIPTION=@{alpha}: significance level 4661@{stddev}: sample standard deviation 4662@{size}: sample size 4663@NOTE=If @{stddev} < 0 or = 0 this function returns a #NUM! error. If @{size} is non-integer it is truncated. If @{size} < 1 this function returns a #NUM! error. If @{size} is 1 this function returns a #DIV/0! error. 4664@EXCEL=This function is Excel compatible. 4665@SEEALSO=AVERAGE,CONFIDENCE 4666 4667@CATEGORY=Statistics 4668@FUNCTION=CORREL 4669@SHORTDESC=Pearson correlation coefficient of two data sets 4670@SYNTAX=CORREL(array1,array2) 4671@ARGUMENTDESCRIPTION=@{array1}: first data set 4672@{array2}: second data set 4673@DESCRIPTION=Strings and empty cells are simply ignored. 4674@EXCEL=This function is Excel compatible. 4675@SEEALSO=COVAR,FISHER,FISHERINV 4676 4677@CATEGORY=Statistics 4678@FUNCTION=COUNT 4679@SHORTDESC=total number of integer or floating point arguments passed 4680@SYNTAX=COUNT(number1,number2,…) 4681@ARGUMENTDESCRIPTION=@{number1}: first value 4682@{number2}: second value 4683@EXCEL=This function is Excel compatible. 4684@SEEALSO=AVERAGE 4685 4686@CATEGORY=Statistics 4687@FUNCTION=COUNTA 4688@SHORTDESC=number of arguments passed not including empty cells 4689@SYNTAX=COUNTA(number1,number2,…) 4690@ARGUMENTDESCRIPTION=@{number1}: first value 4691@{number2}: second value 4692@EXCEL=This function is Excel compatible. 4693@SEEALSO=AVERAGE,COUNT,DCOUNT,DCOUNTA,PRODUCT,SUM 4694 4695@CATEGORY=Statistics 4696@FUNCTION=COVAR 4697@SHORTDESC=covariance of two data sets 4698@SYNTAX=COVAR(array1,array2) 4699@ARGUMENTDESCRIPTION=@{array1}: first data set 4700@{array2}: set data set 4701@DESCRIPTION=Strings and empty cells are simply ignored. 4702@EXCEL=This function is Excel compatible. 4703@SEEALSO=CORREL,FISHER,FISHERINV 4704 4705@CATEGORY=Statistics 4706@FUNCTION=COVARIANCE.S 4707@SHORTDESC=sample covariance of two data sets 4708@SYNTAX=COVARIANCE.S(array1,array2) 4709@ARGUMENTDESCRIPTION=@{array1}: first data set 4710@{array2}: set data set 4711@DESCRIPTION=Strings and empty cells are simply ignored. 4712@EXCEL=This function is Excel compatible. 4713@SEEALSO=COVAR,CORREL 4714 4715@CATEGORY=Statistics 4716@FUNCTION=CRITBINOM 4717@SHORTDESC=right-tailed critical value of the binomial distribution 4718@SYNTAX=CRITBINOM(trials,p,alpha) 4719@ARGUMENTDESCRIPTION=@{trials}: number of trials 4720@{p}: probability of success in each trial 4721@{alpha}: significance level (area of the tail) 4722@NOTE=If @{trials} is a non-integer it is truncated. If @{trials} < 0 this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{alpha} < 0 or @{alpha} > 1 this function returns a #NUM! error. 4723@EXCEL=This function is Excel compatible. 4724@SEEALSO=BINOMDIST 4725 4726@CATEGORY=Statistics 4727@FUNCTION=CRONBACH 4728@SHORTDESC=Cronbach's alpha 4729@SYNTAX=CRONBACH(ref1,ref2,…) 4730@ARGUMENTDESCRIPTION=@{ref1}: first data set 4731@{ref2}: second data set 4732@SEEALSO=VAR 4733 4734@CATEGORY=Statistics 4735@FUNCTION=CVMTEST 4736@SHORTDESC=Cramér-von Mises Test of Normality 4737@SYNTAX=CVMTEST(x) 4738@ARGUMENTDESCRIPTION=@{x}: array of sample values 4739@DESCRIPTION=This function returns an array with the first row giving the p-value of the Cramér-von Mises Test, the second row the test statistic of the test, and the third the number of observations in the sample. 4740@NOTE=If there are less than 8 sample values, CVMTEST returns #VALUE! 4741@SEEALSO=CHITEST,ADTEST,LKSTEST,SFTEST 4742 4743@CATEGORY=Statistics 4744@FUNCTION=DEVSQ 4745@SHORTDESC=sum of squares of deviations of a data set 4746@SYNTAX=DEVSQ(number1,number2,…) 4747@ARGUMENTDESCRIPTION=@{number1}: first value 4748@{number2}: second value 4749@DESCRIPTION=Strings and empty cells are simply ignored. 4750@EXCEL=This function is Excel compatible. 4751@SEEALSO=STDEV 4752 4753@CATEGORY=Statistics 4754@FUNCTION=EXPONDIST 4755@SHORTDESC=probability density or cumulative distribution function of the exponential distribution 4756@SYNTAX=EXPONDIST(x,y,cumulative) 4757@ARGUMENTDESCRIPTION=@{x}: number 4758@{y}: scale parameter 4759@{cumulative}: whether to evaluate the density function or the cumulative distribution function 4760@DESCRIPTION=If @{cumulative} is false it will return: @{y} * exp (-@{y}*@{x}), otherwise it will return 1 - exp (-@{y}*@{x}). 4761@NOTE=If @{x} < 0 or @{y} <= 0 this will return an error. 4762@EXCEL=This function is Excel compatible. 4763@SEEALSO=POISSON 4764 4765@CATEGORY=Statistics 4766@FUNCTION=EXPPOWDIST 4767@SHORTDESC=the probability density function of the Exponential Power distribution 4768@SYNTAX=EXPPOWDIST(x,a,b) 4769@ARGUMENTDESCRIPTION=@{x}: number 4770@{a}: scale parameter 4771@{b}: scale parameter 4772@DESCRIPTION=This distribution has been recommended for lifetime analysis when a U-shaped hazard function is desired. This corresponds to rapid failure once the product starts to wear out after a period of steady or even improving reliability. 4773@SEEALSO=RANDEXPPOW 4774 4775@CATEGORY=Statistics 4776@FUNCTION=FDIST 4777@SHORTDESC=survival function of the F distribution 4778@SYNTAX=FDIST(x,dof_of_num,dof_of_denom) 4779@ARGUMENTDESCRIPTION=@{x}: number 4780@{dof_of_num}: numerator degrees of freedom 4781@{dof_of_denom}: denominator degrees of freedom 4782@DESCRIPTION=The survival function is 1 minus the cumulative distribution function. 4783@NOTE=If @{x} < 0 this function returns a #NUM! error. If @{dof_of_num} < 1 or @{dof_of_denom} < 1, this function returns a #NUM! error. 4784@EXCEL=This function is Excel compatible. 4785@ODF=FDIST is the OpenFormula function LEGACY.FDIST. 4786@SEEALSO=FINV 4787 4788@CATEGORY=Statistics 4789@FUNCTION=FINV 4790@SHORTDESC=inverse of the survival function of the F distribution 4791@SYNTAX=FINV(p,dof_of_num,dof_of_denom) 4792@ARGUMENTDESCRIPTION=@{p}: probability 4793@{dof_of_num}: numerator degrees of freedom 4794@{dof_of_denom}: denominator degrees of freedom 4795@DESCRIPTION=The survival function is 1 minus the cumulative distribution function. 4796@NOTE=If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{dof_of_num} < 1 or @{dof_of_denom} < 1 this function returns a #NUM! error. 4797@EXCEL=This function is Excel compatible. 4798@ODF=FINV is the OpenFormula function LEGACY.FINV. 4799@SEEALSO=FDIST 4800 4801@CATEGORY=Statistics 4802@FUNCTION=FISHER 4803@SHORTDESC=Fisher transformation 4804@SYNTAX=FISHER(x) 4805@ARGUMENTDESCRIPTION=@{x}: number 4806@NOTE=If @{x} is not a number, this function returns a #VALUE! error. If @{x} <= -1 or @{x} >= 1, this function returns a #NUM! error. 4807@EXCEL=This function is Excel compatible. 4808@SEEALSO=FISHERINV,ATANH 4809 4810@CATEGORY=Statistics 4811@FUNCTION=FISHERINV 4812@SHORTDESC=inverse of the Fisher transformation 4813@SYNTAX=FISHERINV(x) 4814@ARGUMENTDESCRIPTION=@{x}: number 4815@NOTE=If @{x} is a non-number this function returns a #VALUE! error. 4816@EXCEL=This function is Excel compatible. 4817@SEEALSO=FISHER,TANH 4818 4819@CATEGORY=Statistics 4820@FUNCTION=FORECAST 4821@SHORTDESC=estimates a future value according to existing values using simple linear regression 4822@SYNTAX=FORECAST(x,known_ys,known_xs) 4823@ARGUMENTDESCRIPTION=@{x}: x-value whose matching y-value should be forecast 4824@{known_ys}: known y-values 4825@{known_xs}: known x-values 4826@DESCRIPTION=This function estimates a future value according to existing values using simple linear regression. 4827@NOTE=If @{known_xs} or @{known_ys} contains no data entries or different number of data entries, this function returns a #N/A error. If the variance of the @{known_xs} is zero, this function returns a #DIV/0 error. 4828@EXCEL=This function is Excel compatible. 4829@SEEALSO=INTERCEPT,TREND 4830 4831@CATEGORY=Statistics 4832@FUNCTION=FREQUENCY 4833@SHORTDESC=frequency table 4834@SYNTAX=FREQUENCY(data_array,bins_array) 4835@ARGUMENTDESCRIPTION=@{data_array}: data values 4836@{bins_array}: array of cutoff values 4837@DESCRIPTION=The results are given as an array. 4838If the @{bins_array} is empty, this function returns the number of data points in @{data_array}. 4839@EXCEL=This function is Excel compatible. 4840 4841@CATEGORY=Statistics 4842@FUNCTION=FTEST 4843@SHORTDESC=p-value for the two-tailed hypothesis test comparing the variances of two populations 4844@SYNTAX=FTEST(array1,array2) 4845@ARGUMENTDESCRIPTION=@{array1}: sample from the first population 4846@{array2}: sample from the second population 4847@EXCEL=This function is Excel compatible. 4848@SEEALSO=FDIST,FINV 4849 4850@CATEGORY=Statistics 4851@FUNCTION=GAMMADIST 4852@SHORTDESC=probability density or cumulative distribution function of the gamma distribution 4853@SYNTAX=GAMMADIST(x,alpha,beta,cumulative) 4854@ARGUMENTDESCRIPTION=@{x}: number 4855@{alpha}: scale parameter 4856@{beta}: scale parameter 4857@{cumulative}: whether to evaluate the density function or the cumulative distribution function 4858@NOTE=If @{x} < 0 this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0, this function returns a #NUM! error. 4859@EXCEL=This function is Excel compatible. 4860@SEEALSO=GAMMAINV 4861 4862@CATEGORY=Statistics 4863@FUNCTION=GAMMAINV 4864@SHORTDESC=inverse of the cumulative gamma distribution 4865@SYNTAX=GAMMAINV(p,alpha,beta) 4866@ARGUMENTDESCRIPTION=@{p}: probability 4867@{alpha}: scale parameter 4868@{beta}: scale parameter 4869@NOTE=If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0 this function returns a #NUM! error. 4870@EXCEL=This function is Excel compatible. 4871@SEEALSO=GAMMADIST 4872 4873@CATEGORY=Statistics 4874@FUNCTION=GEOMDIST 4875@SHORTDESC=probability mass or cumulative distribution function of the geometric distribution 4876@SYNTAX=GEOMDIST(k,p,cumulative) 4877@ARGUMENTDESCRIPTION=@{k}: number of trials 4878@{p}: probability of success in any trial 4879@{cumulative}: whether to evaluate the mass function or the cumulative distribution function 4880@NOTE=If @{k} < 0 this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. If @{cumulative} is neither TRUE nor FALSE this function returns a #VALUE! error. 4881@SEEALSO=RANDGEOM 4882 4883@CATEGORY=Statistics 4884@FUNCTION=GEOMEAN 4885@SHORTDESC=geometric mean 4886@SYNTAX=GEOMEAN(number1,number2,…) 4887@ARGUMENTDESCRIPTION=@{number1}: first value 4888@{number2}: second value 4889@DESCRIPTION=The geometric mean is equal to the Nth root of the product of the N values. 4890@EXCEL=This function is Excel compatible. 4891@SEEALSO=AVERAGE,HARMEAN,MEDIAN,MODE,TRIMMEAN 4892 4893@CATEGORY=Statistics 4894@FUNCTION=GROWTH 4895@SHORTDESC=exponential growth prediction 4896@SYNTAX=GROWTH(known_ys,known_xs,new_xs,affine) 4897@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 4898@{known_xs}: known x-values; defaults to the array {1, 2, 3, …} 4899@{new_xs}: x-values for which to estimate the y-values; defaults to @{known_xs} 4900@{affine}: if true, the model contains a constant term, defaults to true 4901@DESCRIPTION=GROWTH function applies the “least squares” method to fit an exponential curve to your data and predicts the exponential growth by using this curve. 4902GROWTH returns an array having one column and a row for each data point in @{new_xs}. 4903@NOTE=If @{known_ys} and @{known_xs} have unequal number of data points, this function returns a #NUM! error. 4904@SEEALSO=LOGEST,GROWTH,TREND 4905 4906@CATEGORY=Statistics 4907@FUNCTION=HARMEAN 4908@SHORTDESC=harmonic mean 4909@SYNTAX=HARMEAN(number1,number2,…) 4910@ARGUMENTDESCRIPTION=@{number1}: first value 4911@{number2}: second value 4912@DESCRIPTION=The harmonic mean of N data points is N divided by the sum of the reciprocals of the data points). 4913@EXCEL=This function is Excel compatible. 4914@SEEALSO=AVERAGE,GEOMEAN,MEDIAN,MODE,TRIMMEAN 4915 4916@CATEGORY=Statistics 4917@FUNCTION=HYPGEOMDIST 4918@SHORTDESC=probability mass or cumulative distribution function of the hypergeometric distribution 4919@SYNTAX=HYPGEOMDIST(x,n,M,N,cumulative) 4920@ARGUMENTDESCRIPTION=@{x}: number of successes 4921@{n}: sample size 4922@{M}: number of possible successes in the population 4923@{N}: population size 4924@{cumulative}: whether to evaluate the mass function or the cumulative distribution function 4925@NOTE=If @{x},@{n},@{M} or @{N} is a non-integer it is truncated. If @{x},@{n},@{M} or @{N} < 0 this function returns a #NUM! error. If @{x} > @{M} or @{n} > @{N} this function returns a #NUM! error. 4926@EXCEL=This function is Excel compatible. 4927@SEEALSO=BINOMDIST,POISSON 4928 4929@CATEGORY=Statistics 4930@FUNCTION=INTERCEPT 4931@SHORTDESC=the intercept of a linear regression line 4932@SYNTAX=INTERCEPT(known_ys,known_xs) 4933@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 4934@{known_xs}: known x-values 4935@NOTE=If @{known_xs} or @{known_ys} contains no data entries or different number of data entries, this function returns a #N/A error. If the variance of the @{known_xs} is zero, this function returns #DIV/0 error. 4936@EXCEL=This function is Excel compatible. 4937@SEEALSO=FORECAST,TREND 4938 4939@CATEGORY=Statistics 4940@FUNCTION=KURT 4941@SHORTDESC=unbiased estimate of the kurtosis of a data set 4942@SYNTAX=KURT(number1,number2,…) 4943@ARGUMENTDESCRIPTION=@{number1}: first value 4944@{number2}: second value 4945@DESCRIPTION=Strings and empty cells are simply ignored. 4946@NOTE=This is only meaningful if the underlying distribution really has a fourth moment. The kurtosis is offset by three such that a normal distribution will have zero kurtosis. If fewer than four numbers are given or all of them are equal this function returns a #DIV/0! error. 4947@EXCEL=This function is Excel compatible. 4948@SEEALSO=AVERAGE,VAR,SKEW,KURTP 4949 4950@CATEGORY=Statistics 4951@FUNCTION=KURTP 4952@SHORTDESC=population kurtosis of a data set 4953@SYNTAX=KURTP(number1,number2,…) 4954@ARGUMENTDESCRIPTION=@{number1}: first value 4955@{number2}: second value 4956@DESCRIPTION=Strings and empty cells are simply ignored. 4957@NOTE=If fewer than two numbers are given or all of them are equal this function returns a #DIV/0! error. 4958@SEEALSO=AVERAGE,VARP,SKEWP,KURT 4959 4960@CATEGORY=Statistics 4961@FUNCTION=LANDAU 4962@SHORTDESC=approximate probability density function of the Landau distribution 4963@SYNTAX=LANDAU(x) 4964@ARGUMENTDESCRIPTION=@{x}: number 4965@SEEALSO=RANDLANDAU 4966 4967@CATEGORY=Statistics 4968@FUNCTION=LAPLACE 4969@SHORTDESC=probability density function of the Laplace distribution 4970@SYNTAX=LAPLACE(x,a) 4971@ARGUMENTDESCRIPTION=@{x}: number 4972@{a}: mean 4973@SEEALSO=RANDLAPLACE 4974 4975@CATEGORY=Statistics 4976@FUNCTION=LARGE 4977@SHORTDESC=@{k}-th largest value in a data set 4978@SYNTAX=LARGE(data,k) 4979@ARGUMENTDESCRIPTION=@{data}: data set 4980@{k}: which value to find 4981@NOTE=If data set is empty this function returns a #NUM! error. If @{k} <= 0 or @{k} is greater than the number of data items given this function returns a #NUM! error. 4982@EXCEL=This function is Excel compatible. 4983@SEEALSO=PERCENTILE,PERCENTRANK,QUARTILE,SMALL 4984 4985@CATEGORY=Statistics 4986@FUNCTION=LEVERAGE 4987@SHORTDESC=calculate regression leverage 4988@SYNTAX=LEVERAGE(A) 4989@ARGUMENTDESCRIPTION=@{A}: a matrix 4990@DESCRIPTION=Returns the diagonal of @{A} (@{A}^T @{A})^-1 @{A}^T as a column vector. 4991@NOTE=If the matrix is singular, #VALUE! is returned. 4992 4993@CATEGORY=Statistics 4994@FUNCTION=LINEST 4995@SHORTDESC=multiple linear regression coefficients and statistics 4996@SYNTAX=LINEST(known_ys,known_xs,affine,stats) 4997@ARGUMENTDESCRIPTION=@{known_ys}: vector of values of dependent variable 4998@{known_xs}: array of values of independent variables, defaults to a single vector {1,…,n} 4999@{affine}: if true, the model contains a constant term, defaults to true 5000@{stats}: if true, some additional statistics are provided, defaults to false 5001@DESCRIPTION=This function returns an array with the first row giving the regression coefficients for the independent variables x_m, x_(m-1),…,x_2, x_1 followed by the y-intercept if @{affine} is true. 5002If @{stats} is true, the second row contains the corresponding standard errors of the regression coefficients. In this case, the third row contains the R^2 value and the standard error for the predicted value. The fourth row contains the observed F value and its degrees of freedom. Finally, the fifth row contains the regression sum of squares and the residual sum of squares. 5003If @{affine} is false, R^2 is the uncentered version of the coefficient of determination; that is the proportion of the sum of squares explained by the model. 5004@NOTE=If the length of @{known_ys} does not match the corresponding length of @{known_xs}, this function returns a #NUM! error. 5005@SEEALSO=LOGEST,TREND 5006 5007@CATEGORY=Statistics 5008@FUNCTION=LKSTEST 5009@SHORTDESC=Lilliefors (Kolmogorov-Smirnov) Test of Normality 5010@SYNTAX=LKSTEST(x) 5011@ARGUMENTDESCRIPTION=@{x}: array of sample values 5012@DESCRIPTION=This function returns an array with the first row giving the p-value of the Lilliefors (Kolmogorov-Smirnov) Test, the second row the test statistic of the test, and the third the number of observations in the sample. 5013@NOTE=If there are less than 5 sample values, LKSTEST returns #VALUE! 5014@SEEALSO=CHITEST,ADTEST,SFTEST,CVMTEST 5015 5016@CATEGORY=Statistics 5017@FUNCTION=LOGEST 5018@SHORTDESC=exponential least square fit 5019@SYNTAX=LOGEST(known_ys,known_xs,affine,stat) 5020@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 5021@{known_xs}: known x-values; default to an array {1, 2, 3, …} 5022@{affine}: if true, the model contains a constant term, defaults to true 5023@{stat}: if true, extra statistical information will be returned; defaults to FALSE 5024@DESCRIPTION=LOGEST function applies the “least squares” method to fit an exponential curve of the form y = b * m{1}^x{1} * m{2}^x{2}... to your data. 5025LOGEST returns an array { m{n},m{n-1}, ...,m{1},b }. 5026@NOTE=Extra statistical information is written below the regression line coefficients in the result array. Extra statistical information consists of four rows of data. In the first row the standard error values for the coefficients m1, (m2, ...), b are represented. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares. If @{known_ys} and @{known_xs} have unequal number of data points, this function returns a #NUM! error. 5027@SEEALSO=GROWTH,TREND 5028 5029@CATEGORY=Statistics 5030@FUNCTION=LOGFIT 5031@SHORTDESC=logarithmic least square fit (using a trial and error method) 5032@SYNTAX=LOGFIT(known_ys,known_xs) 5033@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 5034@{known_xs}: known x-values 5035@DESCRIPTION=LOGFIT function applies the “least squares” method to fit the logarithmic equation y = a + b * ln(sign * (x - c)) , sign = +1 or -1 to your data. The graph of the equation is a logarithmic curve moved horizontally by c and possibly mirrored across the y-axis (if sign = -1). 5036LOGFIT returns an array having five columns and one row. `Sign' is given in the first column, `a', `b', and `c' are given in columns 2 to 4. Column 5 holds the sum of squared residuals. 5037@NOTE=An error is returned when there are less than 3 different x's or y's, or when the shape of the point cloud is too different from a ``logarithmic'' one. You can use the above formula = a + b * ln(sign * (x - c)) or rearrange it to = (exp((y - a) / b)) / sign + c to compute unknown y's or x's, respectively. This is non-linear fitting by trial-and-error. The accuracy of `c' is: width of x-range -> rounded to the next smaller (10^integer), times 0.000001. There might be cases in which the returned fit is not the best possible. 5038@SEEALSO=LOGREG,LINEST,LOGEST 5039 5040@CATEGORY=Statistics 5041@FUNCTION=LOGINV 5042@SHORTDESC=inverse of the cumulative distribution function of the lognormal distribution 5043@SYNTAX=LOGINV(p,mean,stddev) 5044@ARGUMENTDESCRIPTION=@{p}: probability 5045@{mean}: mean 5046@{stddev}: standard deviation 5047@NOTE=If @{p} < 0 or @{p} > 1 or @{stddev} <= 0 this function returns #NUM! error. 5048@EXCEL=This function is Excel compatible. 5049@SEEALSO=EXP,LN,LOG,LOG10,LOGNORMDIST 5050 5051@CATEGORY=Statistics 5052@FUNCTION=LOGISTIC 5053@SHORTDESC=probability density function of the logistic distribution 5054@SYNTAX=LOGISTIC(x,a) 5055@ARGUMENTDESCRIPTION=@{x}: number 5056@{a}: scale parameter 5057@SEEALSO=RANDLOGISTIC 5058 5059@CATEGORY=Statistics 5060@FUNCTION=LOGNORMDIST 5061@SHORTDESC=cumulative distribution function of the lognormal distribution 5062@SYNTAX=LOGNORMDIST(x,mean,stddev) 5063@ARGUMENTDESCRIPTION=@{x}: number 5064@{mean}: mean 5065@{stddev}: standard deviation 5066@NOTE=If @{stddev} = 0 LOGNORMDIST returns a #DIV/0! error. If @{x} <= 0, @{mean} < 0 or @{stddev} <= 0 this function returns a #NUM! error. 5067@EXCEL=This function is Excel compatible. 5068@SEEALSO=NORMDIST 5069 5070@CATEGORY=Statistics 5071@FUNCTION=LOGREG 5072@SHORTDESC=the logarithmic regression 5073@SYNTAX=LOGREG(known_ys,known_xs,affine,stat) 5074@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 5075@{known_xs}: known x-values; defaults to the array {1, 2, 3, …} 5076@{affine}: if true, the model contains a constant term, defaults to true 5077@{stat}: if true, extra statistical information will be returned; defaults to FALSE 5078@DESCRIPTION=LOGREG function transforms your x's to z=ln(x) and applies the “least squares” method to fit the linear equation y = m * z + b to your y's and z's --- equivalent to fitting the equation y = m * ln(x) + b to y's and x's. LOGREG returns an array having two columns and one row. m is given in the first column and b in the second. 5079Any extra statistical information is written below m and b in the result array. This extra statistical information consists of four rows of data: In the first row the standard error values for the coefficients m, b are given. The second row contains the square of R and the standard error for the y estimate. The third row contains the F-observed value and the degrees of freedom. The last row contains the regression sum of squares and the residual sum of squares. The default of @{stat} is FALSE. 5080@NOTE=If @{known_ys} and @{known_xs} have unequal number of data points, this function returns a #NUM! error. 5081@SEEALSO=LOGFIT,LINEST,LOGEST 5082 5083@CATEGORY=Statistics 5084@FUNCTION=MAX 5085@SHORTDESC=largest value, with negative numbers considered smaller than positive numbers 5086@SYNTAX=MAX(number1,number2,…) 5087@ARGUMENTDESCRIPTION=@{number1}: first value 5088@{number2}: second value 5089@EXCEL=This function is Excel compatible. 5090@SEEALSO=MIN,ABS 5091 5092@CATEGORY=Statistics 5093@FUNCTION=MAXA 5094@SHORTDESC=largest value, with negative numbers considered smaller than positive numbers 5095@SYNTAX=MAXA(number1,number2,…) 5096@ARGUMENTDESCRIPTION=@{number1}: first value 5097@{number2}: second value 5098@DESCRIPTION=Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 5099@EXCEL=This function is Excel compatible. 5100@SEEALSO=MAX,MINA 5101 5102@CATEGORY=Statistics 5103@FUNCTION=MEDIAN 5104@SHORTDESC=median of a data set 5105@SYNTAX=MEDIAN(number1,number2,…) 5106@ARGUMENTDESCRIPTION=@{number1}: first value 5107@{number2}: second value 5108@DESCRIPTION=Strings and empty cells are simply ignored. 5109@NOTE=If even numbers are given MEDIAN returns the average of the two numbers in the center. 5110@EXCEL=This function is Excel compatible. 5111@SEEALSO=AVERAGE,COUNT,COUNTA,DAVERAGE,MODE,SSMEDIAN,SUM 5112 5113@CATEGORY=Statistics 5114@FUNCTION=MIN 5115@SHORTDESC=smallest value, with negative numbers considered smaller than positive numbers 5116@SYNTAX=MIN(number1,number2,…) 5117@ARGUMENTDESCRIPTION=@{number1}: first value 5118@{number2}: second value 5119@EXCEL=This function is Excel compatible. 5120@SEEALSO=MAX,ABS 5121 5122@CATEGORY=Statistics 5123@FUNCTION=MINA 5124@SHORTDESC=smallest value, with negative numbers considered smaller than positive numbers 5125@SYNTAX=MINA(number1,number2,…) 5126@ARGUMENTDESCRIPTION=@{number1}: first value 5127@{number2}: second value 5128@DESCRIPTION=Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 5129@EXCEL=This function is Excel compatible. 5130@SEEALSO=MIN,MAXA 5131 5132@CATEGORY=Statistics 5133@FUNCTION=MODE 5134@SHORTDESC=first most common number in the dataset 5135@SYNTAX=MODE(number1,number2,…) 5136@ARGUMENTDESCRIPTION=@{number1}: first value 5137@{number2}: second value 5138@DESCRIPTION=Strings and empty cells are simply ignored. 5139If the data set does not contain any duplicates this function returns a #N/A error. 5140@EXCEL=This function is Excel compatible. 5141@SEEALSO=AVERAGE,MEDIAN,MODE.MULT 5142 5143@CATEGORY=Statistics 5144@FUNCTION=MODE.MULT 5145@SHORTDESC=most common numbers in the dataset 5146@SYNTAX=MODE.MULT(number1,number2,…) 5147@ARGUMENTDESCRIPTION=@{number1}: first value 5148@{number2}: second value 5149@DESCRIPTION=Strings and empty cells are simply ignored. 5150If the data set does not contain any duplicates this function returns a #N/A error. 5151@EXCEL=This function is Excel compatible. 5152@SEEALSO=AVERAGE,MEDIAN,MODE 5153 5154@CATEGORY=Statistics 5155@FUNCTION=NEGBINOMDIST 5156@SHORTDESC=probability mass function of the negative binomial distribution 5157@SYNTAX=NEGBINOMDIST(f,t,p) 5158@ARGUMENTDESCRIPTION=@{f}: number of failures 5159@{t}: threshold number of successes 5160@{p}: probability of a success 5161@NOTE=If @{f} or @{t} is a non-integer it is truncated. If (@{f} + @{t} -1) <= 0 this function returns a #NUM! error. If @{p} < 0 or @{p} > 1 this function returns a #NUM! error. 5162@EXCEL=This function is Excel compatible. 5163@SEEALSO=BINOMDIST,COMBIN,FACT,HYPGEOMDIST,PERMUT 5164 5165@CATEGORY=Statistics 5166@FUNCTION=NORMDIST 5167@SHORTDESC=probability density or cumulative distribution function of a normal distribution 5168@SYNTAX=NORMDIST(x,mean,stddev,cumulative) 5169@ARGUMENTDESCRIPTION=@{x}: number 5170@{mean}: mean of the distribution 5171@{stddev}: standard deviation of the distribution 5172@{cumulative}: whether to evaluate the density function or the cumulative distribution function 5173@NOTE=If @{stddev} is 0 this function returns a #DIV/0! error. 5174@EXCEL=This function is Excel compatible. 5175@SEEALSO=POISSON 5176 5177@CATEGORY=Statistics 5178@FUNCTION=NORMINV 5179@SHORTDESC=inverse of the cumulative distribution function of a normal distribution 5180@SYNTAX=NORMINV(p,mean,stddev) 5181@ARGUMENTDESCRIPTION=@{p}: probability 5182@{mean}: mean of the distribution 5183@{stddev}: standard deviation of the distribution 5184@NOTE=If @{p} < 0 or @{p} > 1 or @{stddev} <= 0 this function returns a #NUM! error. 5185@EXCEL=This function is Excel compatible. 5186@SEEALSO=NORMDIST,NORMSDIST,NORMSINV,STANDARDIZE,ZTEST 5187 5188@CATEGORY=Statistics 5189@FUNCTION=NORMSDIST 5190@SHORTDESC=cumulative distribution function of the standard normal distribution 5191@SYNTAX=NORMSDIST(x) 5192@ARGUMENTDESCRIPTION=@{x}: number 5193@EXCEL=This function is Excel compatible. 5194@ODF=NORMSDIST is the OpenFormula function LEGACY.NORMSDIST. 5195@SEEALSO=NORMDIST 5196 5197@CATEGORY=Statistics 5198@FUNCTION=NORMSINV 5199@SHORTDESC=inverse of the cumulative distribution function of the standard normal distribution 5200@SYNTAX=NORMSINV(p) 5201@ARGUMENTDESCRIPTION=@{p}: given probability 5202@NOTE=If @{p} < 0 or @{p} > 1 this function returns #NUM! error. 5203@EXCEL=This function is Excel compatible. 5204@ODF=NORMSINV is the OpenFormula function LEGACY.NORMSINV. 5205@SEEALSO=NORMDIST,NORMINV,NORMSDIST,STANDARDIZE,ZTEST 5206 5207@CATEGORY=Statistics 5208@FUNCTION=OWENT 5209@SHORTDESC=Owen's T function 5210@SYNTAX=OWENT(h,a) 5211@ARGUMENTDESCRIPTION=@{h}: number 5212@{a}: number 5213@SEEALSO=R.PSNORM,R.PST 5214 5215@CATEGORY=Statistics 5216@FUNCTION=PARETO 5217@SHORTDESC=probability density function of the Pareto distribution 5218@SYNTAX=PARETO(x,a,b) 5219@ARGUMENTDESCRIPTION=@{x}: number 5220@{a}: exponent 5221@{b}: scale parameter 5222@SEEALSO=RANDPARETO 5223 5224@CATEGORY=Statistics 5225@FUNCTION=PEARSON 5226@SHORTDESC=Pearson correlation coefficient of the paired set of data 5227@SYNTAX=PEARSON(array1,array2) 5228@ARGUMENTDESCRIPTION=@{array1}: first component values 5229@{array2}: second component values 5230@DESCRIPTION=Strings and empty cells are simply ignored. 5231@EXCEL=This function is Excel compatible. 5232@SEEALSO=INTERCEPT,LINEST,RSQ,SLOPE,STEYX 5233 5234@CATEGORY=Statistics 5235@FUNCTION=PERCENTILE 5236@SHORTDESC=determines the 100*@{k}-th percentile of the given data points (Hyndman-Fan method 7: N-1 basis) 5237@SYNTAX=PERCENTILE(array,k) 5238@ARGUMENTDESCRIPTION=@{array}: data points 5239@{k}: which percentile to calculate 5240@NOTE=If @{array} is empty, this function returns a #NUM! error. If @{k} < 0 or @{k} > 1, this function returns a #NUM! error. 5241@EXCEL=This function is Excel compatible. 5242@SEEALSO=QUARTILE 5243 5244@CATEGORY=Statistics 5245@FUNCTION=PERCENTILE.EXC 5246@SHORTDESC=determines the 100*@{k}-th percentile of the given data points (Hyndman-Fan method 6: N+1 basis) 5247@SYNTAX=PERCENTILE.EXC(array,k) 5248@ARGUMENTDESCRIPTION=@{array}: data points 5249@{k}: which percentile to calculate 5250@NOTE=If @{array} is empty, this function returns a #NUM! error. If @{k} < 0 or @{k} > 1, this function returns a #NUM! error. 5251@EXCEL=This function is Excel compatible. 5252@SEEALSO=PERCENTILE,QUARTILE,QUARTILE.EXC 5253 5254@CATEGORY=Statistics 5255@FUNCTION=PERCENTRANK 5256@SHORTDESC=rank of a data point in a data set (Hyndman-Fan method 7: N-1 basis) 5257@SYNTAX=PERCENTRANK(array,x,significance) 5258@ARGUMENTDESCRIPTION=@{array}: range of numeric values 5259@{x}: data point to be ranked 5260@{significance}: number of significant digits, defaults to 3 5261@NOTE=If @{array} contains no data points, this function returns a #NUM! error. If @{significance} is less than one, this function returns a #NUM! error. If @{x} exceeds the largest value or is less than the smallest value in @{array}, this function returns an #N/A error. If @{x} does not match any of the values in @{array} or @{x} matches more than once, this function interpolates the returned value. 5262@SEEALSO=LARGE,MAX,MEDIAN,MIN,PERCENTILE,QUARTILE,SMALL 5263 5264@CATEGORY=Statistics 5265@FUNCTION=PERCENTRANK.EXC 5266@SHORTDESC=rank of a data point in a data set (Hyndman-Fan method 6: N+1 basis) 5267@SYNTAX=PERCENTRANK.EXC(array,x,significance) 5268@ARGUMENTDESCRIPTION=@{array}: range of numeric values 5269@{x}: data point to be ranked 5270@{significance}: number of significant digits, defaults to 3 5271@NOTE=If @{array} contains no data points, this function returns a #NUM! error. If @{significance} is less than one, this function returns a #NUM! error. If @{x} exceeds the largest value or is less than the smallest value in @{array}, this function returns an #N/A error. If @{x} does not match any of the values in @{array} or @{x} matches more than once, this function interpolates the returned value. 5272@SEEALSO=LARGE,MAX,MEDIAN,MIN,PERCENTILE,PERCENTILE.EXC,QUARTILE,QUARTILE.EXC,SMALL 5273 5274@CATEGORY=Statistics 5275@FUNCTION=PERMUT 5276@SHORTDESC=number of @{k}-permutations of a @{n}-set 5277@SYNTAX=PERMUT(n,k) 5278@ARGUMENTDESCRIPTION=@{n}: size of the base set 5279@{k}: number of elements in each permutation 5280@NOTE=If @{n} = 0 this function returns a #NUM! error. If @{n} < @{k} this function returns a #NUM! error. 5281@EXCEL=This function is Excel compatible. 5282@SEEALSO=COMBIN 5283 5284@CATEGORY=Statistics 5285@FUNCTION=PERMUTATIONA 5286@SHORTDESC=the number of permutations of @{y} objects chosen from @{x} objects with repetition allowed 5287@SYNTAX=PERMUTATIONA(x,y) 5288@ARGUMENTDESCRIPTION=@{x}: total number of objects 5289@{y}: number of selected objects 5290@NOTE=If both @{x} and @{y} equal 0, PERMUTATIONA returns 1. If @{x} < 0 or @{y} < 0, PERMUTATIONA returns #NUM! If @{x} or @{y} are not integers, they are truncated. 5291@ODF=This function is OpenFormula compatible. 5292@SEEALSO=POWER 5293 5294@CATEGORY=Statistics 5295@FUNCTION=POISSON 5296@SHORTDESC=probability mass or cumulative distribution function of the Poisson distribution 5297@SYNTAX=POISSON(x,mean,cumulative) 5298@ARGUMENTDESCRIPTION=@{x}: number of events 5299@{mean}: mean of the distribution 5300@{cumulative}: whether to evaluate the mass function or the cumulative distribution function 5301@NOTE=If @{x} is a non-integer it is truncated. If @{x} < 0 this function returns a #NUM! error. If @{mean} <= 0 POISSON returns the #NUM! error. 5302@EXCEL=This function is Excel compatible. 5303@SEEALSO=NORMDIST,WEIBULL 5304 5305@CATEGORY=Statistics 5306@FUNCTION=PROB 5307@SHORTDESC=probability of an interval for a discrete (and finite) probability distribution 5308@SYNTAX=PROB(x_range,prob_range,lower_limit,upper_limit) 5309@ARGUMENTDESCRIPTION=@{x_range}: possible values 5310@{prob_range}: probabilities of the corresponding values 5311@{lower_limit}: lower interval limit 5312@{upper_limit}: upper interval limit, defaults to @{lower_limit} 5313@NOTE=If the sum of the probabilities in @{prob_range} is not equal to 1 this function returns a #NUM! error. If any value in @{prob_range} is <=0 or > 1, this function returns a #NUM! error. If @{x_range} and @{prob_range} contain a different number of data entries, this function returns a #N/A error. 5314@EXCEL=This function is Excel compatible. 5315@SEEALSO=BINOMDIST,CRITBINOM 5316 5317@CATEGORY=Statistics 5318@FUNCTION=QUARTILE 5319@SHORTDESC=the @{k}-th quartile of the data points (Hyndman-Fan method 7: N-1 basis) 5320@SYNTAX=QUARTILE(array,quart) 5321@ARGUMENTDESCRIPTION=@{array}: data points 5322@{quart}: a number from 0 to 4, indicating which quartile to calculate 5323@NOTE=If @{array} is empty, this function returns a #NUM! error. If @{quart} < 0 or @{quart} > 4, this function returns a #NUM! error. If @{quart} = 0, the smallest value of @{array} to be returned. If @{quart} is not an integer, it is truncated. 5324@EXCEL=This function is Excel compatible. 5325@SEEALSO=LARGE,MAX,MEDIAN,MIN,PERCENTILE,QUARTILE.EXC,SMALL 5326 5327@CATEGORY=Statistics 5328@FUNCTION=QUARTILE.EXC 5329@SHORTDESC=the @{k}-th quartile of the data points (Hyndman-Fan method 6: N+1 basis) 5330@SYNTAX=QUARTILE.EXC(array,quart) 5331@ARGUMENTDESCRIPTION=@{array}: data points 5332@{quart}: a number from 1 to 3, indicating which quartile to calculate 5333@NOTE=If @{array} is empty, this function returns a #NUM! error. If @{quart} < 0 or @{quart} > 4, this function returns a #NUM! error. If @{quart} = 0, the smallest value of @{array} to be returned. If @{quart} is not an integer, it is truncated. 5334@EXCEL=This function is Excel compatible. 5335@SEEALSO=LARGE,MAX,MEDIAN,MIN,PERCENTILE,PERCENTILE.EXC,QUARTILE,SMALL 5336 5337@CATEGORY=Statistics 5338@FUNCTION=R.DBETA 5339@SHORTDESC=probability density function of the beta distribution 5340@SYNTAX=R.DBETA(x,a,b,give_log) 5341@ARGUMENTDESCRIPTION=@{x}: observation 5342@{a}: the first shape parameter of the distribution 5343@{b}: the second scale parameter of the distribution 5344@{give_log}: if true, log of the result will be returned instead 5345@DESCRIPTION=This function returns the probability density function of the beta distribution. 5346@SEEALSO=R.PBETA,R.QBETA 5347 5348@CATEGORY=Statistics 5349@FUNCTION=R.DBINOM 5350@SHORTDESC=probability density function of the binomial distribution 5351@SYNTAX=R.DBINOM(x,n,psuc,give_log) 5352@ARGUMENTDESCRIPTION=@{x}: observation 5353@{n}: the number of trials 5354@{psuc}: the probability of success in each trial 5355@{give_log}: if true, log of the result will be returned instead 5356@DESCRIPTION=This function returns the probability density function of the binomial distribution. 5357@SEEALSO=R.PBINOM,R.QBINOM 5358 5359@CATEGORY=Statistics 5360@FUNCTION=R.DCAUCHY 5361@SHORTDESC=probability density function of the Cauchy distribution 5362@SYNTAX=R.DCAUCHY(x,location,scale,give_log) 5363@ARGUMENTDESCRIPTION=@{x}: observation 5364@{location}: the center of the distribution 5365@{scale}: the scale parameter of the distribution 5366@{give_log}: if true, log of the result will be returned instead 5367@DESCRIPTION=This function returns the probability density function of the Cauchy distribution. 5368@SEEALSO=R.PCAUCHY,R.QCAUCHY 5369 5370@CATEGORY=Statistics 5371@FUNCTION=R.DCHISQ 5372@SHORTDESC=probability density function of the chi-square distribution 5373@SYNTAX=R.DCHISQ(x,df,give_log) 5374@ARGUMENTDESCRIPTION=@{x}: observation 5375@{df}: the number of degrees of freedom of the distribution 5376@{give_log}: if true, log of the result will be returned instead 5377@DESCRIPTION=This function returns the probability density function of the chi-square distribution. 5378@ODF=A two argument invocation R.DCHISQ(@{x},@{df}) is exported to OpenFormula as CHISQDIST(@{x},@{df},FALSE()). 5379@SEEALSO=R.PCHISQ,R.QCHISQ 5380 5381@CATEGORY=Statistics 5382@FUNCTION=R.DEXP 5383@SHORTDESC=probability density function of the exponential distribution 5384@SYNTAX=R.DEXP(x,scale,give_log) 5385@ARGUMENTDESCRIPTION=@{x}: observation 5386@{scale}: the scale parameter of the distribution 5387@{give_log}: if true, log of the result will be returned instead 5388@DESCRIPTION=This function returns the probability density function of the exponential distribution. 5389@SEEALSO=R.PEXP,R.QEXP 5390 5391@CATEGORY=Statistics 5392@FUNCTION=R.DF 5393@SHORTDESC=probability density function of the F distribution 5394@SYNTAX=R.DF(x,n1,n2,give_log) 5395@ARGUMENTDESCRIPTION=@{x}: observation 5396@{n1}: the first number of degrees of freedom of the distribution 5397@{n2}: the second number of degrees of freedom of the distribution 5398@{give_log}: if true, log of the result will be returned instead 5399@DESCRIPTION=This function returns the probability density function of the F distribution. 5400@SEEALSO=R.PF,R.QF 5401 5402@CATEGORY=Statistics 5403@FUNCTION=R.DGAMMA 5404@SHORTDESC=probability density function of the gamma distribution 5405@SYNTAX=R.DGAMMA(x,shape,scale,give_log) 5406@ARGUMENTDESCRIPTION=@{x}: observation 5407@{shape}: the shape parameter of the distribution 5408@{scale}: the scale parameter of the distribution 5409@{give_log}: if true, log of the result will be returned instead 5410@DESCRIPTION=This function returns the probability density function of the gamma distribution. 5411@SEEALSO=R.PGAMMA,R.QGAMMA 5412 5413@CATEGORY=Statistics 5414@FUNCTION=R.DGEOM 5415@SHORTDESC=probability density function of the geometric distribution 5416@SYNTAX=R.DGEOM(x,psuc,give_log) 5417@ARGUMENTDESCRIPTION=@{x}: observation 5418@{psuc}: the probability of success in each trial 5419@{give_log}: if true, log of the result will be returned instead 5420@DESCRIPTION=This function returns the probability density function of the geometric distribution. 5421@SEEALSO=R.PGEOM,R.QGEOM 5422 5423@CATEGORY=Statistics 5424@FUNCTION=R.DGUMBEL 5425@SHORTDESC=probability density function of the Gumbel distribution 5426@SYNTAX=R.DGUMBEL(x,mu,beta,give_log) 5427@ARGUMENTDESCRIPTION=@{x}: observation 5428@{mu}: the location parameter of freedom of the distribution 5429@{beta}: the scale parameter of freedom of the distribution 5430@{give_log}: if true, log of the result will be returned instead 5431@DESCRIPTION=This function returns the probability density function of the Gumbel distribution. 5432@SEEALSO=R.PGUMBEL,R.QGUMBEL 5433 5434@CATEGORY=Statistics 5435@FUNCTION=R.DHYPER 5436@SHORTDESC=probability density function of the hypergeometric distribution 5437@SYNTAX=R.DHYPER(x,r,b,n,give_log) 5438@ARGUMENTDESCRIPTION=@{x}: observation 5439@{r}: the number of red balls 5440@{b}: the number of black balls 5441@{n}: the number of balls drawn 5442@{give_log}: if true, log of the result will be returned instead 5443@DESCRIPTION=This function returns the probability density function of the hypergeometric distribution. 5444@SEEALSO=R.PHYPER,R.QHYPER 5445 5446@CATEGORY=Statistics 5447@FUNCTION=R.DLNORM 5448@SHORTDESC=probability density function of the log-normal distribution 5449@SYNTAX=R.DLNORM(x,logmean,logsd,give_log) 5450@ARGUMENTDESCRIPTION=@{x}: observation 5451@{logmean}: mean of the underlying normal distribution 5452@{logsd}: standard deviation of the underlying normal distribution 5453@{give_log}: if true, log of the result will be returned instead 5454@DESCRIPTION=This function returns the probability density function of the log-normal distribution. 5455@SEEALSO=R.PLNORM,R.QLNORM 5456 5457@CATEGORY=Statistics 5458@FUNCTION=R.DNBINOM 5459@SHORTDESC=probability density function of the negative binomial distribution 5460@SYNTAX=R.DNBINOM(x,n,psuc,give_log) 5461@ARGUMENTDESCRIPTION=@{x}: observation (number of failures) 5462@{n}: required number of successes 5463@{psuc}: the probability of success in each trial 5464@{give_log}: if true, log of the result will be returned instead 5465@DESCRIPTION=This function returns the probability density function of the negative binomial distribution. 5466@SEEALSO=R.PNBINOM,R.QNBINOM 5467 5468@CATEGORY=Statistics 5469@FUNCTION=R.DNORM 5470@SHORTDESC=probability density function of the normal distribution 5471@SYNTAX=R.DNORM(x,mu,sigma,give_log) 5472@ARGUMENTDESCRIPTION=@{x}: observation 5473@{mu}: mean of the distribution 5474@{sigma}: standard deviation of the distribution 5475@{give_log}: if true, log of the result will be returned instead 5476@DESCRIPTION=This function returns the probability density function of the normal distribution. 5477@SEEALSO=R.PNORM,R.QNORM 5478 5479@CATEGORY=Statistics 5480@FUNCTION=R.DPOIS 5481@SHORTDESC=probability density function of the Poisson distribution 5482@SYNTAX=R.DPOIS(x,lambda,give_log) 5483@ARGUMENTDESCRIPTION=@{x}: observation 5484@{lambda}: the mean of the distribution 5485@{give_log}: if true, log of the result will be returned instead 5486@DESCRIPTION=This function returns the probability density function of the Poisson distribution. 5487@SEEALSO=R.PPOIS,R.QPOIS 5488 5489@CATEGORY=Statistics 5490@FUNCTION=R.DRAYLEIGH 5491@SHORTDESC=probability density function of the Rayleigh distribution 5492@SYNTAX=R.DRAYLEIGH(x,scale,give_log) 5493@ARGUMENTDESCRIPTION=@{x}: observation 5494@{scale}: the scale parameter of the distribution 5495@{give_log}: if true, log of the result will be returned instead 5496@DESCRIPTION=This function returns the probability density function of the Rayleigh distribution. 5497@SEEALSO=R.PRAYLEIGH,R.QRAYLEIGH 5498 5499@CATEGORY=Statistics 5500@FUNCTION=R.DSNORM 5501@SHORTDESC=probability density function of the skew-normal distribution 5502@SYNTAX=R.DSNORM(x,shape,location,scale,give_log) 5503@ARGUMENTDESCRIPTION=@{x}: observation 5504@{shape}: the shape parameter of the distribution 5505@{location}: the location parameter of the distribution 5506@{scale}: the scale parameter of the distribution 5507@{give_log}: if true, log of the result will be returned instead 5508@DESCRIPTION=This function returns the probability density function of the skew-normal distribution. 5509@SEEALSO=R.PSNORM,R.QSNORM 5510 5511@CATEGORY=Statistics 5512@FUNCTION=R.DST 5513@SHORTDESC=probability density function of the skew-t distribution 5514@SYNTAX=R.DST(x,n,shape,give_log) 5515@ARGUMENTDESCRIPTION=@{x}: observation 5516@{n}: the number of degrees of freedom of the distribution 5517@{shape}: the shape parameter of the distribution 5518@{give_log}: if true, log of the result will be returned instead 5519@DESCRIPTION=This function returns the probability density function of the skew-t distribution. 5520@SEEALSO=R.PST,R.QST 5521 5522@CATEGORY=Statistics 5523@FUNCTION=R.DT 5524@SHORTDESC=probability density function of the Student t distribution 5525@SYNTAX=R.DT(x,n,give_log) 5526@ARGUMENTDESCRIPTION=@{x}: observation 5527@{n}: the number of degrees of freedom of the distribution 5528@{give_log}: if true, log of the result will be returned instead 5529@DESCRIPTION=This function returns the probability density function of the Student t distribution. 5530@SEEALSO=R.PT,R.QT 5531 5532@CATEGORY=Statistics 5533@FUNCTION=R.DWEIBULL 5534@SHORTDESC=probability density function of the Weibull distribution 5535@SYNTAX=R.DWEIBULL(x,shape,scale,give_log) 5536@ARGUMENTDESCRIPTION=@{x}: observation 5537@{shape}: the shape parameter of the distribution 5538@{scale}: the scale parameter of the distribution 5539@{give_log}: if true, log of the result will be returned instead 5540@DESCRIPTION=This function returns the probability density function of the Weibull distribution. 5541@SEEALSO=R.PWEIBULL,R.QWEIBULL 5542 5543@CATEGORY=Statistics 5544@FUNCTION=R.PBETA 5545@SHORTDESC=cumulative distribution function of the beta distribution 5546@SYNTAX=R.PBETA(x,a,b,lower_tail,log_p) 5547@ARGUMENTDESCRIPTION=@{x}: observation 5548@{a}: the first shape parameter of the distribution 5549@{b}: the second scale parameter of the distribution 5550@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5551@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5552@DESCRIPTION=This function returns the cumulative distribution function of the beta distribution. 5553@SEEALSO=R.DBETA,R.QBETA 5554 5555@CATEGORY=Statistics 5556@FUNCTION=R.PBINOM 5557@SHORTDESC=cumulative distribution function of the binomial distribution 5558@SYNTAX=R.PBINOM(x,n,psuc,lower_tail,log_p) 5559@ARGUMENTDESCRIPTION=@{x}: observation 5560@{n}: the number of trials 5561@{psuc}: the probability of success in each trial 5562@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5563@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5564@DESCRIPTION=This function returns the cumulative distribution function of the binomial distribution. 5565@SEEALSO=R.DBINOM,R.QBINOM 5566 5567@CATEGORY=Statistics 5568@FUNCTION=R.PCAUCHY 5569@SHORTDESC=cumulative distribution function of the Cauchy distribution 5570@SYNTAX=R.PCAUCHY(x,location,scale,lower_tail,log_p) 5571@ARGUMENTDESCRIPTION=@{x}: observation 5572@{location}: the center of the distribution 5573@{scale}: the scale parameter of the distribution 5574@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5575@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5576@DESCRIPTION=This function returns the cumulative distribution function of the Cauchy distribution. 5577@SEEALSO=R.DCAUCHY,R.QCAUCHY 5578 5579@CATEGORY=Statistics 5580@FUNCTION=R.PCHISQ 5581@SHORTDESC=cumulative distribution function of the chi-square distribution 5582@SYNTAX=R.PCHISQ(x,df,lower_tail,log_p) 5583@ARGUMENTDESCRIPTION=@{x}: observation 5584@{df}: the number of degrees of freedom of the distribution 5585@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5586@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5587@DESCRIPTION=This function returns the cumulative distribution function of the chi-square distribution. 5588@ODF=A two argument invocation R.PCHISQ(@{x},@{df}) is exported to OpenFormula as CHISQDIST(@{x},@{df}). 5589@SEEALSO=R.DCHISQ,R.QCHISQ 5590 5591@CATEGORY=Statistics 5592@FUNCTION=R.PEXP 5593@SHORTDESC=cumulative distribution function of the exponential distribution 5594@SYNTAX=R.PEXP(x,scale,lower_tail,log_p) 5595@ARGUMENTDESCRIPTION=@{x}: observation 5596@{scale}: the scale parameter of the distribution 5597@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5598@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5599@DESCRIPTION=This function returns the cumulative distribution function of the exponential distribution. 5600@SEEALSO=R.DEXP,R.QEXP 5601 5602@CATEGORY=Statistics 5603@FUNCTION=R.PF 5604@SHORTDESC=cumulative distribution function of the F distribution 5605@SYNTAX=R.PF(x,n1,n2,lower_tail,log_p) 5606@ARGUMENTDESCRIPTION=@{x}: observation 5607@{n1}: the first number of degrees of freedom of the distribution 5608@{n2}: the second number of degrees of freedom of the distribution 5609@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5610@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5611@DESCRIPTION=This function returns the cumulative distribution function of the F distribution. 5612@SEEALSO=R.DF,R.QF 5613 5614@CATEGORY=Statistics 5615@FUNCTION=R.PGAMMA 5616@SHORTDESC=cumulative distribution function of the gamma distribution 5617@SYNTAX=R.PGAMMA(x,shape,scale,lower_tail,log_p) 5618@ARGUMENTDESCRIPTION=@{x}: observation 5619@{shape}: the shape parameter of the distribution 5620@{scale}: the scale parameter of the distribution 5621@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5622@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5623@DESCRIPTION=This function returns the cumulative distribution function of the gamma distribution. 5624@SEEALSO=R.DGAMMA,R.QGAMMA 5625 5626@CATEGORY=Statistics 5627@FUNCTION=R.PGEOM 5628@SHORTDESC=cumulative distribution function of the geometric distribution 5629@SYNTAX=R.PGEOM(x,psuc,lower_tail,log_p) 5630@ARGUMENTDESCRIPTION=@{x}: observation 5631@{psuc}: the probability of success in each trial 5632@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5633@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5634@DESCRIPTION=This function returns the cumulative distribution function of the geometric distribution. 5635@SEEALSO=R.DGEOM,R.QGEOM 5636 5637@CATEGORY=Statistics 5638@FUNCTION=R.PGUMBEL 5639@SHORTDESC=cumulative distribution function of the Gumbel distribution 5640@SYNTAX=R.PGUMBEL(x,mu,beta,lower_tail,log_p) 5641@ARGUMENTDESCRIPTION=@{x}: observation 5642@{mu}: the location parameter of freedom of the distribution 5643@{beta}: the scale parameter of freedom of the distribution 5644@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5645@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5646@DESCRIPTION=This function returns the cumulative distribution function of the Gumbel distribution. 5647@SEEALSO=R.DGUMBEL,R.QGUMBEL 5648 5649@CATEGORY=Statistics 5650@FUNCTION=R.PHYPER 5651@SHORTDESC=cumulative distribution function of the hypergeometric distribution 5652@SYNTAX=R.PHYPER(x,r,b,n,lower_tail,log_p) 5653@ARGUMENTDESCRIPTION=@{x}: observation 5654@{r}: the number of red balls 5655@{b}: the number of black balls 5656@{n}: the number of balls drawn 5657@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5658@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5659@DESCRIPTION=This function returns the cumulative distribution function of the hypergeometric distribution. 5660@SEEALSO=R.DHYPER,R.QHYPER 5661 5662@CATEGORY=Statistics 5663@FUNCTION=R.PLNORM 5664@SHORTDESC=cumulative distribution function of the log-normal distribution 5665@SYNTAX=R.PLNORM(x,logmean,logsd,lower_tail,log_p) 5666@ARGUMENTDESCRIPTION=@{x}: observation 5667@{logmean}: mean of the underlying normal distribution 5668@{logsd}: standard deviation of the underlying normal distribution 5669@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5670@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5671@DESCRIPTION=This function returns the cumulative distribution function of the log-normal distribution. 5672@SEEALSO=R.DLNORM,R.QLNORM 5673 5674@CATEGORY=Statistics 5675@FUNCTION=R.PNBINOM 5676@SHORTDESC=cumulative distribution function of the negative binomial distribution 5677@SYNTAX=R.PNBINOM(x,n,psuc,lower_tail,log_p) 5678@ARGUMENTDESCRIPTION=@{x}: observation (number of failures) 5679@{n}: required number of successes 5680@{psuc}: the probability of success in each trial 5681@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5682@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5683@DESCRIPTION=This function returns the cumulative distribution function of the negative binomial distribution. 5684@SEEALSO=R.DNBINOM,R.QNBINOM 5685 5686@CATEGORY=Statistics 5687@FUNCTION=R.PNORM 5688@SHORTDESC=cumulative distribution function of the normal distribution 5689@SYNTAX=R.PNORM(x,mu,sigma,lower_tail,log_p) 5690@ARGUMENTDESCRIPTION=@{x}: observation 5691@{mu}: mean of the distribution 5692@{sigma}: standard deviation of the distribution 5693@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5694@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5695@DESCRIPTION=This function returns the cumulative distribution function of the normal distribution. 5696@SEEALSO=R.DNORM,R.QNORM 5697 5698@CATEGORY=Statistics 5699@FUNCTION=R.PPOIS 5700@SHORTDESC=cumulative distribution function of the Poisson distribution 5701@SYNTAX=R.PPOIS(x,lambda,lower_tail,log_p) 5702@ARGUMENTDESCRIPTION=@{x}: observation 5703@{lambda}: the mean of the distribution 5704@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5705@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5706@DESCRIPTION=This function returns the cumulative distribution function of the Poisson distribution. 5707@SEEALSO=R.DPOIS,R.QPOIS 5708 5709@CATEGORY=Statistics 5710@FUNCTION=R.PRAYLEIGH 5711@SHORTDESC=cumulative distribution function of the Rayleigh distribution 5712@SYNTAX=R.PRAYLEIGH(x,scale,lower_tail,log_p) 5713@ARGUMENTDESCRIPTION=@{x}: observation 5714@{scale}: the scale parameter of the distribution 5715@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5716@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5717@DESCRIPTION=This function returns the cumulative distribution function of the Rayleigh distribution. 5718@SEEALSO=R.DRAYLEIGH,R.QRAYLEIGH 5719 5720@CATEGORY=Statistics 5721@FUNCTION=R.PSNORM 5722@SHORTDESC=cumulative distribution function of the skew-normal distribution 5723@SYNTAX=R.PSNORM(x,shape,location,scale,lower_tail,log_p) 5724@ARGUMENTDESCRIPTION=@{x}: observation 5725@{shape}: the shape parameter of the distribution 5726@{location}: the location parameter of the distribution 5727@{scale}: the scale parameter of the distribution 5728@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5729@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5730@DESCRIPTION=This function returns the cumulative distribution function of the skew-normal distribution. 5731@SEEALSO=R.DSNORM,R.QSNORM 5732 5733@CATEGORY=Statistics 5734@FUNCTION=R.PST 5735@SHORTDESC=cumulative distribution function of the skew-t distribution 5736@SYNTAX=R.PST(x,n,shape,lower_tail,log_p) 5737@ARGUMENTDESCRIPTION=@{x}: observation 5738@{n}: the number of degrees of freedom of the distribution 5739@{shape}: the shape parameter of the distribution 5740@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5741@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5742@DESCRIPTION=This function returns the cumulative distribution function of the skew-t distribution. 5743@SEEALSO=R.DST,R.QST 5744 5745@CATEGORY=Statistics 5746@FUNCTION=R.PT 5747@SHORTDESC=cumulative distribution function of the Student t distribution 5748@SYNTAX=R.PT(x,n,lower_tail,log_p) 5749@ARGUMENTDESCRIPTION=@{x}: observation 5750@{n}: the number of degrees of freedom of the distribution 5751@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5752@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5753@DESCRIPTION=This function returns the cumulative distribution function of the Student t distribution. 5754@SEEALSO=R.DT,R.QT 5755 5756@CATEGORY=Statistics 5757@FUNCTION=R.PTUKEY 5758@SHORTDESC=cumulative distribution function of the Studentized range distribution 5759@SYNTAX=R.PTUKEY(x,nmeans,df,nranges,lower_tail,log_p) 5760@ARGUMENTDESCRIPTION=@{x}: observation 5761@{nmeans}: the number of means 5762@{df}: the number of degrees of freedom of the distribution 5763@{nranges}: the number of ranges; default is 1 5764@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5765@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5766@DESCRIPTION=This function returns the cumulative distribution function of the Studentized range distribution. 5767@SEEALSO=R.QTUKEY 5768 5769@CATEGORY=Statistics 5770@FUNCTION=R.PWEIBULL 5771@SHORTDESC=cumulative distribution function of the Weibull distribution 5772@SYNTAX=R.PWEIBULL(x,shape,scale,lower_tail,log_p) 5773@ARGUMENTDESCRIPTION=@{x}: observation 5774@{shape}: the shape parameter of the distribution 5775@{scale}: the scale parameter of the distribution 5776@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5777@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5778@DESCRIPTION=This function returns the cumulative distribution function of the Weibull distribution. 5779@SEEALSO=R.DWEIBULL,R.QWEIBULL 5780 5781@CATEGORY=Statistics 5782@FUNCTION=R.QBETA 5783@SHORTDESC=probability quantile function of the beta distribution 5784@SYNTAX=R.QBETA(p,a,b,lower_tail,log_p) 5785@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5786@{a}: the first shape parameter of the distribution 5787@{b}: the second scale parameter of the distribution 5788@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5789@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5790@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the beta distribution. 5791@SEEALSO=R.DBETA,R.PBETA 5792 5793@CATEGORY=Statistics 5794@FUNCTION=R.QBINOM 5795@SHORTDESC=probability quantile function of the binomial distribution 5796@SYNTAX=R.QBINOM(p,n,psuc,lower_tail,log_p) 5797@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5798@{n}: the number of trials 5799@{psuc}: the probability of success in each trial 5800@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5801@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5802@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the binomial distribution. 5803@SEEALSO=R.DBINOM,R.PBINOM 5804 5805@CATEGORY=Statistics 5806@FUNCTION=R.QCAUCHY 5807@SHORTDESC=probability quantile function of the Cauchy distribution 5808@SYNTAX=R.QCAUCHY(p,location,scale,lower_tail,log_p) 5809@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5810@{location}: the center of the distribution 5811@{scale}: the scale parameter of the distribution 5812@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5813@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5814@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Cauchy distribution. 5815@SEEALSO=R.DCAUCHY,R.PCAUCHY 5816 5817@CATEGORY=Statistics 5818@FUNCTION=R.QCHISQ 5819@SHORTDESC=probability quantile function of the chi-square distribution 5820@SYNTAX=R.QCHISQ(p,df,lower_tail,log_p) 5821@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5822@{df}: the number of degrees of freedom of the distribution 5823@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5824@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5825@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the chi-square distribution. 5826@ODF=A two argument invocation R.QCHISQ(@{p},@{df}) is exported to OpenFormula as CHISQINV(@{p},@{df}). 5827@SEEALSO=R.DCHISQ,R.PCHISQ 5828 5829@CATEGORY=Statistics 5830@FUNCTION=R.QEXP 5831@SHORTDESC=probability quantile function of the exponential distribution 5832@SYNTAX=R.QEXP(p,scale,lower_tail,log_p) 5833@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5834@{scale}: the scale parameter of the distribution 5835@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5836@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5837@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the exponential distribution. 5838@SEEALSO=R.DEXP,R.PEXP 5839 5840@CATEGORY=Statistics 5841@FUNCTION=R.QF 5842@SHORTDESC=probability quantile function of the F distribution 5843@SYNTAX=R.QF(p,n1,n2,lower_tail,log_p) 5844@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5845@{n1}: the first number of degrees of freedom of the distribution 5846@{n2}: the second number of degrees of freedom of the distribution 5847@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5848@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5849@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the F distribution. 5850@SEEALSO=R.DF,R.PF 5851 5852@CATEGORY=Statistics 5853@FUNCTION=R.QGAMMA 5854@SHORTDESC=probability quantile function of the gamma distribution 5855@SYNTAX=R.QGAMMA(p,shape,scale,lower_tail,log_p) 5856@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5857@{shape}: the shape parameter of the distribution 5858@{scale}: the scale parameter of the distribution 5859@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5860@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5861@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the gamma distribution. 5862@SEEALSO=R.DGAMMA,R.PGAMMA 5863 5864@CATEGORY=Statistics 5865@FUNCTION=R.QGEOM 5866@SHORTDESC=probability quantile function of the geometric distribution 5867@SYNTAX=R.QGEOM(p,psuc,lower_tail,log_p) 5868@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5869@{psuc}: the probability of success in each trial 5870@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5871@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5872@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the geometric distribution. 5873@SEEALSO=R.DGEOM,R.PGEOM 5874 5875@CATEGORY=Statistics 5876@FUNCTION=R.QGUMBEL 5877@SHORTDESC=probability quantile function of the Gumbel distribution 5878@SYNTAX=R.QGUMBEL(p,mu,beta,lower_tail,log_p) 5879@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5880@{mu}: the location parameter of freedom of the distribution 5881@{beta}: the scale parameter of freedom of the distribution 5882@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5883@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5884@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Gumbel distribution. 5885@SEEALSO=R.DGUMBEL,R.PGUMBEL 5886 5887@CATEGORY=Statistics 5888@FUNCTION=R.QHYPER 5889@SHORTDESC=probability quantile function of the hypergeometric distribution 5890@SYNTAX=R.QHYPER(p,r,b,n,lower_tail,log_p) 5891@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5892@{r}: the number of red balls 5893@{b}: the number of black balls 5894@{n}: the number of balls drawn 5895@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5896@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5897@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the hypergeometric distribution. 5898@SEEALSO=R.DHYPER,R.PHYPER 5899 5900@CATEGORY=Statistics 5901@FUNCTION=R.QLNORM 5902@SHORTDESC=probability quantile function of the log-normal distribution 5903@SYNTAX=R.QLNORM(p,logmean,logsd,lower_tail,log_p) 5904@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5905@{logmean}: mean of the underlying normal distribution 5906@{logsd}: standard deviation of the underlying normal distribution 5907@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5908@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5909@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the log-normal distribution. 5910@SEEALSO=R.DLNORM,R.PLNORM 5911 5912@CATEGORY=Statistics 5913@FUNCTION=R.QNBINOM 5914@SHORTDESC=probability quantile function of the negative binomial distribution 5915@SYNTAX=R.QNBINOM(p,n,psuc,lower_tail,log_p) 5916@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5917@{n}: required number of successes 5918@{psuc}: the probability of success in each trial 5919@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5920@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5921@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the negative binomial distribution. 5922@SEEALSO=R.DNBINOM,R.PNBINOM 5923 5924@CATEGORY=Statistics 5925@FUNCTION=R.QNORM 5926@SHORTDESC=probability quantile function of the normal distribution 5927@SYNTAX=R.QNORM(p,mu,sigma,lower_tail,log_p) 5928@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5929@{mu}: mean of the distribution 5930@{sigma}: standard deviation of the distribution 5931@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5932@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5933@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the normal distribution. 5934@SEEALSO=R.DNORM,R.PNORM 5935 5936@CATEGORY=Statistics 5937@FUNCTION=R.QPOIS 5938@SHORTDESC=probability quantile function of the Poisson distribution 5939@SYNTAX=R.QPOIS(p,lambda,lower_tail,log_p) 5940@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5941@{lambda}: the mean of the distribution 5942@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5943@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5944@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Poisson distribution. 5945@SEEALSO=R.DPOIS,R.PPOIS 5946 5947@CATEGORY=Statistics 5948@FUNCTION=R.QRAYLEIGH 5949@SHORTDESC=probability quantile function of the Rayleigh distribution 5950@SYNTAX=R.QRAYLEIGH(p,scale,lower_tail,log_p) 5951@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5952@{scale}: the scale parameter of the distribution 5953@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5954@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5955@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Rayleigh distribution. 5956@SEEALSO=R.DRAYLEIGH,R.PRAYLEIGH 5957 5958@CATEGORY=Statistics 5959@FUNCTION=R.QSNORM 5960@SHORTDESC=probability quantile function of the skew-normal distribution 5961@SYNTAX=R.QSNORM(p,shape,location,scale,lower_tail,log_p) 5962@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5963@{shape}: the shape parameter of the distribution 5964@{location}: the location parameter of the distribution 5965@{scale}: the scale parameter of the distribution 5966@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5967@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5968@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the skew-normal distribution. 5969@SEEALSO=R.DSNORM,R.PSNORM 5970 5971@CATEGORY=Statistics 5972@FUNCTION=R.QST 5973@SHORTDESC=probability quantile function of the skew-t distribution 5974@SYNTAX=R.QST(p,n,shape,lower_tail,log_p) 5975@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5976@{n}: the number of degrees of freedom of the distribution 5977@{shape}: the shape parameter of the distribution 5978@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5979@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5980@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the skew-t distribution. 5981@SEEALSO=R.DST,R.PST 5982 5983@CATEGORY=Statistics 5984@FUNCTION=R.QT 5985@SHORTDESC=probability quantile function of the Student t distribution 5986@SYNTAX=R.QT(p,n,lower_tail,log_p) 5987@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5988@{n}: the number of degrees of freedom of the distribution 5989@{lower_tail}: if true (the default), the lower tail of the distribution is considered 5990@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 5991@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Student t distribution. 5992@SEEALSO=R.DT,R.PT 5993 5994@CATEGORY=Statistics 5995@FUNCTION=R.QTUKEY 5996@SHORTDESC=probability quantile function of the Studentized range distribution 5997@SYNTAX=R.QTUKEY(p,nmeans,df,nranges,lower_tail,log_p) 5998@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 5999@{nmeans}: the number of means 6000@{df}: the number of degrees of freedom of the distribution 6001@{nranges}: the number of ranges; default is 1 6002@{lower_tail}: if true (the default), the lower tail of the distribution is considered 6003@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 6004@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Studentized range distribution. 6005@SEEALSO=R.PTUKEY 6006 6007@CATEGORY=Statistics 6008@FUNCTION=R.QWEIBULL 6009@SHORTDESC=probability quantile function of the Weibull distribution 6010@SYNTAX=R.QWEIBULL(p,shape,scale,lower_tail,log_p) 6011@ARGUMENTDESCRIPTION=@{p}: probability or natural logarithm of the probability 6012@{shape}: the shape parameter of the distribution 6013@{scale}: the scale parameter of the distribution 6014@{lower_tail}: if true (the default), the lower tail of the distribution is considered 6015@{log_p}: if true, the natural logarithm of the probability is given or returned; defaults to false 6016@DESCRIPTION=This function returns the probability quantile function, i.e., the inverse of the cumulative distribution function, of the Weibull distribution. 6017@SEEALSO=R.DWEIBULL,R.PWEIBULL 6018 6019@CATEGORY=Statistics 6020@FUNCTION=RANK 6021@SHORTDESC=rank of a number in a list of numbers 6022@SYNTAX=RANK(x,ref,order) 6023@ARGUMENTDESCRIPTION=@{x}: number whose rank you want to find 6024@{ref}: list of numbers 6025@{order}: 0 (descending order) or non-zero (ascending order); defaults to 0 6026@NOTE=In case of a tie, RANK returns the largest possible rank. 6027@EXCEL=This function is Excel compatible. 6028@SEEALSO=PERCENTRANK,RANK.AVG 6029 6030@CATEGORY=Statistics 6031@FUNCTION=RANK.AVG 6032@SHORTDESC=rank of a number in a list of numbers 6033@SYNTAX=RANK.AVG(x,ref,order) 6034@ARGUMENTDESCRIPTION=@{x}: number whose rank you want to find 6035@{ref}: list of numbers 6036@{order}: 0 (descending order) or non-zero (ascending order); defaults to 0 6037@NOTE=In case of a tie, RANK.AVG returns the average rank. 6038@EXCEL=This function is Excel 2010 compatible. 6039@SEEALSO=PERCENTRANK,RANK 6040 6041@CATEGORY=Statistics 6042@FUNCTION=RAYLEIGH 6043@SHORTDESC=probability density function of the Rayleigh distribution 6044@SYNTAX=RAYLEIGH(x,sigma) 6045@ARGUMENTDESCRIPTION=@{x}: number 6046@{sigma}: scale parameter 6047@SEEALSO=RANDRAYLEIGH 6048 6049@CATEGORY=Statistics 6050@FUNCTION=RAYLEIGHTAIL 6051@SHORTDESC=probability density function of the Rayleigh tail distribution 6052@SYNTAX=RAYLEIGHTAIL(x,a,sigma) 6053@ARGUMENTDESCRIPTION=@{x}: number 6054@{a}: lower limit 6055@{sigma}: scale parameter 6056@SEEALSO=RANDRAYLEIGHTAIL 6057 6058@CATEGORY=Statistics 6059@FUNCTION=RSQ 6060@SHORTDESC=square of the Pearson correlation coefficient of the paired set of data 6061@SYNTAX=RSQ(array1,array2) 6062@ARGUMENTDESCRIPTION=@{array1}: first component values 6063@{array2}: second component values 6064@DESCRIPTION=Strings and empty cells are simply ignored. 6065@EXCEL=This function is Excel compatible. 6066@SEEALSO=CORREL,COVAR,INTERCEPT,LINEST,LOGEST,PEARSON,SLOPE,STEYX,TREND 6067 6068@CATEGORY=Statistics 6069@FUNCTION=SFTEST 6070@SHORTDESC=Shapiro-Francia Test of Normality 6071@SYNTAX=SFTEST(x) 6072@ARGUMENTDESCRIPTION=@{x}: array of sample values 6073@DESCRIPTION=This function returns an array with the first row giving the p-value of the Shapiro-Francia Test, the second row the test statistic of the test, and the third the number of observations in the sample. 6074@NOTE=If there are less than 5 or more than 5000 sample values, SFTEST returns #VALUE! 6075@SEEALSO=CHITEST,ADTEST,LKSTEST,CVMTEST 6076 6077@CATEGORY=Statistics 6078@FUNCTION=SKEW 6079@SHORTDESC=unbiased estimate for skewness of a distribution 6080@SYNTAX=SKEW(number1,number2,…) 6081@ARGUMENTDESCRIPTION=@{number1}: first value 6082@{number2}: second value 6083@DESCRIPTION=Strings and empty cells are simply ignored. 6084@NOTE=This is only meaningful if the underlying distribution really has a third moment. The skewness of a symmetric (e.g., normal) distribution is zero. If less than three numbers are given, this function returns a #DIV/0! error. 6085@EXCEL=This function is Excel compatible. 6086@SEEALSO=AVERAGE,VAR,SKEWP,KURT 6087 6088@CATEGORY=Statistics 6089@FUNCTION=SKEWP 6090@SHORTDESC=population skewness of a data set 6091@SYNTAX=SKEWP(number1,number2,…) 6092@ARGUMENTDESCRIPTION=@{number1}: first value 6093@{number2}: second value 6094@DESCRIPTION=Strings and empty cells are simply ignored. 6095@NOTE=If less than two numbers are given, SKEWP returns a #DIV/0! error. 6096@SEEALSO=AVERAGE,VARP,SKEW,KURTP 6097 6098@CATEGORY=Statistics 6099@FUNCTION=SLOPE 6100@SHORTDESC=the slope of a linear regression line 6101@SYNTAX=SLOPE(known_ys,known_xs) 6102@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 6103@{known_xs}: known x-values 6104@NOTE=If @{known_xs} or @{known_ys} contains no data entries or different number of data entries, this function returns a #N/A error. If the variance of the @{known_xs} is zero, this function returns #DIV/0 error. 6105@EXCEL=This function is Excel compatible. 6106@SEEALSO=STDEV,STDEVPA 6107 6108@CATEGORY=Statistics 6109@FUNCTION=SMALL 6110@SHORTDESC=@{k}-th smallest value in a data set 6111@SYNTAX=SMALL(data,k) 6112@ARGUMENTDESCRIPTION=@{data}: data set 6113@{k}: which value to find 6114@NOTE=If data set is empty this function returns a #NUM! error. If @{k} <= 0 or @{k} is greater than the number of data items given this function returns a #NUM! error. 6115@EXCEL=This function is Excel compatible. 6116@SEEALSO=PERCENTILE,PERCENTRANK,QUARTILE,LARGE 6117 6118@CATEGORY=Statistics 6119@FUNCTION=SNORM.DIST.RANGE 6120@SHORTDESC=probability of the standard normal distribution over an interval 6121@SYNTAX=SNORM.DIST.RANGE(x1,x2) 6122@ARGUMENTDESCRIPTION=@{x1}: start of the interval 6123@{x2}: end of the interval 6124@DESCRIPTION=This function returns the cumulative probability over a range of the standard normal distribution; that is the integral over the probability density function from @{x1} to @{x2}. 6125@NOTE=If @{x1}>@{x2}, this function returns a negative value. 6126@SEEALSO=NORMSDIST,R.PNORM,R.QNORM,R.DNORM 6127 6128@CATEGORY=Statistics 6129@FUNCTION=SSMEDIAN 6130@SHORTDESC=median for grouped data 6131@SYNTAX=SSMEDIAN(array,interval) 6132@ARGUMENTDESCRIPTION=@{array}: data set 6133@{interval}: length of each grouping interval, defaults to 1 6134@DESCRIPTION=The data are assumed to be grouped into intervals of width @{interval}. Each data point in @{array} is the midpoint of the interval containing the true value. The median is calculated by interpolation within the median interval (the interval containing the median value), assuming that the true values within that interval are distributed uniformly: 6135median = L + @{interval}*(N/2 - CF)/F 6136where: 6137L = the lower limit of the median interval 6138N = the total number of data points 6139CF = the number of data points below the median interval 6140F = the number of data points in the median interval 6141@NOTE=If @{array} is empty, this function returns a #NUM! error. If @{interval} <= 0, this function returns a #NUM! error. SSMEDIAN does not check whether the data points are at least @{interval} apart. 6142@SEEALSO=MEDIAN 6143 6144@CATEGORY=Statistics 6145@FUNCTION=STANDARDIZE 6146@SHORTDESC=z-score of a value 6147@SYNTAX=STANDARDIZE(x,mean,stddev) 6148@ARGUMENTDESCRIPTION=@{x}: value 6149@{mean}: mean of the original distribution 6150@{stddev}: standard deviation of the original distribution 6151@NOTE=If @{stddev} is 0 this function returns a #DIV/0! error. 6152@EXCEL=This function is Excel compatible. 6153@SEEALSO=AVERAGE 6154 6155@CATEGORY=Statistics 6156@FUNCTION=STDEV 6157@SHORTDESC=sample standard deviation of the given sample 6158@SYNTAX=STDEV(area1,area2,…) 6159@ARGUMENTDESCRIPTION=@{area1}: first cell area 6160@{area2}: second cell area 6161@DESCRIPTION=STDEV is also known as the N-1-standard deviation. 6162To obtain the population standard deviation of a whole population use STDEVP. 6163@EXCEL=This function is Excel compatible. 6164@SEEALSO=AVERAGE,DSTDEV,DSTDEVP,STDEVA,STDEVPA,VAR 6165 6166@CATEGORY=Statistics 6167@FUNCTION=STDEVA 6168@SHORTDESC=sample standard deviation of the given sample 6169@SYNTAX=STDEVA(area1,area2,…) 6170@ARGUMENTDESCRIPTION=@{area1}: first cell area 6171@{area2}: second cell area 6172@DESCRIPTION=STDEVA is also known as the N-1-standard deviation. 6173To obtain the population standard deviation of a whole population use STDEVPA. 6174Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 6175@EXCEL=This function is Excel compatible. 6176@SEEALSO=STDEV,STDEVPA 6177 6178@CATEGORY=Statistics 6179@FUNCTION=STDEVP 6180@SHORTDESC=population standard deviation of the given population 6181@SYNTAX=STDEVP(area1,area2,…) 6182@ARGUMENTDESCRIPTION=@{area1}: first cell area 6183@{area2}: second cell area 6184@DESCRIPTION=This is also known as the N-standard deviation 6185@EXCEL=This function is Excel compatible. 6186@SEEALSO=STDEV,STDEVA,STDEVPA 6187 6188@CATEGORY=Statistics 6189@FUNCTION=STDEVPA 6190@SHORTDESC=population standard deviation of an entire population 6191@SYNTAX=STDEVPA(area1,area2,…) 6192@ARGUMENTDESCRIPTION=@{area1}: first cell area 6193@{area2}: second cell area 6194@DESCRIPTION=This is also known as the N-standard deviation 6195Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 6196@EXCEL=This function is Excel compatible. 6197@SEEALSO=STDEVA,STDEVP 6198 6199@CATEGORY=Statistics 6200@FUNCTION=STEYX 6201@SHORTDESC=standard error of the predicted y-value in the regression 6202@SYNTAX=STEYX(known_ys,known_xs) 6203@ARGUMENTDESCRIPTION=@{known_ys}: known y-values 6204@{known_xs}: known x-values 6205@NOTE=If @{known_ys} and @{known_xs} are empty or have a different number of arguments then this function returns a #N/A error. 6206@EXCEL=This function is Excel compatible. 6207@SEEALSO=PEARSON,RSQ,SLOPE 6208 6209@CATEGORY=Statistics 6210@FUNCTION=SUBTOTAL 6211@SHORTDESC=the subtotal of the given list of arguments 6212@SYNTAX=SUBTOTAL(function_nbr,ref1,ref2,…) 6213@ARGUMENTDESCRIPTION=@{function_nbr}: determines which function to use according to the following table: 6214 1 AVERAGE 6215 2 COUNT 6216 3 COUNTA 6217 4 MAX 6218 5 MIN 6219 6 PRODUCT 6220 7 STDEV 6221 8 STDEVP 6222 9 SUM 6223 10 VAR 6224 11 VARP 6225@{ref1}: first value 6226@{ref2}: second value 6227@EXCEL=This function is Excel compatible. 6228@SEEALSO=COUNT,SUM 6229 6230@CATEGORY=Statistics 6231@FUNCTION=TDIST 6232@SHORTDESC=survival function of the Student t-distribution 6233@SYNTAX=TDIST(x,dof,tails) 6234@ARGUMENTDESCRIPTION=@{x}: number 6235@{dof}: number of degrees of freedom 6236@{tails}: 1 or 2 6237@DESCRIPTION=The survival function is 1 minus the cumulative distribution function. 6238This function is Excel compatible for non-negative @{x}. 6239@NOTE=If @{dof} < 1 this function returns a #NUM! error. If @{tails} is neither 1 or 2 this function returns a #NUM! error. The parameterization of this function is different from what is used for, e.g., NORMSDIST. This is a common source of mistakes, but necessary for compatibility. 6240@SEEALSO=TINV,TTEST 6241 6242@CATEGORY=Statistics 6243@FUNCTION=TINV 6244@SHORTDESC=two tailed inverse of the Student t-distribution 6245@SYNTAX=TINV(p,dof) 6246@ARGUMENTDESCRIPTION=@{p}: probability in both tails 6247@{dof}: number of degrees of freedom 6248@DESCRIPTION=This function returns the non-negative value x such that the area under the Student t density with @{dof} degrees of freedom to the right of x is @{p}/2. 6249@NOTE=If @{p} < 0 or @{p} > 1 or @{dof} < 1 this function returns a #NUM! error. The parameterization of this function is different from what is used for, e.g., NORMSINV. This is a common source of mistakes, but necessary for compatibility. 6250@EXCEL=This function is Excel compatible. 6251@SEEALSO=TDIST,TTEST 6252 6253@CATEGORY=Statistics 6254@FUNCTION=TREND 6255@SHORTDESC=estimates future values of a given data set using a least squares approximation 6256@SYNTAX=TREND(known_ys,known_xs,new_xs,affine) 6257@ARGUMENTDESCRIPTION=@{known_ys}: vector of values of dependent variable 6258@{known_xs}: array of values of independent variables, defaults to a single vector {1,…,n} 6259@{new_xs}: array of x-values for which to estimate the y-values; defaults to @{known_xs} 6260@{affine}: if true, the model contains a constant term, defaults to true 6261@NOTE=If the length of @{known_ys} does not match the corresponding length of @{known_xs}, this function returns a #NUM! error. 6262@SEEALSO=LINEST 6263 6264@CATEGORY=Statistics 6265@FUNCTION=TRIMMEAN 6266@SHORTDESC=mean of the interior of a data set 6267@SYNTAX=TRIMMEAN(ref,fraction) 6268@ARGUMENTDESCRIPTION=@{ref}: list of numbers whose mean you want to calculate 6269@{fraction}: fraction of the data set excluded from the mean 6270@DESCRIPTION=If @{fraction}=0.2 and the data set contains 40 numbers, 8 numbers are trimmed from the data set (40 x 0.2): the 4 largest and the 4 smallest. To avoid a bias, the number of points to be excluded is always rounded down to the nearest even number. 6271@EXCEL=This function is Excel compatible. 6272@SEEALSO=AVERAGE,GEOMEAN,HARMEAN,MEDIAN,MODE 6273 6274@CATEGORY=Statistics 6275@FUNCTION=TTEST 6276@SHORTDESC=p-value for a hypothesis test comparing the means of two populations using the Student t-distribution 6277@SYNTAX=TTEST(array1,array2,tails,type) 6278@ARGUMENTDESCRIPTION=@{array1}: sample from the first population 6279@{array2}: sample from the second population 6280@{tails}: number of tails to consider 6281@{type}: Type of test to perform. 1 indicates a test for paired variables, 2 a test of unpaired variables with equal variances, and 3 a test of unpaired variables with unequal variances 6282@NOTE=If the data sets contain a different number of data points and the test is paired (@{type} one), TTEST returns the #N/A error. @{tails} and @{type} are truncated to integers. If @{tails} is not one or two, this function returns a #NUM! error. If @{type} is any other than one, two, or three, this function returns a #NUM! error. 6283@EXCEL=This function is Excel compatible. 6284@SEEALSO=FDIST,FINV 6285 6286@CATEGORY=Statistics 6287@FUNCTION=VAR 6288@SHORTDESC=sample variance of the given sample 6289@SYNTAX=VAR(area1,area2,…) 6290@ARGUMENTDESCRIPTION=@{area1}: first cell area 6291@{area2}: second cell area 6292@DESCRIPTION=VAR is also known as the N-1-variance. 6293@NOTE=Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn. 6294@EXCEL=This function is Excel compatible. 6295@SEEALSO=VARP,STDEV,VARA 6296 6297@CATEGORY=Statistics 6298@FUNCTION=VARA 6299@SHORTDESC=sample variance of the given sample 6300@SYNTAX=VARA(area1,area2,…) 6301@ARGUMENTDESCRIPTION=@{area1}: first cell area 6302@{area2}: second cell area 6303@DESCRIPTION=VARA is also known as the N-1-variance. 6304To get the true variance of a complete population use VARPA. 6305Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 6306@NOTE=Since the N-1-variance includes Bessel's correction, whereas the N-variance calculated by VARPA or VARP does not, under reasonable conditions the N-1-variance is an unbiased estimator of the variance of the population from which the sample is drawn. 6307@EXCEL=This function is Excel compatible. 6308@SEEALSO=VAR,VARPA 6309 6310@CATEGORY=Statistics 6311@FUNCTION=VARP 6312@SHORTDESC=variance of an entire population 6313@SYNTAX=VARP(area1,area2,…) 6314@ARGUMENTDESCRIPTION=@{area1}: first cell area 6315@{area2}: second cell area 6316@DESCRIPTION=VARP is also known as the N-variance. 6317@SEEALSO=AVERAGE,DVAR,DVARP,STDEV,VAR 6318 6319@CATEGORY=Statistics 6320@FUNCTION=VARPA 6321@SHORTDESC=variance of an entire population 6322@SYNTAX=VARPA(area1,area2,…) 6323@ARGUMENTDESCRIPTION=@{area1}: first cell area 6324@{area2}: second cell area 6325@DESCRIPTION=VARPA is also known as the N-variance. 6326Numbers, text and logical values are included in the calculation too. If the cell contains text or the argument evaluates to FALSE, it is counted as value zero (0). If the argument evaluates to TRUE, it is counted as one (1). Note that empty cells are not counted. 6327@EXCEL=This function is Excel compatible. 6328@SEEALSO=VARA,VARP 6329 6330@CATEGORY=Statistics 6331@FUNCTION=WEIBULL 6332@SHORTDESC=probability density or cumulative distribution function of the Weibull distribution 6333@SYNTAX=WEIBULL(x,alpha,beta,cumulative) 6334@ARGUMENTDESCRIPTION=@{x}: number 6335@{alpha}: scale parameter 6336@{beta}: scale parameter 6337@{cumulative}: whether to evaluate the density function or the cumulative distribution function 6338@DESCRIPTION=If the @{cumulative} boolean is true it will return: 1 - exp (-(@{x}/@{beta})^@{alpha}), otherwise it will return (@{alpha}/@{beta}^@{alpha}) * @{x}^(@{alpha}-1) * exp(-(@{x}/@{beta}^@{alpha})). 6339@NOTE=If @{x} < 0 this function returns a #NUM! error. If @{alpha} <= 0 or @{beta} <= 0 this function returns a #NUM! error. 6340@EXCEL=This function is Excel compatible. 6341@SEEALSO=POISSON 6342 6343@CATEGORY=Statistics 6344@FUNCTION=ZTEST 6345@SHORTDESC=the probability of observing a sample mean as large as or larger than the mean of the given sample 6346@SYNTAX=ZTEST(ref,x,stddev) 6347@ARGUMENTDESCRIPTION=@{ref}: data set (sample) 6348@{x}: population mean 6349@{stddev}: population standard deviation, defaults to the sample standard deviation 6350@DESCRIPTION=ZTEST calculates the probability of observing a sample mean as large as or larger than the mean of the given sample for samples drawn from a normal distribution with mean @{x} and standard deviation @{stddev}. 6351@NOTE=If @{ref} contains less than two data items ZTEST returns #DIV/0! error. 6352@EXCEL=This function is Excel compatible. 6353@ODF=This function is OpenFormula compatible. 6354@SEEALSO=CONFIDENCE,NORMDIST,NORMINV,NORMSDIST,NORMSINV,STANDARDIZE 6355 6356@CATEGORY=String 6357@FUNCTION=ASC 6358@SHORTDESC=text with full-width katakana and ASCII characters converted to half-width 6359@SYNTAX=ASC(text) 6360@ARGUMENTDESCRIPTION=@{text}: string 6361@DESCRIPTION=ASC converts full-width katakana and ASCII characters to half-width equivalent characters, copying all others. 6362The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/. 6363@NOTE=While in obsolete encodings ASC used to translate between 2-byte and 1-byte characters, this is not the case in UTF-8. 6364@EXCEL=For most strings, this function has the same effect as in Excel. 6365@ODF=This function is OpenFormula compatible. 6366@SEEALSO=JIS 6367 6368@CATEGORY=String 6369@FUNCTION=CHAR 6370@SHORTDESC=the CP1252 (Windows-1252) character for the code point @{x} 6371@SYNTAX=CHAR(x) 6372@ARGUMENTDESCRIPTION=@{x}: code point 6373@DESCRIPTION=CHAR(@{x}) returns the CP1252 (Windows-1252) character with code @{x}. 6374@{x} must be in the range 1 to 255. 6375CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard. 6376CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters. It also contains all of ISO-8859-15's printable characters (but partially at different positions.) 6377This function is Excel compatible. 6378@NOTE=In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters. For @{x} from 1 to 255 except 129, 141, 143, 144, and 157 we have CODE(CHAR(@{x}))=@{x}. 6379@SEEALSO=CODE 6380 6381@CATEGORY=String 6382@FUNCTION=CLEAN 6383@SHORTDESC=@{text} with any non-printable characters removed 6384@SYNTAX=CLEAN(text) 6385@ARGUMENTDESCRIPTION=@{text}: string 6386@DESCRIPTION=CLEAN removes non-printable characters from its argument leaving only regular characters and white-space. 6387@EXCEL=This function is Excel compatible. 6388 6389@CATEGORY=String 6390@FUNCTION=CODE 6391@SHORTDESC=the CP1252 (Windows-1252) code point for the character @{c} 6392@SYNTAX=CODE(c) 6393@ARGUMENTDESCRIPTION=@{c}: character 6394@DESCRIPTION=@{c} must be a valid CP1252 (Windows-1252) character. 6395CP1252 (Windows-1252) is also known as the "ANSI code page", but it is not an ANSI standard. 6396CP1252 (Windows-1252) is based on an early draft of ISO-8859-1, and contains all of its printable characters (but partially at different positions.) 6397This function is Excel compatible. 6398@NOTE=In CP1252 (Windows-1252), 129, 141, 143, 144, and 157 do not have matching characters. For @{x} from 1 to 255 except 129, 141, 143, 144, and 157 we have CODE(CHAR(@{x}))=@{x}. 6399@SEEALSO=CHAR 6400 6401@CATEGORY=String 6402@FUNCTION=CONCAT 6403@SHORTDESC=the concatenation of the strings @{s1}, @{s2},… 6404@SYNTAX=CONCAT(s1,s2,…) 6405@ARGUMENTDESCRIPTION=@{s1}: first string 6406@{s2}: second string 6407@NOTE=This function is identical to CONCATENATE 6408@EXCEL=This function is Excel compatible. 6409@SEEALSO=LEFT,MID,RIGHT 6410 6411@CATEGORY=String 6412@FUNCTION=CONCATENATE 6413@SHORTDESC=the concatenation of the strings @{s1}, @{s2},… 6414@SYNTAX=CONCATENATE(s1,s2,…) 6415@ARGUMENTDESCRIPTION=@{s1}: first string 6416@{s2}: second string 6417@EXCEL=This function is Excel compatible. 6418@SEEALSO=LEFT,MID,RIGHT 6419 6420@CATEGORY=String 6421@FUNCTION=DOLLAR 6422@SHORTDESC=@{num} formatted as currency 6423@SYNTAX=DOLLAR(num,decimals) 6424@ARGUMENTDESCRIPTION=@{num}: number 6425@{decimals}: decimals 6426@EXCEL=This function is Excel compatible. 6427@SEEALSO=FIXED,TEXT,VALUE 6428 6429@CATEGORY=String 6430@FUNCTION=EXACT 6431@SHORTDESC=TRUE if @{string1} is exactly equal to @{string2} 6432@SYNTAX=EXACT(string1,string2) 6433@ARGUMENTDESCRIPTION=@{string1}: first string 6434@{string2}: second string 6435@EXCEL=This function is Excel compatible. 6436@SEEALSO=LEN,SEARCH,DELTA 6437 6438@CATEGORY=String 6439@FUNCTION=FIND 6440@SHORTDESC=first position of @{string1} in @{string2} following position @{start} 6441@SYNTAX=FIND(string1,string2,start) 6442@ARGUMENTDESCRIPTION=@{string1}: search string 6443@{string2}: search field 6444@{start}: starting position, defaults to 1 6445@NOTE=This search is case-sensitive. 6446@EXCEL=This function is Excel compatible. 6447@SEEALSO=EXACT,LEN,MID,SEARCH 6448 6449@CATEGORY=String 6450@FUNCTION=FINDB 6451@SHORTDESC=first byte position of @{string1} in @{string2} following byte position @{start} 6452@SYNTAX=FINDB(string1,string2,start) 6453@ARGUMENTDESCRIPTION=@{string1}: search string 6454@{string2}: search field 6455@{start}: starting byte position, defaults to 1 6456@NOTE=This search is case-sensitive. 6457@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6458@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6459@SEEALSO=FIND,LEFTB,RIGHTB,LENB,LEFT,MID,RIGHT,LEN 6460 6461@CATEGORY=String 6462@FUNCTION=FIXED 6463@SHORTDESC=formatted string representation of @{num} 6464@SYNTAX=FIXED(num,decimals,no_commas) 6465@ARGUMENTDESCRIPTION=@{num}: number 6466@{decimals}: number of decimals 6467@{no_commas}: TRUE if no thousand separators should be used, defaults to FALSE 6468@EXCEL=This function is Excel compatible. 6469@SEEALSO=TEXT,VALUE,DOLLAR 6470 6471@CATEGORY=String 6472@FUNCTION=JIS 6473@SHORTDESC=text with half-width katakana and ASCII characters converted to full-width 6474@SYNTAX=JIS(text) 6475@ARGUMENTDESCRIPTION=@{text}: original text 6476@DESCRIPTION=JIS converts half-width katakana and ASCII characters to full-width equivalent characters, copying all others. 6477The distinction between half-width and full-width characters is described in http://www.unicode.org/reports/tr11/. 6478@NOTE=While in obsolete encodings JIS used to translate between 1-byte and 2-byte characters, this is not the case in UTF-8. 6479@EXCEL=For most strings, this function has the same effect as in Excel. 6480@ODF=This function is OpenFormula compatible. 6481@SEEALSO=ASC 6482 6483@CATEGORY=String 6484@FUNCTION=LEFT 6485@SHORTDESC=the first @{num_chars} characters of the string @{s} 6486@SYNTAX=LEFT(s,num_chars) 6487@ARGUMENTDESCRIPTION=@{s}: the string 6488@{num_chars}: the number of characters to return (defaults to 1) 6489@NOTE=If the string @{s} is in a right-to-left script, the returned first characters are from the right of the string. 6490@EXCEL=This function is Excel compatible. 6491@ODF=This function is OpenFormula compatible. 6492@SEEALSO=MID,RIGHT,LEN,MIDB,RIGHTB,LENB 6493 6494@CATEGORY=String 6495@FUNCTION=LEFTB 6496@SHORTDESC=the first characters of the string @{s} comprising at most @{num_bytes} bytes 6497@SYNTAX=LEFTB(s,num_bytes) 6498@ARGUMENTDESCRIPTION=@{s}: the string 6499@{num_bytes}: the maximum number of bytes to return (defaults to 1) 6500@NOTE=The semantics of this function is subject to change as various applications implement it. If the string is in a right-to-left script, the returned first characters are from the right of the string. 6501@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6502@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6503@SEEALSO=MIDB,RIGHTB,LENB,LEFT,MID,RIGHT,LEN 6504 6505@CATEGORY=String 6506@FUNCTION=LEN 6507@SHORTDESC=the number of characters of the string @{s} 6508@SYNTAX=LEN(s) 6509@ARGUMENTDESCRIPTION=@{s}: the string 6510@EXCEL=This function is Excel compatible. 6511@SEEALSO=CHAR,CODE,LENB 6512 6513@CATEGORY=String 6514@FUNCTION=LENB 6515@SHORTDESC=the number of bytes in the string @{s} 6516@SYNTAX=LENB(s) 6517@ARGUMENTDESCRIPTION=@{s}: the string 6518@EXCEL=This function is Excel compatible. 6519@SEEALSO=CHAR, CODE, LEN 6520 6521@CATEGORY=String 6522@FUNCTION=LOWER 6523@SHORTDESC=a lower-case version of the string @{text} 6524@SYNTAX=LOWER(text) 6525@ARGUMENTDESCRIPTION=@{text}: string 6526@EXCEL=This function is Excel compatible. 6527@SEEALSO=UPPER 6528 6529@CATEGORY=String 6530@FUNCTION=MID 6531@SHORTDESC=the substring of the string @{s} starting at position @{position} consisting of @{length} characters 6532@SYNTAX=MID(s,position,length) 6533@ARGUMENTDESCRIPTION=@{s}: the string 6534@{position}: the starting position 6535@{length}: the number of characters to return 6536@EXCEL=This function is Excel compatible. 6537@ODF=This function is OpenFormula compatible. 6538@SEEALSO=LEFT,RIGHT,LEN,LEFTB,MIDB,RIGHTB,LENB 6539 6540@CATEGORY=String 6541@FUNCTION=MIDB 6542@SHORTDESC=the characters following the first @{start_pos} bytes comprising at most @{num_bytes} bytes 6543@SYNTAX=MIDB(s,start_pos,num_bytes) 6544@ARGUMENTDESCRIPTION=@{s}: the string 6545@{start_pos}: the number of the byte with which to start (defaults to 1) 6546@{num_bytes}: the maximum number of bytes to return (defaults to 1) 6547@NOTE=The semantics of this function is subject to change as various applications implement it. 6548@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6549@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6550@SEEALSO=LEFTB,RIGHTB,LENB,LEFT,MID,RIGHT,LEN 6551 6552@CATEGORY=String 6553@FUNCTION=NUMBERVALUE 6554@SHORTDESC=numeric value of @{text} 6555@SYNTAX=NUMBERVALUE(text,separator) 6556@ARGUMENTDESCRIPTION=@{text}: string 6557@{separator}: decimal separator 6558@NOTE=If @{text} does not look like a decimal number, NUMBERVALUE returns the value VALUE would return (ignoring the given @{separator}). 6559@ODF=This function is OpenFormula compatible. 6560@SEEALSO=VALUE 6561 6562@CATEGORY=String 6563@FUNCTION=PROPER 6564@SHORTDESC=@{text} with initial of each word capitalised 6565@SYNTAX=PROPER(text) 6566@ARGUMENTDESCRIPTION=@{text}: string 6567@EXCEL=This function is Excel compatible. 6568@SEEALSO=LOWER,UPPER 6569 6570@CATEGORY=String 6571@FUNCTION=REPLACE 6572@SHORTDESC=string @{old} with @{num} characters starting at @{start} replaced by @{new} 6573@SYNTAX=REPLACE(old,start,num,new) 6574@ARGUMENTDESCRIPTION=@{old}: original text 6575@{start}: starting position 6576@{num}: number of characters to be replaced 6577@{new}: replacement string 6578@EXCEL=This function is Excel compatible. 6579@SEEALSO=MID,SEARCH,SUBSTITUTE,TRIM 6580 6581@CATEGORY=String 6582@FUNCTION=REPLACEB 6583@SHORTDESC=string @{old} with up to @{num} bytes starting at @{start} replaced by @{new} 6584@SYNTAX=REPLACEB(old,start,num,new) 6585@ARGUMENTDESCRIPTION=@{old}: original text 6586@{start}: starting byte position 6587@{num}: number of bytes to be replaced 6588@{new}: replacement string 6589@DESCRIPTION=REPLACEB replaces the string of valid unicode characters starting at the byte @{start} and ending at @{start}+@{num}-1 with the string @{new}. 6590@NOTE=The semantics of this function is subject to change as various applications implement it. 6591@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6592@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6593@SEEALSO=MID,SEARCH,SUBSTITUTE,TRIM 6594 6595@CATEGORY=String 6596@FUNCTION=REPT 6597@SHORTDESC=@{num} repetitions of string @{text} 6598@SYNTAX=REPT(text,num) 6599@ARGUMENTDESCRIPTION=@{text}: string 6600@{num}: non-negative integer 6601@EXCEL=This function is Excel compatible. 6602@SEEALSO=CONCATENATE 6603 6604@CATEGORY=String 6605@FUNCTION=RIGHT 6606@SHORTDESC=the last @{num_chars} characters of the string @{s} 6607@SYNTAX=RIGHT(s,num_chars) 6608@ARGUMENTDESCRIPTION=@{s}: the string 6609@{num_chars}: the number of characters to return (defaults to 1) 6610@NOTE=If the string @{s} is in a right-to-left script, the returned last characters are from the left of the string. 6611@EXCEL=This function is Excel compatible. 6612@ODF=This function is OpenFormula compatible. 6613@SEEALSO=LEFT,MID,LEN,LEFTB,MIDB,RIGHTB,LENB 6614 6615@CATEGORY=String 6616@FUNCTION=RIGHTB 6617@SHORTDESC=the last characters of the string @{s} comprising at most @{num_bytes} bytes 6618@SYNTAX=RIGHTB(s,num_bytes) 6619@ARGUMENTDESCRIPTION=@{s}: the string 6620@{num_bytes}: the maximum number of bytes to return (defaults to 1) 6621@NOTE=The semantics of this function is subject to change as various applications implement it. If the string @{s} is in a right-to-left script, the returned last characters are from the left of the string. 6622@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6623@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6624@SEEALSO=LEFTB,MIDB,LENB,LEFT,MID,RIGHT,LEN 6625 6626@CATEGORY=String 6627@FUNCTION=SEARCH 6628@SHORTDESC=the location of the @{search} string within @{text} after position @{start} 6629@SYNTAX=SEARCH(search,text,start) 6630@ARGUMENTDESCRIPTION=@{search}: search string 6631@{text}: search field 6632@{start}: starting position, defaults to 1 6633@DESCRIPTION=@{search} may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~. 6634@NOTE=This search is not case sensitive. If @{search} is not found, SEARCH returns #VALUE! If @{start} is less than one or it is greater than the length of @{text}, SEARCH returns #VALUE! 6635@EXCEL=This function is Excel compatible. 6636@SEEALSO=FIND,SEARCHB 6637 6638@CATEGORY=String 6639@FUNCTION=SEARCHB 6640@SHORTDESC=the location of the @{search} string within @{text} after byte position @{start} 6641@SYNTAX=SEARCHB(search,text,start) 6642@ARGUMENTDESCRIPTION=@{search}: search string 6643@{text}: search field 6644@{start}: starting byte position, defaults to 1 6645@DESCRIPTION=@{search} may contain wildcard characters (*) and question marks (?). A question mark matches any single character, and a wildcard matches any string including the empty string. To search for * or ?, precede the symbol with ~. 6646@NOTE=This search is not case sensitive. If @{search} is not found, SEARCHB returns #VALUE! If @{start} is less than one or it is greater than the byte length of @{text}, SEARCHB returns #VALUE! The semantics of this function is subject to change as various applications implement it. 6647@EXCEL=While this function is syntactically Excel compatible, the differences in the underlying text encoding will usually yield different results. 6648@ODF=While this function is OpenFormula compatible, most of its behavior is, at this time, implementation specific. 6649@SEEALSO=FINDB,SEARCH 6650 6651@CATEGORY=String 6652@FUNCTION=SUBSTITUTE 6653@SHORTDESC=@{text} with all occurrences of @{old} replaced by @{new} 6654@SYNTAX=SUBSTITUTE(text,old,new,num) 6655@ARGUMENTDESCRIPTION=@{text}: original text 6656@{old}: string to be replaced 6657@{new}: replacement string 6658@{num}: if @{num} is specified and a number only the @{num}th occurrence of @{old} is replaced 6659@EXCEL=This function is Excel compatible. 6660@SEEALSO=REPLACE,TRIM 6661 6662@CATEGORY=String 6663@FUNCTION=T 6664@SHORTDESC=@{value} if and only if @{value} is text, otherwise empty 6665@SYNTAX=T(value) 6666@ARGUMENTDESCRIPTION=@{value}: original value 6667@EXCEL=This function is Excel compatible. 6668@SEEALSO=CELL,N,VALUE 6669 6670@CATEGORY=String 6671@FUNCTION=TEXT 6672@SHORTDESC=@{value} as a string formatted as @{format} 6673@SYNTAX=TEXT(value,format) 6674@ARGUMENTDESCRIPTION=@{value}: value to be formatted 6675@{format}: desired format 6676@EXCEL=This function is Excel compatible. 6677@SEEALSO=DOLLAR,FIXED,VALUE 6678 6679@CATEGORY=String 6680@FUNCTION=TEXTJOIN 6681@SHORTDESC=the concatenation of the strings @{s1}, @{s2},… delimited by @{del} 6682@SYNTAX=TEXTJOIN(del,blank,s1,s2,…) 6683@ARGUMENTDESCRIPTION=@{del}: delimiter 6684@{blank}: ignore blanks 6685@{s1}: first string 6686@{s2}: second string 6687@EXCEL=This function is Excel compatible. 6688@SEEALSO=CONCATENATE 6689 6690@CATEGORY=String 6691@FUNCTION=TRIM 6692@SHORTDESC=@{text} with only single spaces between words 6693@SYNTAX=TRIM(text) 6694@ARGUMENTDESCRIPTION=@{text}: string 6695@EXCEL=This function is Excel compatible. 6696@SEEALSO=CLEAN,MID,REPLACE,SUBSTITUTE 6697 6698@CATEGORY=String 6699@FUNCTION=UNICHAR 6700@SHORTDESC=the Unicode character represented by the Unicode code point @{x} 6701@SYNTAX=UNICHAR(x) 6702@ARGUMENTDESCRIPTION=@{x}: Unicode code point 6703@SEEALSO=CHAR,UNICODE,CODE 6704 6705@CATEGORY=String 6706@FUNCTION=UNICODE 6707@SHORTDESC=the Unicode code point for the character @{c} 6708@SYNTAX=UNICODE(c) 6709@ARGUMENTDESCRIPTION=@{c}: character 6710@SEEALSO=UNICHAR,CODE,CHAR 6711 6712@CATEGORY=String 6713@FUNCTION=UPPER 6714@SHORTDESC=an upper-case version of the string @{text} 6715@SYNTAX=UPPER(text) 6716@ARGUMENTDESCRIPTION=@{text}: string 6717@EXCEL=This function is Excel compatible. 6718@SEEALSO=LOWER 6719 6720@CATEGORY=String 6721@FUNCTION=VALUE 6722@SHORTDESC=numeric value of @{text} 6723@SYNTAX=VALUE(text) 6724@ARGUMENTDESCRIPTION=@{text}: string 6725@EXCEL=This function is Excel compatible. 6726@SEEALSO=DOLLAR,FIXED,TEXT 6727 6728@CATEGORY=Time Series Analysis 6729@FUNCTION=FOURIER 6730@SHORTDESC=Fourier or inverse Fourier transform 6731@SYNTAX=FOURIER(Sequence,Inverse,Separate) 6732@ARGUMENTDESCRIPTION=@{Sequence}: the data sequence to be transformed 6733@{Inverse}: if true, the inverse Fourier transform is calculated, defaults to false 6734@{Separate}: if true, the real and imaginary parts are given separately, defaults to false 6735@DESCRIPTION=This array function returns the Fourier or inverse Fourier transform of the given data sequence. 6736The output consists of one column of complex numbers if @{Separate} is false and of two columns of real numbers if @{Separate} is true. 6737If @{Separate} is true the first output column contains the real parts and the second column the imaginary parts. 6738@NOTE=If @{Sequence} is neither an n by 1 nor 1 by n array, this function returns #VALUE! 6739 6740@CATEGORY=Time Series Analysis 6741@FUNCTION=HPFILTER 6742@SHORTDESC=Hodrick Prescott Filter 6743@SYNTAX=HPFILTER(Sequence,λ) 6744@ARGUMENTDESCRIPTION=@{Sequence}: the data sequence to be transformed 6745@{λ}: filter parameter λ, defaults to 1600 6746@DESCRIPTION=This array function returns the trend and cyclical components obtained by applying the Hodrick Prescott Filter with parameter @{λ} to the given data sequence. 6747The output consists of two columns of numbers, the first containing the trend component, the second the cyclical component. 6748@NOTE=If @{Sequence} is neither an n by 1 nor 1 by n array, this function returns #VALUE! If @{Sequence} contains less than 6 numerical values, this function returns #VALUE! 6749 6750@CATEGORY=Time Series Analysis 6751@FUNCTION=INTERPOLATION 6752@SHORTDESC=interpolated values corresponding to the given abscissa targets 6753@SYNTAX=INTERPOLATION(abscissae,ordinates,targets,interpolation) 6754@ARGUMENTDESCRIPTION=@{abscissae}: abscissae of the given data points 6755@{ordinates}: ordinates of the given data points 6756@{targets}: abscissae of the interpolated data 6757@{interpolation}: method of interpolation, defaults to 0 ('linear') 6758@DESCRIPTION=The output consists always of one column of numbers. 6759Possible interpolation methods are: 67600: linear; 67611: linear with averaging; 67622: staircase; 67633: staircase with averaging; 67644: natural cubic spline; 67655: natural cubic spline with averaging. 6766@NOTE=The @{abscissae} should be given in increasing order. If the @{abscissae} is not in increasing order the INTERPOLATION function is significantly slower. If any two @{abscissae} values are equal an error is returned. If any of interpolation methods 1 ('linear with averaging'), 3 ('staircase with averaging'), and 5 ('natural cubic spline with averaging') is used, the number of returned values is one less than the number of targets and the target values must be given in increasing order. The values returned are the average heights of the interpolation function on the intervals determined by consecutive target values. Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells. 6767@SEEALSO=PERIODOGRAM 6768 6769@CATEGORY=Time Series Analysis 6770@FUNCTION=PERIODOGRAM 6771@SHORTDESC=periodogram of the given data 6772@SYNTAX=PERIODOGRAM(ordinates,filter,abscissae,interpolation,number) 6773@ARGUMENTDESCRIPTION=@{ordinates}: ordinates of the given data 6774@{filter}: windowing function to be used, defaults to no filter 6775@{abscissae}: abscissae of the given data, defaults to regularly spaced abscissae 6776@{interpolation}: method of interpolation, defaults to none 6777@{number}: number of interpolated data points 6778@DESCRIPTION=If an interpolation method is used, the number of returned values is one less than the number of targets and the targets values must be given in increasing order. 6779The output consists always of one column of numbers. 6780Possible interpolation methods are: 67810: linear; 67821: linear with averaging; 67832: staircase; 67843: staircase with averaging; 67854: natural cubic spline; 67865: natural cubic spline with averaging. 6787Possible window functions are: 67880: no filter (rectangular window) 67891: Bartlett (triangular window) 67902: Hahn (cosine window) 67913: Welch (parabolic window) 6792@NOTE=Strings and empty cells in @{abscissae} and @{ordinates} are ignored. If several target data are provided they must be in the same column in consecutive cells. 6793@SEEALSO=INTERPOLATION 6794 6795