diff --git a/docs/src/manpage.md b/docs/src/manpage.md index 5ab08d255..d7ed08295 100644 --- a/docs/src/manpage.md +++ b/docs/src/manpage.md @@ -2564,7 +2564,7 @@ MILLER(1) MILLER(1) (class=collections #args=1,2) Converts value to JSON-formatted string. Default output is single-line. With optional second boolean argument set to true, produces multiline output. 1mkurtosis0m - (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: kurtosis([4,5,9,10,11]) is -1.6703688 @@ -2639,7 +2639,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Max of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mmaxlen0m - (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: maxlen(["ao", "alto"]) is 4 @@ -2647,17 +2647,17 @@ MILLER(1) MILLER(1) (class=hashing #args=1) MD5 hash. 1mmean0m - (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: mean([4,5,7,10]) is 6.5 1mmeaneb0m - (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: meaneb([4,5,7,10]) is 1.3228756 1mmedian0m - (class=stats #args=1,2) Returns the median of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: median([3,4,5,6,9,10]) is 6 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5 @@ -2670,7 +2670,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Min of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mminlen0m - (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: minlen(["ao", "alto"]) is 3 @@ -2721,14 +2721,14 @@ MILLER(1) MILLER(1) (class=system #args=0) Returns the operating-system name as a string. 1mpercentile0m - (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: percentile([3,4,5,6,9,10], 90) is 10 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5 percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi" 1mpercentiles0m - (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. + (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. Examples: Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort @@ -2873,7 +2873,7 @@ MILLER(1) MILLER(1) (class=math #args=1) Hyperbolic sine. 1mskewness0m - (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: skewness([4,5,9,10,11]) is -0.2097285 @@ -2935,7 +2935,7 @@ MILLER(1) MILLER(1) ssub("abc.def", ".", "X") gives "abcXdef" 1mstddev0m - (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: stddev([4,5,9,10,11]) is 3.1144823 @@ -3125,7 +3125,7 @@ MILLER(1) MILLER(1) $* = utf8_to_latin1($*) 1mvariance0m - (class=stats #args=1) Returns the sample variance of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: variance([4,5,9,10,11]) is 9.7 diff --git a/docs/src/manpage.txt b/docs/src/manpage.txt index 666177bee..290fa7c5d 100644 --- a/docs/src/manpage.txt +++ b/docs/src/manpage.txt @@ -2543,7 +2543,7 @@ MILLER(1) MILLER(1) (class=collections #args=1,2) Converts value to JSON-formatted string. Default output is single-line. With optional second boolean argument set to true, produces multiline output. 1mkurtosis0m - (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: kurtosis([4,5,9,10,11]) is -1.6703688 @@ -2618,7 +2618,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Max of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mmaxlen0m - (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: maxlen(["ao", "alto"]) is 4 @@ -2626,17 +2626,17 @@ MILLER(1) MILLER(1) (class=hashing #args=1) MD5 hash. 1mmean0m - (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: mean([4,5,7,10]) is 6.5 1mmeaneb0m - (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: meaneb([4,5,7,10]) is 1.3228756 1mmedian0m - (class=stats #args=1,2) Returns the median of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: median([3,4,5,6,9,10]) is 6 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5 @@ -2649,7 +2649,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Min of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mminlen0m - (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: minlen(["ao", "alto"]) is 3 @@ -2700,14 +2700,14 @@ MILLER(1) MILLER(1) (class=system #args=0) Returns the operating-system name as a string. 1mpercentile0m - (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: percentile([3,4,5,6,9,10], 90) is 10 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5 percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi" 1mpercentiles0m - (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. + (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. Examples: Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort @@ -2852,7 +2852,7 @@ MILLER(1) MILLER(1) (class=math #args=1) Hyperbolic sine. 1mskewness0m - (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: skewness([4,5,9,10,11]) is -0.2097285 @@ -2914,7 +2914,7 @@ MILLER(1) MILLER(1) ssub("abc.def", ".", "X") gives "abcXdef" 1mstddev0m - (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: stddev([4,5,9,10,11]) is 3.1144823 @@ -3104,7 +3104,7 @@ MILLER(1) MILLER(1) $* = utf8_to_latin1($*) 1mvariance0m - (class=stats #args=1) Returns the sample variance of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: variance([4,5,9,10,11]) is 9.7 diff --git a/docs/src/reference-dsl-builtin-functions.md b/docs/src/reference-dsl-builtin-functions.md index 3d24f0984..34a420f0d 100644 --- a/docs/src/reference-dsl-builtin-functions.md +++ b/docs/src/reference-dsl-builtin-functions.md @@ -1006,7 +1006,7 @@ distinct_count([1,1.0]) is 2 ### kurtosis
-kurtosis  (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+kurtosis  (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 kurtosis([4,5,9,10,11]) is -1.6703688
 
@@ -1014,7 +1014,7 @@ kurtosis([4,5,9,10,11]) is -1.6703688 ### maxlen
-maxlen  (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+maxlen  (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 maxlen(["año", "alto"]) is 4
 
@@ -1022,7 +1022,7 @@ maxlen(["año", "alto"]) is 4 ### mean
-mean  (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types.
+mean  (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types.
 Example:
 mean([4,5,7,10]) is 6.5
 
@@ -1030,7 +1030,7 @@ mean([4,5,7,10]) is 6.5 ### meaneb
-meaneb  (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns "" AKA void for empty array/map; returns error for non-array/non-map types.
+meaneb  (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types.
 Example:
 meaneb([4,5,7,10]) is 1.3228756
 
@@ -1038,7 +1038,7 @@ meaneb([4,5,7,10]) is 1.3228756 ### median
-median  (class=stats #args=1,2) Returns the median of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs.
+median  (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs.
 Examples:
 median([3,4,5,6,9,10]) is 6
 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5
@@ -1048,7 +1048,7 @@ median(["abc", "def", "ghi", "ghi"]) is "ghi"
 
 ### minlen
 
-minlen  (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+minlen  (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 minlen(["año", "alto"]) is 3
 
@@ -1073,7 +1073,7 @@ null_count(["a", "", "c"]) is 1 ### percentile
-percentile  (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs.
+percentile  (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs.
 Examples:
 percentile([3,4,5,6,9,10], 90) is 10
 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5
@@ -1083,7 +1083,7 @@ percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi"
 
 ### percentiles
 
-percentiles  (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags.
+percentiles  (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags.
 Examples:
 
 Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort
@@ -1135,7 +1135,7 @@ You can also leverage this feature to compute percentiles on a sort of your choo
 
 ### skewness
 
-skewness  (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+skewness  (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 skewness([4,5,9,10,11]) is -0.2097285
 
@@ -1149,7 +1149,7 @@ sort_collection (class=stats #args=1) This is a helper function for the percent ### stddev
-stddev  (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+stddev  (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 stddev([4,5,9,10,11]) is 3.1144823
 
@@ -1189,7 +1189,7 @@ sum4([1,2,3,4,5]) is 979 ### variance
-variance  (class=stats #args=1) Returns the sample variance of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types.
+variance  (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types.
 Example:
 variance([4,5,9,10,11]) is 9.7
 
diff --git a/internal/pkg/dsl/cst/builtin_function_manager.go b/internal/pkg/dsl/cst/builtin_function_manager.go index 9b2b45a22..ef474345a 100644 --- a/internal/pkg/dsl/cst/builtin_function_manager.go +++ b/internal/pkg/dsl/cst/builtin_function_manager.go @@ -1174,8 +1174,7 @@ is normally distributed.`, hasMultipleArities: true, examples: []string{ ``, - `Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort`, - `the input before computing percentiles:`, + `Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort the input before computing percentiles:`, ``, ` percentiles([3,4,5,6,9,10], [25,75]) is { "25": 4, "75": 9 }`, ` percentiles(["abc", "def", "ghi", "ghi"], [25,75]) is { "25": "def", "75": "ghi" }`, @@ -1184,14 +1183,11 @@ is normally distributed.`, ``, ` percentiles([3,4,5,6,9,10], [25,75], {"output_array_not_map":true}) is [4, 9]`, ``, - `Use "interpolate_linearly" (or shorthand "il") to do linear interpolation -- note this produces`, - `,error on string inputs:`, + `Use "interpolate_linearly" (or shorthand "il") to do linear interpolation -- note this produces error values on string inputs:`, ``, ` percentiles([3,4,5,6,9,10], [25,75], {"interpolate_linearly":true}) is { "25": 4.25, "75": 8.25 }`, ``, - `The percentiles function always sorts its inputs before computing percentiles. If you know your input`, - `is already sorted -- see also the sort_collection function -- then computation will be faster on`, - `large input if you pass in "array_is_sorted":`, + `The percentiles function always sorts its inputs before computing percentiles. If you know your input is already sorted -- see also the sort_collection function -- then computation will be faster on large input if you pass in "array_is_sorted":`, ``, ` x = [6,5,9,10,4,3]`, ` percentiles(x, [25,75], {"array_is_sorted":true}) gives { "25": 5, "75": 4 } which is incorrect`, @@ -1203,8 +1199,7 @@ is normally distributed.`, ` Non-sorted input:`, ` x = splitax("the quick brown fox jumped loquaciously over the lazy dogs", " ")`, ` x is: ["the", "quick", "brown", "fox", "jumped", "loquaciously", "over", "the", "lazy", "dogs"]`, - ` Percentiles are taken over the original positions of the words in the array -- "dogs" is last`, - ` and hence appears as p99:`, + ` Percentiles are taken over the original positions of the words in the array -- "dogs" is last and hence appears as p99:`, ` percentiles(x, [50, 99], {"oa":true, "ais":true}) gives ["loquaciously", "dogs"]`, ` With sorting done inside percentiles, "the" is alphabetically last and is therefore the p99:`, ` percentiles(x, [50, 99], {"oa":true}) gives ["loquaciously", "the"]`, diff --git a/man/manpage.txt b/man/manpage.txt index 666177bee..290fa7c5d 100644 --- a/man/manpage.txt +++ b/man/manpage.txt @@ -2543,7 +2543,7 @@ MILLER(1) MILLER(1) (class=collections #args=1,2) Converts value to JSON-formatted string. Default output is single-line. With optional second boolean argument set to true, produces multiline output. 1mkurtosis0m - (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: kurtosis([4,5,9,10,11]) is -1.6703688 @@ -2618,7 +2618,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Max of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mmaxlen0m - (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: maxlen(["ao", "alto"]) is 4 @@ -2626,17 +2626,17 @@ MILLER(1) MILLER(1) (class=hashing #args=1) MD5 hash. 1mmean0m - (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: mean([4,5,7,10]) is 6.5 1mmeaneb0m - (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: meaneb([4,5,7,10]) is 1.3228756 1mmedian0m - (class=stats #args=1,2) Returns the median of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: median([3,4,5,6,9,10]) is 6 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5 @@ -2649,7 +2649,7 @@ MILLER(1) MILLER(1) (class=math #args=variadic) Min of n numbers; null loses. The min and max functions also recurse into arrays and maps, so they can be used to get min/max stats on array/map values. 1mminlen0m - (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: minlen(["ao", "alto"]) is 3 @@ -2700,14 +2700,14 @@ MILLER(1) MILLER(1) (class=system #args=0) Returns the operating-system name as a string. 1mpercentile0m - (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: percentile([3,4,5,6,9,10], 90) is 10 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5 percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi" 1mpercentiles0m - (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. + (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. Examples: Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort @@ -2852,7 +2852,7 @@ MILLER(1) MILLER(1) (class=math #args=1) Hyperbolic sine. 1mskewness0m - (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: skewness([4,5,9,10,11]) is -0.2097285 @@ -2914,7 +2914,7 @@ MILLER(1) MILLER(1) ssub("abc.def", ".", "X") gives "abcXdef" 1mstddev0m - (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: stddev([4,5,9,10,11]) is 3.1144823 @@ -3104,7 +3104,7 @@ MILLER(1) MILLER(1) $* = utf8_to_latin1($*) 1mvariance0m - (class=stats #args=1) Returns the sample variance of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: variance([4,5,9,10,11]) is 9.7 diff --git a/man/mlr.1 b/man/mlr.1 index 91d501b6b..c7313352b 100644 --- a/man/mlr.1 +++ b/man/mlr.1 @@ -3742,7 +3742,7 @@ joinv({"a":3,"b":4,"c":5}, ",") = "3,4,5" .RS 0 .\} .nf - (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample kurtosis of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: kurtosis([4,5,9,10,11]) is -1.6703688 .fi @@ -3931,7 +3931,7 @@ localtime2sec("2001-02-03 04:05:06", "Asia/Istanbul") = 981165906" .RS 0 .\} .nf - (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the maximum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: maxlen(["año", "alto"]) is 4 .fi @@ -3951,7 +3951,7 @@ maxlen(["año", "alto"]) is 4 .RS 0 .\} .nf - (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the arithmetic mean of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: mean([4,5,7,10]) is 6.5 .fi @@ -3962,7 +3962,7 @@ mean([4,5,7,10]) is 6.5 .RS 0 .\} .nf - (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. + (class=stats #args=1) Returns the error bar for arithmetic mean of values in an array or map, assuming the values are independent and identically distributed. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Example: meaneb([4,5,7,10]) is 1.3228756 .fi @@ -3973,7 +3973,7 @@ meaneb([4,5,7,10]) is 1.3228756 .RS 0 .\} .nf - (class=stats #args=1,2) Returns the median of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=1,2) Returns the median of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: median([3,4,5,6,9,10]) is 6 median([3,4,5,6,9,10],{"interpolate_linearly":true}) is 5.5 @@ -4004,7 +4004,7 @@ median(["abc", "def", "ghi", "ghi"]) is "ghi" .RS 0 .\} .nf - (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the minimum string length of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: minlen(["año", "alto"]) is 3 .fi @@ -4115,7 +4115,7 @@ null_count(["a", "", "c"]) is 1 .RS 0 .\} .nf - (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles for information on optional flags, and on performance for large inputs. + (class=stats #args=2,3) Returns the given percentile of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. Please see the percentiles function for information on optional flags, and on performance for large inputs. Examples: percentile([3,4,5,6,9,10], 90) is 10 percentile([3,4,5,6,9,10], 90, {"interpolate_linearly":true}) is 9.5 @@ -4128,7 +4128,7 @@ percentile(["abc", "def", "ghi", "ghi"], 90) is "ghi" .RS 0 .\} .nf - (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns "" AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. + (class=stats #args=2,3) Returns the given percentiles of values in an array or map. Returns empty string AKA void for empty array/map; returns error for non-array/non-map types. See examples for information on the three option flags. Examples: Defaults are to not interpolate linearly, to produce a map keyed by percentile name, and to sort @@ -4411,7 +4411,7 @@ Map example: select({"a":1, "b":3, "c":5}, func(k,v) {return v >= 3}) returns {" .RS 0 .\} .nf - (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample skewness of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: skewness([4,5,9,10,11]) is -0.2097285 .fi @@ -4539,7 +4539,7 @@ ssub("abc.def", ".", "X") gives "abcXdef" .RS 0 .\} .nf - (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample standard deviation of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: stddev([4,5,9,10,11]) is 3.1144823 .fi @@ -4975,7 +4975,7 @@ $* = utf8_to_latin1($*) .RS 0 .\} .nf - (class=stats #args=1) Returns the sample variance of values in an array or map. Returns "" AKA void for array/map of length less than two; returns error for non-array/non-map types. + (class=stats #args=1) Returns the sample variance of values in an array or map. Returns empty string AKA void for array/map of length less than two; returns error for non-array/non-map types. Example: variance([4,5,9,10,11]) is 9.7 .fi