Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-12-28 13:53:10 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/math.txt

107 lines
4 KiB
Text
Raw Normal View History

Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz
2006-11-17 16:24:38 +00:00
\section math math - Perform mathematics calculations
\subsection math-synopsis Synopsis
Simplify styling
2014-08-01 12:25:41 +00:00
\fish{synopsis}
fix `math` regression The previous change to use `argparse` for parity with every other builtin and function introduced a regression. Invocations that start with a negative number can fail because the negative value looks like an invalid flag.
2017-07-14 23:03:31 +00:00
math [-sN | --scale=N] [--] EXPRESSION
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
\endfish
Update documentation display code to run roff on the client system instead of pregenerating documentation and compiling it into program binaries darcs-hash:20061117162438-ac50b-5c4c7f0bd8bf53a16e16ecfead9569e642b7160f.gz
2006-11-17 16:24:38 +00:00
\subsection math-description Description
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
`math` is used to perform mathematical calculations. It supports all the usual operations such as addition, subtraction, etc. As well as functions like `abs()`, `sqrt()` and `log2()`.
By default, the output is as a float with trailing zeroes trimmed. To get a fixed representation, the `--scale` option can be used, including `--scale=0` for integer output.
Revert part of "Revert "Cache math expressions"" 56d91345343a896ccc25d76494975d5c664eca5c contained an LRU cache plus changes to the documentation; 95162ef19d11cee48f952076d1e1ffa5cdb67383 reverted both. This commit re-adds the documentation changes, which are still correct.
2017-09-01 13:55:50 +00:00
doc_src/math: Document needed escaping harder Fixes #5650. [ci skip]
2019-02-12 17:12:52 +00:00
Keep in mind that parameter expansion takes before expressions are evaluated. This can be very useful in order to perform calculations involving shell variables or the output of command substitutions, but it also means that parenthesis (`()`) and the asterisk (`*`) glob character have to be escaped or quoted.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
`math` ignores whitespace between arguments and takes its input as multiple arguments (internally joined with a space), so `math 2 +2` and `math "2 + 2"` work the same. `math 2 2` is an error.
add floating point output to `math` command This makes it easy for the user to request floating point output with the desired number of digits after the decimal point (not to be confused with significant digits). Note that this is just a thin wrapper so someone can say `math -s3 10 / 3` rather than `math "scale=3; 10 /3"`. Resolves #1643
2016-05-03 03:53:48 +00:00
The following options are available:
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
- `-sN` or `--scale=N` sets the scale of the result. `N` must be an integer. A scale of zero causes results to be rounded down to the nearest integer. So `3/2` returns `1` rather than `2` which `1.5` would normally round to. This is for compatibility with `bc` which was the basis for this command prior to fish 3.0.0. Scale values greater than zero causes the result to be rounded using the usual rules to the specified number of decimal places.
add floating point output to `math` command This makes it easy for the user to request floating point output with the desired number of digits after the decimal point (not to be confused with significant digits). Note that this is just a thin wrapper so someone can say `math -s3 10 / 3` rather than `math "scale=3; 10 /3"`. Resolves #1643
2016-05-03 03:53:48 +00:00
\subsection return-values Return Values
[math] Check for runtime errors When number is infinite, not a number, larger than LONG_MAX or smaller than LONG_MIN, print a corresponding error and return STATUS_CMD_ERROR. This should fix the worst of the problems, by at least making them clear. Fixes #4479. Fixes #4768.
2018-03-07 17:01:12 +00:00
If the expression is successfully evaluated and doesn't over/underflow or return NaN the return `status` is zero (success) else one.
Extend documentation for the math function darcs-hash:20061212171037-ac50b-1b9d0f51b284925fe0fc3020774ec32bb1414ce7.gz
2006-12-12 17:10:37 +00:00
[math] Add subsection headers to the docs Otherwise this is printed as "math-syntax" in the man page.
2018-05-08 15:11:48 +00:00
\subsection math-syntax Syntax
[math] Document scientific notation
2018-02-26 16:55:17 +00:00
`math` knows some operators, constants, functions and can (obviously) read numbers.
For numbers, `.` is always the radix character regardless of locale - `2.5`, not `2,5`. Scientific notation (`10e5`) is also available.
[math] Add subsection headers to the docs Otherwise this is printed as "math-syntax" in the man page.
2018-05-08 15:11:48 +00:00
\subsection math-operators Operators
[math] Document scientific notation
2018-02-26 16:55:17 +00:00
`math` knows the following operators:
- `+` for addition and `-` for subtraction.
doc_src/math: Document needed escaping harder Fixes #5650. [ci skip]
2019-02-12 17:12:52 +00:00
- `*` for multiplication, `/` for division. (Note that `*` is the glob character and needs to be quoted or escaped)
[math] Document scientific notation
2018-02-26 16:55:17 +00:00
- `^` for exponentiation.
- `%` for modulo.
doc_src/math: Document needed escaping harder Fixes #5650. [ci skip]
2019-02-12 17:12:52 +00:00
- `(` and `)` for grouping. (These need to be quoted or escaped because `()` denotes a command substitution.)
[math] Document scientific notation
2018-02-26 16:55:17 +00:00
They are all used in an infix manner - `5 + 2`, not `+ 5 2`.
[math] Add subsection headers to the docs Otherwise this is printed as "math-syntax" in the man page.
2018-05-08 15:11:48 +00:00
\subsection math-constants Constants
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
`math` knows the following constants:
- `e` - Euler's number.
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
- `pi` - You know that one. Half of Tau. (Tau is not implemented)
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
Use them without a leading `$` - `pi - 3` should be about 0.
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
[math] Add subsection headers to the docs Otherwise this is printed as "math-syntax" in the man page.
2018-05-08 15:11:48 +00:00
\subsection math-functions Functions
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
`math` supports the following functions:
- `abs`
- `acos`
- `asin`
- `atan`
- `atan2`
- `ceil`
- `cos`
- `cosh`
- `exp` - the base-e exponential function
- `fac` - factorial
- `floor`
- `ln`
- `log` or `log10` - the base-10 logarithm
- `ncr`
- `npr`
- `pow(x,y)` returns x to the y (and can be written as `x ^ y`)
math: Document round [ci skip]
2018-12-01 22:06:13 +00:00
- `round` - rounds to the nearest integer, away from 0
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
- `sin`
- `sinh`
- `sqrt`
- `tan`
- `tanh`
All of the trigonometric functions use radians.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
\subsection math-example Examples
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
`math 1+1` outputs 2.
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
`math $status - 128` outputs the numerical exit status of the last command minus 128.
add floating point output to `math` command This makes it easy for the user to request floating point output with the desired number of digits after the decimal point (not to be confused with significant digits). Note that this is just a thin wrapper so someone can say `math -s3 10 / 3` rather than `math "scale=3; 10 /3"`. Resolves #1643
2016-05-03 03:53:48 +00:00
Correct math docs This was an oversight when math was changed to default to float output. Also some more jokey stuff. Jokey stuff is nice.
2018-09-15 13:31:59 +00:00
`math 10 / 6` outputs `1.666667`.
add floating point output to `math` command This makes it easy for the user to request floating point output with the desired number of digits after the decimal point (not to be confused with significant digits). Note that this is just a thin wrapper so someone can say `math -s3 10 / 3` rather than `math "scale=3; 10 /3"`. Resolves #1643
2016-05-03 03:53:48 +00:00
`math -s0 10.0 / 6.0` outputs `1`.
`math -s3 10 / 6` outputs `1.666`.
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
`math "sin(pi)"` outputs `0`.
Revert "Cache math expressions" This reverts commit 56d91345343a896ccc25d76494975d5c664eca5c. An LRU cache in the shell for math seems like overkill.
2017-09-01 07:25:40 +00:00
doc_src/math: Document needed escaping harder Fixes #5650. [ci skip]
2019-02-12 17:12:52 +00:00
`math 5 \* 2` or `math "5 * 2"` or `math 5 "*" 2` all output `10`.
Revert part of "Revert "Cache math expressions"" 56d91345343a896ccc25d76494975d5c664eca5c contained an LRU cache plus changes to the documentation; 95162ef19d11cee48f952076d1e1ffa5cdb67383 reverted both. This commit re-adds the documentation changes, which are still correct.
2017-09-01 13:55:50 +00:00
\subsection math-notes Compatibility notes
fix `math` regression The previous change to use `argparse` for parity with every other builtin and function introduced a regression. Invocations that start with a negative number can fail because the negative value looks like an invalid flag.
2017-07-14 23:03:31 +00:00
[math] Fix docs We no longer use muparser, but tinyexpr. tinyexpr does not have: - "Statistical functions" like min, max, avg - Multiple expressions separated with "," [ci skip]
2018-02-11 13:00:01 +00:00
Fish 1.x and 2.x releases relied on the `bc` command for handling `math` expressions. Starting with fish 3.0.0 fish uses the tinyexpr library and evaluates the expression without the involvement of any external commands.
Implement bare minimum builtin `math` command This is the second baby step in resolving #3157. Implement a bare minimum builtin `math` command. This is solely to ensure that fish can be built and run in the Travis build environments. This is okay since anyone running `builtin math` today is already getting an error response. Also, more work is needed to support bare var references, multiple result values, etc.
2017-08-23 02:57:30 +00:00
Revert part of "Revert "Cache math expressions"" 56d91345343a896ccc25d76494975d5c664eca5c contained an LRU cache plus changes to the documentation; 95162ef19d11cee48f952076d1e1ffa5cdb67383 reverted both. This commit re-adds the documentation changes, which are still correct.
2017-09-01 13:55:50 +00:00
You don't need to use `--` before the expression even if it begins with a minus sign which might otherwise be interpreted as an invalid option. If you do insert `--` before the expression it will cause option scanning to stop just like for every other command and it won't be part of the expression.
Reference in a new issue Copy permalink