Warning, /office/calligra/sheets/functions/engineering.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE KSpreadFunctions>
0002 <KSpreadFunctions>
0003
0004 <Group>
0005 <GroupName>Engineering</GroupName>
0006
0007 <Function>
0008 <Name>BASE</Name>
0009 <Type>String</Type>
0010 <Parameter>
0011 <Comment>Number</Comment>
0012 <Type>Float</Type>
0013 </Parameter>
0014 <Parameter>
0015 <Comment>Base</Comment>
0016 <Type>Int</Type>
0017 </Parameter>
0018 <Parameter optional="true">
0019 <Comment>MinLength</Comment> <!-- FIXME change to lower for 2.5-->
0020 <Type>Int</Type>
0021 </Parameter>
0022 <Help>
0023 <Text>The BASE() function converts a number from base-10 to a string value in a target base from 2 to 36.</Text>
0024 <Syntax>BASE(number;base;prec)</Syntax> <!-- FIXME change prec to minlength for 2.5-->
0025 <Example>BASE(128;8) returns "200"</Example>
0026 </Help>
0027 </Function>
0028
0029 <Function>
0030 <Name>BESSELI</Name>
0031 <Type>Float</Type>
0032 <Parameter>
0033 <Comment>Where the function is evaluated</Comment>
0034 <Type>Float</Type>
0035 </Parameter>
0036 <Parameter>
0037 <Comment>Order of the function</Comment>
0038 <Type>Int</Type>
0039 </Parameter>
0040 <Help>
0041 <Text>The BESSELI() function returns the modified Bessel function In(x).</Text>
0042 <Syntax>BESSELI(X;N)</Syntax>
0043 <Example>BESSELI(0.7;3) returns 0.007367374</Example>
0044 <Related>BESSELJ</Related>
0045 <Related>BESSELK</Related>
0046 <Related>BESSELY</Related>
0047 </Help>
0048 </Function>
0049
0050 <Function>
0051 <Name>BESSELJ</Name>
0052 <Type>Float</Type>
0053 <Parameter>
0054 <Comment>Where the function is evaluated</Comment>
0055 <Type>Float</Type>
0056 </Parameter>
0057 <Parameter>
0058 <Comment>Order of the function</Comment>
0059 <Type>Int</Type>
0060 </Parameter>
0061 <Help>
0062 <Text>The BESSELJ() function returns the Bessel function.</Text>
0063 <Syntax>BESSELJ(X;N)</Syntax>
0064 <Example>BESSELJ(0.89;3) returns 0.013974004</Example>
0065 <Related>BESSELI</Related>
0066 <Related>BESSELK</Related>
0067 <Related>BESSELY</Related>
0068 </Help>
0069 </Function>
0070
0071 <Function>
0072 <Name>BESSELK</Name>
0073 <Type>Float</Type>
0074 <Parameter>
0075 <Comment>Where the function is evaluated</Comment>
0076 <Type>Float</Type>
0077 </Parameter>
0078 <Parameter>
0079 <Comment>Order of the function</Comment>
0080 <Type>Int</Type>
0081 </Parameter>
0082 <Help>
0083 <Text>The BESSELK() function returns the modified Bessel function, which is equivalent to the Bessel function evaluated for purely imaginary arguments.</Text>
0084 <Syntax>BESSELK(X;N)</Syntax>
0085 <Example>BESSELK(3;9) returns 397.95880</Example>
0086 <Related>BESSELI</Related>
0087 <Related>BESSELJ</Related>
0088 <Related>BESSELY</Related>
0089 </Help>
0090 </Function>
0091
0092 <Function>
0093 <Name>BESSELY</Name>
0094 <Type>Float</Type>
0095 <Parameter>
0096 <Comment>Where the function is evaluated</Comment>
0097 <Type>Float</Type>
0098 </Parameter>
0099 <Parameter>
0100 <Comment>Order of the function</Comment>
0101 <Type>Int</Type>
0102 </Parameter>
0103 <Help>
0104 <Text>The BESSELY() function returns the Bessel function, which is also called the Weber function or the Neumann function.</Text>
0105 <Syntax>BESSELY(X;N)</Syntax>
0106 <Example>BESSELY(4;2) equals 0.215903595</Example>
0107 <Related>BESSELI</Related>
0108 <Related>BESSELJ</Related>
0109 <Related>BESSELK</Related>
0110 </Help>
0111 </Function>
0112
0113 <Function>
0114 <Name>CONVERT</Name>
0115 <Type>Float</Type>
0116 <Parameter>
0117 <Comment>Number</Comment>
0118 <Type>Float</Type>
0119 </Parameter>
0120 <Parameter>
0121 <Comment>From unit</Comment>
0122 <Type>String</Type>
0123 </Parameter>
0124 <Parameter>
0125 <Comment>To unit</Comment>
0126 <Type>String</Type>
0127 </Parameter>
0128 <Help>
0129 <Text>The CONVERT() function returns a conversion from one measurement system to another.</Text>
0130 <Text>Supported mass units: g (gram), sg (pieces), lbm (pound), u (atomic mass), ozm (ounce), stone, ton, grain, pweight (pennyweight), hweight (hundredweight).</Text>
0131 <Text>Supported distance units: m (meter), in (inch), ft (feet), mi (mile), Nmi (nautical mile), ang (Angstrom), parsec, lightyear.</Text>
0132 <Text>Supported pressure units: Pa (Pascal), atm (atmosphere), mmHg (mm of Mercury), psi, Torr.</Text>
0133 <Text>Supported force units: N (Newton), dyn, pound.</Text>
0134 <Text>Supported energy units: J (Joule), e (erg), c (Thermodynamic calorie), cal (IT calorie), eV (electronvolt), HPh (Horsepower-hour), Wh (Watt-hour), flb (foot-pound), BTU.</Text>
0135 <Text>Supported power units: W (Watt), HP (horsepower), PS (Pferdestaerke).</Text>
0136 <Text>Supported magnetism units: T (Tesla), ga (Gauss).</Text>
0137 <Text>Supported temperature units: C (Celsius), F (Fahrenheit), K (Kelvin).</Text>
0138 <Text>Supported volume units: l (liter), tsp (teaspoon), tbs (tablespoon), oz (ounce liquid), cup, pt (pint), qt (quart), gal (gallon), barrel, m3 (cubic meter), mi3 (cubic mile), Nmi3 (cubic Nautical mile), in3 (cubic inch), ft3 (cubic foot), yd3 (cubic yard), GRT or regton (gross register ton).</Text>
0139 <Text>Supported area units: m2 (square meter), mi2 (square mile), Nmi2 (square Nautical mile), in2 (square inch), ft2 (square foot), yd2 (square yard), acre, ha (hectare).</Text>
0140 <Text>Supported speed units: m/s (meters per second), m/h (meters per hour), mph (miles per hour), kn (knot).</Text>
0141 <Text>For metric units any of the following prefixes can be used: E (exa, 1E+18), P (peta, 1E+15), T (tera, 1E+12), G (giga, 1E+09), M (mega, 1E+06), k (kilo, 1E+03), h (hecto, 1E+02), e (dekao, 1E+01), d (deci, 1E-01), c (centi, 1E-02), m (milli, 1E-03), u (micro, 1E-06), n (nano, 1E-09), p (pico, 1E-12), f (femto, 1E-15), a (atto, 1E-18).</Text>
0142 <Syntax>CONVERT(Number; From Unit; To Unit)</Syntax>
0143 <Example>CONVERT(32;"C";"F") equals 89.6</Example>
0144 <Example>CONVERT(3;"lbm";"kg") equals 1.3608</Example>
0145 <Example>CONVERT(7.9;"cal";"J") equals 33.0757</Example>
0146 </Help>
0147 </Function>
0148
0149 <Function>
0150 <Name>ERF</Name>
0151 <Type>Float</Type>
0152 <Parameter>
0153 <Comment>Lower limit</Comment>
0154 <Type>Float</Type>
0155 </Parameter>
0156 <Parameter>
0157 <Comment>Upper limit</Comment>
0158 <Type>Float</Type>
0159 </Parameter>
0160 <Help>
0161 <Text>The ERF() function returns the error function. With a single argument, ERF() returns the error function between 0 and that argument.</Text>
0162 <Syntax>ERF(Lower limit; Upper limit)</Syntax>
0163 <Example>ERF(0.4) equals 0.42839236</Example>
0164 <Related>ERFC</Related>
0165 </Help>
0166 </Function>
0167
0168 <Function>
0169 <Name>ERFC</Name>
0170 <Type>Float</Type>
0171 <Parameter>
0172 <Comment>Lower limit</Comment>
0173 <Type>Float</Type>
0174 </Parameter>
0175 <Parameter>
0176 <Comment>Upper limit</Comment>
0177 <Type>Float</Type>
0178 </Parameter>
0179 <Help>
0180 <Text>The ERFC() function returns the complementary error function.</Text>
0181 <Syntax>ERFC(Lower limit; Upper limit)</Syntax>
0182 <Example>ERFC(0.4) equals 0.57160764</Example>
0183 <Related>ERF</Related>
0184 </Help>
0185 </Function>
0186
0187 <Function>
0188 <Name>DEC2BIN</Name>
0189 <Type>String</Type>
0190 <Parameter>
0191 <Comment>The value to convert</Comment>
0192 <Type>Int</Type>
0193 </Parameter>
0194 <Parameter optional="true">
0195 <Comment>The minimum length of the output</Comment>
0196 <Type>Int</Type>
0197 </Parameter>
0198 <Help>
0199 <Text>The DEC2BIN() function returns a decimal value formatted as a binary number.</Text>
0200 <Syntax>DEC2BIN(value)</Syntax>
0201 <Example>DEC2BIN(12) returns "1100"</Example>
0202 <Example>DEC2BIN(55) returns "110111"</Example>
0203 </Help>
0204 </Function>
0205
0206 <Function>
0207 <Name>DEC2HEX</Name>
0208 <Type>String</Type>
0209 <Parameter>
0210 <Comment>The value to convert</Comment>
0211 <Type>Int</Type>
0212 </Parameter>
0213 <Parameter optional="true">
0214 <Comment>The minimum length of the output</Comment>
0215 <Type>Int</Type>
0216 </Parameter>
0217 <Help>
0218 <Text>The DEC2HEX() function returns a decimal value formatted as a hexadecimal number.</Text>
0219 <Syntax>DEC2HEX(value)</Syntax>
0220 <Example>DEC2HEX(12) returns "c"</Example>
0221 <Example>DEC2HEX(55) returns "37"</Example>
0222 </Help>
0223 </Function>
0224
0225 <Function>
0226 <Name>DEC2OCT</Name>
0227 <Type>String</Type>
0228 <Parameter>
0229 <Comment>The value to convert</Comment>
0230 <Type>Int</Type>
0231 </Parameter>
0232 <Parameter optional="true">
0233 <Comment>The minimum length of the output</Comment>
0234 <Type>Int</Type>
0235 </Parameter>
0236 <Help>
0237 <Text>The DEC2OCT() function returns a decimal value formatted as an octal number.</Text>
0238 <Syntax>DEC2OCT(value)</Syntax>
0239 <Example>DEC2OCT(12) returns "14"</Example>
0240 <Example>DEC2OCT(55) returns "67"</Example>
0241 </Help>
0242 </Function>
0243
0244 <Function>
0245 <Name>OCT2BIN</Name>
0246 <Type>String</Type>
0247 <Parameter>
0248 <Comment>The value to convert</Comment>
0249 <Type>String</Type>
0250 </Parameter>
0251 <Parameter optional="true">
0252 <Comment>The minimum length of the output</Comment>
0253 <Type>Int</Type>
0254 </Parameter>
0255 <Help>
0256 <Text>The OCT2BIN() function returns an octal value formatted as a binary number.</Text>
0257 <Syntax>OCT2BIN(value)</Syntax>
0258 <Example>OCT2BIN("12") returns "1010"</Example>
0259 <Example>OCT2BIN("55") returns "101101"</Example>
0260 </Help>
0261 </Function>
0262
0263 <Function>
0264 <Name>OCT2DEC</Name>
0265 <Type>Int</Type>
0266 <Parameter>
0267 <Comment>The value to convert</Comment>
0268 <Type>String</Type>
0269 </Parameter>
0270 <Help>
0271 <Text>The OCT2DEC() function returns an octal value formatted as a decimal number.</Text>
0272 <Syntax>OCT2DEC(value)</Syntax>
0273 <Example>OCT2DEC("12") returns 10 </Example>
0274 <Example>OCT2DEC("55") returns 45 </Example>
0275 </Help>
0276 </Function>
0277
0278 <Function>
0279 <Name>OCT2HEX</Name>
0280 <Type>String</Type>
0281 <Parameter>
0282 <Comment>The value to convert</Comment>
0283 <Type>String</Type>
0284 </Parameter>
0285 <Parameter optional="true">
0286 <Comment>The minimum length of the output</Comment>
0287 <Type>Int</Type>
0288 </Parameter>
0289 <Help>
0290 <Text>The OCT2HEX() function returns an octal value formatted as a hexadecimal number.</Text>
0291 <Syntax>OCT2HEX(value)</Syntax>
0292 <Example>OCT2HEX("12") returns "A"</Example>
0293 <Example>OCT2HEX("55") returns "2D"</Example>
0294 </Help>
0295 </Function>
0296
0297 <Function>
0298 <Name>BIN2DEC</Name>
0299 <Type>Int</Type>
0300 <Parameter>
0301 <Comment>The value to convert</Comment>
0302 <Type>Int</Type>
0303 </Parameter>
0304 <Help>
0305 <Text>The BIN2DEC() function returns a binary value formatted as a decimal number.</Text>
0306 <Syntax>BIN2DEC(value)</Syntax>
0307 <Example>BIN2DEC("1010") returns 10 </Example>
0308 <Example>BIN2DEC("11111") returns 31 </Example>
0309 </Help>
0310 </Function>
0311
0312 <Function>
0313 <Name>BIN2OCT</Name>
0314 <Type>String</Type>
0315 <Parameter>
0316 <Comment>The value to convert</Comment>
0317 <Type>String</Type>
0318 </Parameter>
0319 <Parameter optional="true">
0320 <Comment>The minimum length of the output</Comment>
0321 <Type>Int</Type>
0322 </Parameter>
0323 <Help>
0324 <Text>The BIN2OCT() function returns a binary value formatted as an octal number.</Text>
0325 <Syntax>BIN2OCT(value)</Syntax>
0326 <Example>BIN2OCT("1010") returns "12" </Example>
0327 <Example>BIN2OCT("11111") returns "37" </Example>
0328 </Help>
0329 </Function>
0330
0331 <Function>
0332 <Name>BIN2HEX</Name>
0333 <Type>String</Type>
0334 <Parameter>
0335 <Comment>The value to convert</Comment>
0336 <Type>String</Type>
0337 </Parameter>
0338 <Parameter optional="true">
0339 <Comment>The minimum length of the output</Comment>
0340 <Type>Int</Type>
0341 </Parameter>
0342 <Help>
0343 <Text>The BIN2HEX() function returns a binary value formatted as a hexadecimal number.</Text>
0344 <Syntax>BIN2HEX(value)</Syntax>
0345 <Example>BIN2HEX("1010") returns "a"</Example>
0346 <Example>BIN2HEX("11111") returns "1f"</Example>
0347 </Help>
0348 </Function>
0349
0350 <Function>
0351 <Name>HEX2DEC</Name>
0352 <Type>Int</Type>
0353 <Parameter>
0354 <Comment>The value to convert</Comment>
0355 <Type>String</Type>
0356 </Parameter>
0357 <Help>
0358 <Text>The HEX2DEC() function returns a hexadecimal value formatted as a decimal number.</Text>
0359 <Syntax>HEX2DEC(value)</Syntax>
0360 <Example>HEX2DEC("a") returns 10 </Example>
0361 <Example>HEX2DEC("37") returns 55 </Example>
0362 </Help>
0363 </Function>
0364
0365 <Function>
0366 <Name>HEX2OCT</Name>
0367 <Type>String</Type>
0368 <Parameter>
0369 <Comment>The value to convert</Comment>
0370 <Type>String</Type>
0371 </Parameter>
0372 <Help>
0373 <Text>The HEX2OCT() function returns a hexadecimal value formatted as an octal number.</Text>
0374 <Syntax>HEX2OCT(value)</Syntax>
0375 <Example>HEX2OCT("a") returns "12" </Example>
0376 <Example>HEX2OCT("37") returns "67" </Example>
0377 </Help>
0378 </Function>
0379
0380 <Function>
0381 <Name>HEX2BIN</Name>
0382 <Type>String</Type>
0383 <Parameter>
0384 <Comment>The value to convert</Comment>
0385 <Type>String</Type>
0386 </Parameter>
0387 <Help>
0388 <Text>The HEX2BIN() function returns a hexadecimal value formatted as a binary number.</Text>
0389 <Syntax>HEX2BIN(value)</Syntax>
0390 <Example>HEX2BIN("a") returns "1010"</Example>
0391 <Example>HEX2BIN("37") returns "110111"</Example>
0392 </Help>
0393 </Function>
0394
0395 <Function>
0396 <Name>COMPLEX</Name>
0397 <Type>String</Type>
0398 <Parameter>
0399 <Comment>Real coefficient</Comment>
0400 <Type>Float</Type>
0401 </Parameter>
0402 <Parameter>
0403 <Comment>Imaginary coefficient</Comment>
0404 <Type>Float</Type>
0405 </Parameter>
0406 <Help>
0407 <Text>The COMPLEX(real;imag) returns a complex number of form x+yi.</Text>
0408 <Syntax>COMPLEX(real;imag)</Syntax>
0409 <Example>COMPLEX(1.2;3.4) returns "1.2+3.4i"</Example>
0410 <Example>COMPLEX(0;-1) returns "-i"</Example>
0411 </Help>
0412 </Function>
0413
0414 <Function>
0415 <Name>IMAGINARY</Name>
0416 <Type>Double</Type>
0417 <Parameter>
0418 <Comment>Complex number</Comment>
0419 <Type>String</Type>
0420 </Parameter>
0421 <Help>
0422 <Text>The IMAGINARY(string) returns the imaginary coefficient of a complex.</Text>
0423 <Syntax>IMAGINARY(string)</Syntax>
0424 <Example>IMAGINARY("1.2+3.4i") returns 3.4</Example>
0425 <Example>IMAGINARY("1.2") returns 0 </Example>
0426 </Help>
0427 </Function>
0428
0429 <Function>
0430 <Name>IMREAL</Name>
0431 <Type>Double</Type>
0432 <Parameter>
0433 <Comment>Complex number</Comment>
0434 <Type>String</Type>
0435 </Parameter>
0436 <Help>
0437 <Text>The IMREAL(string) returns the real coefficient of a complex.</Text>
0438 <Syntax>IMREAL(string)</Syntax>
0439 <Example>IMREAL("1.2+3.4i") returns 1.2</Example>
0440 <Example>IMREAL("1.2i") returns 0 </Example>
0441 </Help>
0442 </Function>
0443
0444 <Function>
0445 <Name>IMCOS</Name>
0446 <Type>String</Type>
0447 <Parameter>
0448 <Comment>Complex number</Comment>
0449 <Type>String</Type>
0450 </Parameter>
0451 <Help>
0452 <Text>The IMCOS(string) returns the cosine of a complex number.</Text>
0453 <Syntax>IMCOS(string)</Syntax>
0454 <Example>IMCOS("1+i") returns "0.83373-0.988898i"</Example>
0455 <Example>IMCOS("12i") returns 81 377.4 </Example>
0456 </Help>
0457 </Function>
0458
0459 <Function>
0460 <Name>IMCOSH</Name>
0461 <Type>String</Type>
0462 <Parameter>
0463 <Comment>Complex number</Comment>
0464 <Type>String</Type>
0465 </Parameter>
0466 <Help>
0467 <Text>The IMCOSH(string) returns the hyperbolic cosine of a complex number.</Text>
0468 <Syntax>IMCOSH(string)</Syntax>
0469 <Example>IMCOSH("1+i") returns "0.83373+0.988898i"</Example>
0470 <Example>IMCOSH("12i") returns 0.84358 </Example>
0471 </Help>
0472 </Function>
0473
0474 <Function>
0475 <Name>IMCOT</Name>
0476 <Type>String</Type>
0477 <Parameter>
0478 <Comment>Complex number</Comment>
0479 <Type>String</Type>
0480 </Parameter>
0481 <Help>
0482 <Text>The IMCOT(string) returns the cotangent of a complex number.</Text>
0483 <Syntax>IMCOT(string)</Syntax>
0484 <Example>IMCOT("1+i") returns "0.21762-0.86801i"</Example>
0485 </Help>
0486 </Function>
0487
0488 <Function>
0489 <Name>IMCSC</Name>
0490 <Type>String</Type>
0491 <Parameter>
0492 <Comment>Complex number</Comment>
0493 <Type>String</Type>
0494 </Parameter>
0495 <Help>
0496 <Text>The IMCSC(string) returns the cosecant of a complex number.</Text>
0497 <Syntax>IMCSC(string)</Syntax>
0498 <Example>IMCSC("1+i") returns "0.62151-0.30393i"</Example>
0499 </Help>
0500 </Function>
0501
0502 <Function>
0503 <Name>IMCSCH</Name>
0504 <Type>String</Type>
0505 <Parameter>
0506 <Comment>Complex number</Comment>
0507 <Type>String</Type>
0508 </Parameter>
0509 <Help>
0510 <Text>The IMCSCH(string) returns the hyperbolic cosecant of a complex number.</Text>
0511 <Syntax>IMCSCH(string)</Syntax>
0512 <Example>IMCSCH("1+i") returns "0.30393-i0.62151"</Example>
0513 </Help>
0514 </Function>
0515
0516 <Function>
0517 <Name>IMSEC</Name>
0518 <Type>String</Type>
0519 <Parameter>
0520 <Comment>Complex number</Comment>
0521 <Type>String</Type>
0522 </Parameter>
0523 <Help>
0524 <Text>The IMSEC(string) returns the secant of a complex number.</Text>
0525 <Syntax>IMSEC(string)</Syntax>
0526 <Example>IMSEC("1+i") returns "0.49833+i0.59108"</Example>
0527 </Help>
0528 </Function>
0529
0530 <Function>
0531 <Name>IMSECH</Name>
0532 <Type>String</Type>
0533 <Parameter>
0534 <Comment>Complex number</Comment>
0535 <Type>String</Type>
0536 </Parameter>
0537 <Help>
0538 <Text>The IMSECH(string) returns the hyperbolic secant of a complex number.</Text>
0539 <Syntax>IMSECH(string)</Syntax>
0540 <Example>IMSECH("1+i") returns "0.49833-i0.59108"</Example>
0541 </Help>
0542 </Function>
0543
0544 <Function>
0545 <Name>IMSIN</Name>
0546 <Type>String</Type>
0547 <Parameter>
0548 <Comment>Complex number</Comment>
0549 <Type>String</Type>
0550 </Parameter>
0551 <Help>
0552 <Text>The IMSIN(string) function returns the sine of a complex number.</Text>
0553 <Syntax>IMSIN(string)</Syntax>
0554 <Example>IMSIN("1+i") returns "1.29846+0.634964i"</Example>
0555 <Example>IMSIN("1.2") returns -0.536573 </Example>
0556 </Help>
0557 </Function>
0558
0559 <Function>
0560 <Name>IMSINH</Name>
0561 <Type>String</Type>
0562 <Parameter>
0563 <Comment>Complex number</Comment>
0564 <Type>String</Type>
0565 </Parameter>
0566 <Help>
0567 <Text>The IMSINH(string) function returns the hyperbolic sine of a complex number.</Text>
0568 <Syntax>IMSINH(string)</Syntax>
0569 <Example>IMSINH("1+i") returns "0.63496+1.29846i"</Example>
0570 <Example>IMSINH("1.2") returns 1.50946 </Example>
0571 </Help>
0572 </Function>
0573
0574 <Function>
0575 <Name>IMTAN</Name>
0576 <Type>String</Type>
0577 <Parameter>
0578 <Comment>Complex number</Comment>
0579 <Type>String</Type>
0580 </Parameter>
0581 <Help>
0582 <Text>The IMTAN(string) function returns the tangent of a complex number.</Text>
0583 <Syntax>IMTAN(string)</Syntax>
0584 <Example>IMTAN("1+i") returns "0.27175+1.08392i"</Example>
0585 <Example>IMTAN("1.2") returns 2.57215</Example>
0586 </Help>
0587 </Function>
0588
0589 <Function>
0590 <Name>IMTANH</Name>
0591 <Type>String</Type>
0592 <Parameter>
0593 <Comment>Complex number</Comment>
0594 <Type>String</Type>
0595 </Parameter>
0596 <Help>
0597 <Text>The IMTANH(string) function returns the hyperbolic tangent of a complex number.</Text>
0598 <Syntax>IMTANH(string)</Syntax>
0599 <Example>IMTANH("1+i") returns "1.08392+0.27175i"</Example>
0600 <Example>IMTANH("1.2") returns 0.83365</Example>
0601 </Help>
0602 </Function>
0603
0604 <Function>
0605 <Name>IMEXP</Name>
0606 <Type>String</Type>
0607 <Parameter>
0608 <Comment>Complex number</Comment>
0609 <Type>String</Type>
0610 </Parameter>
0611 <Help>
0612 <Text>The IMEXP(string) returns the exponential of a complex number.</Text>
0613 <Syntax>IMEXP(string)</Syntax>
0614 <Example>IMEXP("2-i") returns "3.99232-6.21768i"</Example>
0615 <Example>IMEXP("12i") returns "0.843854-0.536573i" </Example>
0616 </Help>
0617 </Function>
0618
0619 <Function>
0620 <Name>IMLN</Name>
0621 <Type>String</Type>
0622 <Parameter>
0623 <Comment>Complex number</Comment>
0624 <Type>String</Type>
0625 </Parameter>
0626 <Help>
0627 <Text>The IMLN(string) returns the natural logarithm of a complex number.</Text>
0628 <Syntax>IMLN(string)</Syntax>
0629 <Example>IMLN("3-i") returns "1.15129-0.321751i"</Example>
0630 <Example>IMLN("12") returns 2.48491 </Example>
0631 </Help>
0632 </Function>
0633
0634 <Function>
0635 <Name>IMLOG2</Name>
0636 <Type>String</Type>
0637 <Parameter>
0638 <Comment>Complex number</Comment>
0639 <Type>String</Type>
0640 </Parameter>
0641 <Help>
0642 <Text>The IMLOG2(string) returns the base-2 logarithm of a complex number.</Text>
0643 <Syntax>IMLOG2(string)</Syntax>
0644 <Example>IMLOG2("3+4i") returns "2.321928+1.337804i"</Example>
0645 </Help>
0646 </Function>
0647
0648 <Function>
0649 <Name>IMLOG10</Name>
0650 <Type>String</Type>
0651 <Parameter>
0652 <Comment>Complex number</Comment>
0653 <Type>String</Type>
0654 </Parameter>
0655 <Help>
0656 <Text>The IMLOG10(string) returns the base-10 logarithm of a complex number.</Text>
0657 <Syntax>IMLOG10(string)</Syntax>
0658 <Example>IMLOG10("3+4i") returns "0.69897+0.402719i"</Example>
0659 </Help>
0660 </Function>
0661
0662 <Function>
0663 <Name>IMSQRT</Name>
0664 <Type>String</Type>
0665 <Parameter>
0666 <Comment>Complex number</Comment>
0667 <Type>String</Type>
0668 </Parameter>
0669 <Help>
0670 <Text>The IMSQRT(string) returns the square root of a complex number.</Text>
0671 <Syntax>IMSQRT(string)</Syntax>
0672 <Example>IMSQRT("1+i") returns "1.09868+0.45509i"</Example>
0673 <Example>IMSQRT("1.2i") returns "0.774597+0.774597i" </Example>
0674 </Help>
0675 </Function>
0676
0677 <Function>
0678 <Name>IMPOWER</Name>
0679 <Type>String</Type>
0680 <Parameter>
0681 <Comment>Complex number</Comment>
0682 <Type>String</Type>
0683 </Parameter>
0684 <Parameter>
0685 <Comment>Power</Comment>
0686 <Type>Int</Type>
0687 </Parameter>
0688 <Help>
0689 <Text>The IMPOWER(string) returns a complex number raised to a power.</Text>
0690 <Syntax>IMPOWER(string)</Syntax>
0691 <Example>IMPOWER("4-i";2) returns "15-8i"</Example>
0692 <Example>IMPOWER("1.2";2) returns 1.44 </Example>
0693 </Help>
0694 </Function>
0695
0696
0697 <Function>
0698 <Name>IMSUM</Name>
0699 <Type>String</Type>
0700 <Parameter optional="true">
0701 <Comment>Complex number</Comment>
0702 <Type range="true">String</Type>
0703 </Parameter>
0704 <Parameter optional="true">
0705 <Comment>Complex number</Comment>
0706 <Type range="true">String</Type>
0707 </Parameter>
0708 <Parameter optional="true">
0709 <Comment>Complex number</Comment>
0710 <Type range="true">String</Type>
0711 </Parameter>
0712 <Parameter optional="true">
0713 <Comment>Complex number</Comment>
0714 <Type range="true">String</Type>
0715 </Parameter>
0716 <Parameter optional="true">
0717 <Comment>Complex number</Comment>
0718 <Type range="true">String</Type>
0719 </Parameter>
0720 <Help>
0721 <Text>The IMSUM() returns the sum of several complex numbers of form x+yi.</Text>
0722 <Syntax>IMSUM(value;value;...)</Syntax>
0723 <Example>IMSUM(1.2;"3.4+5i") returns "4.6+5i"</Example>
0724 <Example>IMSUM(1.2;"1i") returns "1.2+i"</Example>
0725 </Help>
0726 </Function>
0727
0728 <Function>
0729 <Name>IMDIV</Name>
0730 <Type>String</Type>
0731 <Parameter optional="true">
0732 <Comment>Complex number</Comment>
0733 <Type range="true">String</Type>
0734 </Parameter>
0735 <Parameter optional="true">
0736 <Comment>Complex number</Comment>
0737 <Type range="true">String</Type>
0738 </Parameter>
0739 <Parameter optional="true">
0740 <Comment>Complex number</Comment>
0741 <Type range="true">String</Type>
0742 </Parameter>
0743 <Parameter optional="true">
0744 <Comment>Complex number</Comment>
0745 <Type range="true">String</Type>
0746 </Parameter>
0747 <Parameter optional="true">
0748 <Comment>Complex number</Comment>
0749 <Type range="true">String</Type>
0750 </Parameter>
0751 <Help>
0752 <Text>The IMDIV() returns the division of several complex numbers of form x+yi.</Text>
0753 <Syntax>IMDIV(value;value;...)</Syntax>
0754 <Example>IMDIV(1.2;"3.4+5i") returns "0.111597-0.164114i"</Example>
0755 <Example>IMDIV("12+i";"12-i") returns "0.986207+0.16551i"</Example>
0756 </Help>
0757 </Function>
0758
0759
0760 <Function>
0761 <Name>IMSUB</Name>
0762 <Type>String</Type>
0763 <Parameter optional="true">
0764 <Comment>Complex number</Comment>
0765 <Type range="true">String</Type>
0766 </Parameter>
0767 <Parameter optional="true">
0768 <Comment>Complex number</Comment>
0769 <Type range="true">String</Type>
0770 </Parameter>
0771 <Parameter optional="true">
0772 <Comment>Complex number</Comment>
0773 <Type range="true">String</Type>
0774 </Parameter>
0775 <Parameter optional="true">
0776 <Comment>Complex number</Comment>
0777 <Type range="true">String</Type>
0778 </Parameter>
0779 <Parameter optional="true">
0780 <Comment>Complex number</Comment>
0781 <Type range="true">String</Type>
0782 </Parameter>
0783 <Help>
0784 <Text>The IMSUB() returns the difference of several complex numbers of form x+yi.</Text>
0785 <Syntax>IMSUB(value;value;...)</Syntax>
0786 <Example>IMSUB(1.2;"3.4+5i") returns "-2.2-5i"</Example>
0787 <Example>IMSUB(1.2;"1i") returns "1.2-i"</Example>
0788 </Help>
0789 </Function>
0790
0791 <Function>
0792 <Name>IMPRODUCT</Name>
0793 <Type>String</Type>
0794 <Parameter optional="true">
0795 <Comment>Complex number</Comment>
0796 <Type range="true">String</Type>
0797 </Parameter>
0798 <Parameter optional="true">
0799 <Comment>Complex number</Comment>
0800 <Type range="true">String</Type>
0801 </Parameter>
0802 <Parameter optional="true">
0803 <Comment>Complex number</Comment>
0804 <Type range="true">String</Type>
0805 </Parameter>
0806 <Parameter optional="true">
0807 <Comment>Complex number</Comment>
0808 <Type range="true">String</Type>
0809 </Parameter>
0810 <Parameter optional="true">
0811 <Comment>Complex number</Comment>
0812 <Type range="true">String</Type>
0813 </Parameter>
0814 <Help>
0815 <Text>The IMPRODUCT() returns the product of several complex numbers of form x+yi.</Text>
0816 <Syntax>IMPRODUCT(value;value;...)</Syntax>
0817 <Example>IMPRODUCT(1.2;"3.4+5i") returns "4.08+6i"</Example>
0818 <Example>IMPRODUCT(1.2;"1i") returns "+1.2i"</Example>
0819 </Help>
0820 </Function>
0821
0822 <Function>
0823 <Name>IMCONJUGATE</Name>
0824 <Type>String</Type>
0825 <Parameter>
0826 <Comment>Complex number</Comment>
0827 <Type>String</Type>
0828 </Parameter>
0829 <Help>
0830 <Text>The IMCONJUGATE(complex number) returns the conjugate of a complex number of form x+yi.</Text>
0831 <Syntax>IMCONJUGATE(complex number)</Syntax>
0832 <Example>IMCONJUGATE("1.2+5i") returns "1.2-5i"</Example>
0833 <Example>IMCONJUGATE("-i") returns "i"</Example>
0834 <Example>IMCONJUGATE("12") returns "12"</Example>
0835 </Help>
0836 </Function>
0837
0838 <Function>
0839 <Name>IMARGUMENT</Name>
0840 <Type>String</Type>
0841 <Parameter>
0842 <Comment>Complex number</Comment>
0843 <Type>String</Type>
0844 </Parameter>
0845 <Help>
0846 <Text>The IMARGUMENT(complex number) returns the argument of a complex number of form x+yi.</Text>
0847 <Syntax>IMARGUMENT(complex number)</Syntax>
0848 <Example>IMARGUMENT("1.2+5i") returns 0.6072</Example>
0849 <Example>IMARGUMENT("-i") returns -1.57079633 </Example>
0850 <Example>IMARGUMENT("12") returns "#Div/0"</Example>
0851 </Help>
0852 </Function>
0853
0854 <Function>
0855 <Name>IMABS</Name>
0856 <Type>Float</Type>
0857 <Parameter>
0858 <Comment>Complex number</Comment>
0859 <Type>String</Type>
0860 </Parameter>
0861 <Help>
0862 <Text>The IMABS(complex number) returns the norm of a complex number of form x+yi.</Text>
0863 <Syntax>IMABS(complex number)</Syntax>
0864 <Example>IMABS("1.2+5i") returns 5.1419</Example>
0865 <Example>IMABS("-i") returns 1</Example>
0866 <Example>IMABS("12") returns 12</Example>
0867 </Help>
0868 </Function>
0869
0870 <Function>
0871 <Name>DELTA</Name>
0872 <Type>Float</Type>
0873 <Parameter>
0874 <Comment>Floating point value</Comment>
0875 <Type>Float</Type>
0876 </Parameter>
0877 <Parameter optional="true">
0878 <Comment>Floating point value</Comment>
0879 <Type>Float</Type>
0880 </Parameter>
0881 <Help>
0882 <Text>The DELTA() function returns 1 if x equals y, otherwise returns 0. y defaults to 0.</Text>
0883 <Syntax>DELTA(x; y)</Syntax>
0884 <Example>DELTA(1.2; 3.4) returns 0</Example>
0885 <Example>DELTA(3; 3) returns 1</Example>
0886 <Example>DELTA(1; TRUE) returns 1</Example>
0887 </Help>
0888 </Function>
0889
0890 <Function>
0891 <Name>GESTEP</Name>
0892 <Type>Float</Type>
0893 <Parameter>
0894 <Comment>Floating point value</Comment>
0895 <Type>Float</Type>
0896 </Parameter>
0897 <Parameter optional="true">
0898 <Comment>Floating point value</Comment>
0899 <Type>Float</Type>
0900 </Parameter>
0901 <Help>
0902 <Text>The GESTEP() function returns 1 if x greater or equals y, otherwise returns 0. y defaults to 0.</Text>
0903 <Syntax>GESTEP(x; y)</Syntax>
0904 <Example>GESTEP(1.2; 3.4) returns 0</Example>
0905 <Example>GESTEP(3; 3) returns 1</Example>
0906 <Example>GESTEP(0.4; TRUE) returns 0</Example>
0907 <Example>GESTEP(4; 3) returns 1</Example>
0908 </Help>
0909 </Function>
0910
0911 </Group>
0912
0913 </KSpreadFunctions>