mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-23 10:43:32 +08:00
98449fec51
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.
39 lines
2.2 KiB
Plaintext
39 lines
2.2 KiB
Plaintext
\section math math - Perform mathematics calculations
|
|
|
|
\subsection math-synopsis Synopsis
|
|
\fish{synopsis}
|
|
math [-sN | --scale=N] [--] EXPRESSION
|
|
\endfish
|
|
|
|
\subsection math-description Description
|
|
|
|
`math` is used to perform mathematical calculations. It is a very thin wrapper for the bc program, which makes it possible to specify an expression from the command line without using non-standard extensions or a pipeline.
|
|
|
|
For a description of the syntax supported by math, see the manual for the bc program. Keep in mind that parameter expansion takes place on any expressions before they 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 have to be escaped.
|
|
|
|
The following options are available:
|
|
|
|
- `-sN` or `--scale=N` sets the scale of the result. `N` must be an integer and defaults to zero. This simply sets bc's `scale` variable to the provided value.
|
|
|
|
\subsection return-values Return Values
|
|
|
|
If invalid options or no expression is provided the return `status` is two. If the expression is invalid the return `status` is three. If bc returns a result of `0` (literally, not `0.0` or similar variants) the return `status` is one otherwise it's zero.
|
|
|
|
\subsection math-example Examples
|
|
|
|
`math 1+1` outputs 2.
|
|
|
|
`math $status-128` outputs the numerical exit status of the last command minus 128.
|
|
|
|
`math 10 / 6` outputs `1`.
|
|
|
|
`math -s0 10.0 / 6.0` outputs `1`.
|
|
|
|
`math -s3 10 / 6` outputs `1.666`.
|
|
|
|
\subsection math-cautions Cautions
|
|
|
|
You should always place a `--` flag separator before the expression. 99.99% of the time you'll get the desired result without the separator. Something like `math -10.0 / 2` will fail because the negative floating point value gets treated as an invalid flag. But `math -10 / 2` will work because negative integers are special-cased.
|
|
|
|
Note that the modulo operator (`x % y`) is not well defined for floating point arithmetic. The `bc` command produces a nonsensical result rather than emit an error and fail in that case. It doesn't matter if the arguments are integers; e.g., `10 % 4`. You'll still get an incorrect result. Do not use the `-sN` flag with N greater than zero if you want sensible answers when using the modulo operator.
|