Mirrors/nushell
2
0
Fork 0
mirror of https://github.com/nushell/nushell synced 2024-12-29 06:23:11 +00:00
Code Issues Projects Releases Packages Wiki Activity
nushell/docs/commands/math.md

183 lines
5.5 KiB
Markdown
Raw Normal View History

Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
# math
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Mathematical functions that generally only operate on a list of numbers (integers, decimals, bytes) and tables.
Currently the following functions are implemented:
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Rename average to avg
2020-06-19 23:20:25 +00:00
* `math avg`: Finds the average of a list of numbers or tables
Rename `calc` to `math eval` and allow it to optionally take an expression as an argument (#2195) * Rename `calc` to `math eval` and allow it to optionally take the expression as an argument * Moved calc tests to math eval Also added 2 tests and changed 1 test * Move calc docs to math eval
2020-07-18 04:11:19 +00:00
* [`math eval`](math-eval.md): Evaluates a list of math expressions into numbers
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
* `math max`: Finds the maximum within a list of numbers or tables
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
* `math median`: Finds the median of a list of numbers or tables
Add missing math commands to docs (#2447)
2020-08-30 03:32:38 +00:00
* `math min`: Finds the minimum within a list of numbers or tables
* `math mode`: Finds the most frequent element(s) within a list of numbers or tables
* `math stddev`: Finds the standard deviation of a list of numbers or tables
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
* `math sum`: Finds the sum of a list of numbers or tables
Added `math product` support (#2249) * added math product: working initial impl * resolving merge conflicts * impl std::ops::Mul for Filesize * rebased with main; refactored product implementation * fixed error msg, added docs for math product
2020-08-27 05:58:01 +00:00
* `math product`: Finds the product of a list of numbers or tables
Add missing math commands to docs (#2447)
2020-08-30 03:32:38 +00:00
* `math variance`: Finds the variance of a list of numbers or tables
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
However, the mathematical functions like `min` and `max` are more permissive and also work on `Dates`.
## Examples
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
To get the average of the file sizes in a directory, simply pipe the size column from the ls command to the average command.
### List of Numbers (Integers, Decimals, Bytes)
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
```shell
> ls
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
# │ name │ type │ size │ modified
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
────┼────────────────────┼──────┼──────────┼─────────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
0 │ CODE_OF_CONDUCT.md │ File │ 3.4 KB │ 4 days ago
1 │ CONTRIBUTING.md │ File │ 1.3 KB │ 4 days ago
2 │ Cargo.lock │ File │ 106.3 KB │ 6 mins ago
3 │ Cargo.toml │ File │ 4.6 KB │ 3 days ago
4 │ LICENSE │ File │ 1.1 KB │ 4 days ago
5 │ Makefile.toml │ File │ 449 B │ 4 days ago
6 │ README.md │ File │ 16.0 KB │ 6 mins ago
7 │ TODO.md │ File │ 0 B │ 6 mins ago
8 │ assets │ Dir │ 128 B │ 4 days ago
9 │ build.rs │ File │ 78 B │ 4 days ago
10 │ crates │ Dir │ 672 B │ 3 days ago
11 │ debian │ Dir │ 352 B │ 4 days ago
12 │ docker │ Dir │ 288 B │ 4 days ago
13 │ docs │ Dir │ 160 B │ 4 days ago
14 │ features.toml │ File │ 632 B │ 4 days ago
15 │ images │ Dir │ 160 B │ 4 days ago
16 │ justfile │ File │ 234 B │ 3 days ago
17 │ rustfmt.toml │ File │ 16 B │ 4 days ago
18 │ src │ Dir │ 128 B │ 4 days ago
19 │ target │ Dir │ 192 B │ 8 hours ago
20 │ tests │ Dir │ 192 B │ 4 days ago
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Rename average to avg
2020-06-19 23:20:25 +00:00
> ls | get size | math avg
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┬────────
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
# │
───┼────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
0 │ 7.2 KB
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┴────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
> ls | get size | math min
───┬─────
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
# │
───┼─────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
0 │ 0 B
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┴─────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
```shell
First pass at updating all documentation formatting and cleaning up output of examples (#2031)
2020-06-23 18:21:47 +00:00
> ls | get size | math max
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┬──────────
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
# │
───┼──────────
0 │ 113.6 KB
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
───┴──────────
```
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
```shell
> ls | get size | math median
───┬───────
# │
───┼───────
0 │ 320 B
───┴───────
```
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
> ls | get size | math sum
───┬──────────
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
# │
───┼──────────
0 │ 143.6 KB
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┴──────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
Add missing math commands to docs (#2447)
2020-08-30 03:32:38 +00:00
```shell
> echo [3 3 9 12 12 15] | math mode
───┬────
0 │ 3
1 │ 12
───┴────
```
Added `math product` support (#2249) * added math product: working initial impl * resolving merge conflicts * impl std::ops::Mul for Filesize * rebased with main; refactored product implementation * fixed error msg, added docs for math product
2020-08-27 05:58:01 +00:00
```shell
> echo [2 3 3 4] | math product
72
```
Add missing math commands to docs (#2447)
2020-08-30 03:32:38 +00:00
```shell
> echo [1 4 6 10 50] | math stddev
18.1372
```
```shell
> echo [1 4 6 10 50] | math variance
328.96
```
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
### Dates
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
> ls | get modified | math min
2020-06-09 17:25:51.798743222 UTC
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
> ls | get modified | math max
2020-06-14 05:49:59.637449186 UT
```
### Operations on tables
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
```shell
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
> pwd | split row / | size
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┬───────┬───────┬───────┬────────────
Size command: rename max length to bytes (#2473) Since max length is just getting the byte length, rename to bytes in order to be more clear.
2020-09-01 02:51:35 +00:00
# │ lines │ words │ chars │ bytes
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┼───────┼───────┼───────┼────────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
0 │ 0 │ 1 │ 5 │ 5
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
1 │ 0 │ 1 │ 11 │ 11
2 │ 0 │ 1 │ 11 │ 11
3 │ 0 │ 1 │ 4 │ 4
4 │ 0 │ 2 │ 12 │ 12
5 │ 0 │ 1 │ 7 │ 7
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
───┴───────┴───────┴───────┴────────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
> pwd | split row / | size | math max
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
────────────┬────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
lines │ 0
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
words │ 2
chars │ 12
Size command: rename max length to bytes (#2473) Since max length is just getting the byte length, rename to bytes in order to be more clear.
2020-09-01 02:51:35 +00:00
bytes │ 12
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
────────────┴────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
```shell
Rename average to avg
2020-06-19 23:20:25 +00:00
> pwd | split row / | size | math avg
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
────────────┬────────
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
lines │ 0.0000
Math median tests and documentation additions (#2018) * Add math median example and unit tests * Update output of other all math ls command examples to keep consistent with math median output * Fix output of math max example * Update output of other math commands using pwd examples to keep data consistent
2020-06-20 05:28:03 +00:00
words │ 1.1666
chars │ 8.3333
Size command: rename max length to bytes (#2473) Since max length is just getting the byte length, rename to bytes in order to be more clear.
2020-09-01 02:51:35 +00:00
bytes │ 8.3333
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
────────────┴────────
```
Minor Math Sum Additions (#2007) * Move sum tests into math directory * Move sum documentation over to math documentation One sum example already existed in the math examples and a few of the others were outdated and didn't work, so I only moved one over, and updated their output * Remove no-longer-in-use mod statement
2020-06-19 18:00:18 +00:00
To get the sum of the characters that make up your present working directory.
```shell
> pwd | split row / | size | get chars | math sum
50
```
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
## Errors
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
`math` functions are aggregation functions so empty lists are invalid
Convert sum command into subcommand of the math command (#2004) * Convert sum command into subcommand of the math command * Add bullet points to math.md documentation
2020-06-19 02:02:01 +00:00
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
```shell
Rename average to avg
2020-06-19 23:20:25 +00:00
> echo [] | math avg
Math Documentation (#1982) * Adding math docs * Add some comments to calculate * Remove redudant message Message already shows up in subcommands list * Added not working example Accidentantly * Remove table
2020-06-14 20:42:15 +00:00
error: Error: Unexpected: Cannot perform aggregate math operation on empty data
```
Reference in a new issue Copy permalink