matthiasbeyer/imag
1
0
Fork 0
Code Releases Activity

doc: libimagutil: Add documentation of the generate_variants() util

Browse source
This commit is contained in:
Matthias Beyer 2016-02-21 20:17:27 +01:00
parent 6baa3c7f38
commit babb7b7055
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
doc/src/03000-lib-util.md
View file

@ -53,3 +53,19 @@ printing the error trace to the debug output stream.
[Error][a_errorkind]: Some A-error text [Error][a_errorkind]: Some A-error text
``` ```
## Variant generator {#sec:libutil:vargen}
The `generate_variants()` function can be used to generate variants of a base
vector value.
```{#lst:vargen:exampleuse .rust .numberLines caption="Variant generation"}
let base = 1;
let vars = vec![0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
let res = generate_variants(base, vars, &|base, var| base + var);
assert!(res == vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11])
```
As shown in @lst:vargen:exampleuse (from the tests), can this function
be used to generate values from a base value.