Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
niekbouman authored Nov 6, 2018
1 parent e6c5ea5 commit 387037d
Showing 1 changed file with 15 additions and 6 deletions.
21 changes: 15 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,23 +16,32 @@ Example: below we have a collection of three point sets:
Save this in a file, and run `./iter <filename>`

## Options
The following options can be specified:
The following options can be specified in the JSON object:
- "iteration" : specify which iteration to use:
- "g" : the G-iteration (default)
- "G" : the convexified G-iteration
- "f" : the F-iteration
- "F" : the convexified F-iteration

For example,
```
{
"iteration":"G",
"point_sets":[...]
}
```
- "A" : the initial set to use

For example,
```
{
"A":[[1,1],[-1,1],[-1,-1],[1,-1]],
"point_sets":[...]
}
```
If "A" is omitted, the singleton set [0,0] is used for g and G iteration,
while the convex hull of the first point set is used for the f and F iterations.

- "digit_threshold" : threshold specifying how many digits the numerator or denominator of a vertex coordinate should have in order to enable coefficient rounding
- "rounding_error" : round a coordinate when it is within rounding_error from a small fraction

If "A" is omitted, the singleton set [0,0] is used for the "g" and "G" iterations,
while the convex hull of the first point set is used for the "f" and "F" iterations.

- "digit_threshold" : threshold specifying how many digits the numerator or denominator of a vertex coordinate should have in order to enable coefficient rounding (defaults to 10)
- "rounding_error" : round a coordinate when it is within rounding_error from a small fraction (defaults to 1e-8)

0 comments on commit 387037d

Please sign in to comment.