Skip to content

Commit

Permalink
fix documentation generation
Browse files Browse the repository at this point in the history
  • Loading branch information
paraynaud committed Apr 19, 2024
1 parent f42176f commit 67197bf
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
6 changes: 3 additions & 3 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"

[compat]
Documenter = "~0.25"
JuMP = "1.1.1"
MathOptInterface = "1.7.0"
Symbolics = "4.10.4"
JuMP = "1.1.1 - 1.8"
MathOptInterface = "1.7 - 1.27"
Symbolics = "4.10.4 - 5.1"
16 changes: 8 additions & 8 deletions docs/src/tutorial.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,33 +116,33 @@ To compute bounds and convexity we use a `Complete_expr_tree`, a richer structur
`Complete_expr_tree` is similar to `Type_expr_tree`, but in addition it stores: the lower bound, the upper bound and the convexity status of each node.
You can define a `Complete_expr_tree` for any `Type_expr_tree`:
```@example ExpressionTreeForge
complete_tree = complete_tree(expr_tree_Expr)
complete_tree_from_Expr = complete_tree(expr_tree_Expr)
```
The bounds and convexity status are then propagated using the methods:
```@example ExpressionTreeForge
# propagate the bounds from the variables
set_bounds!(complete_tree)
set_bounds!(complete_tree_from_Expr)
# deduce the convexity status of each node
set_convexity!(complete_tree)
set_convexity!(complete_tree_from_Expr)
```
```@example ExpressionTreeForge
# get the root bounds
bounds = get_bounds(complete_tree)
bounds = get_bounds(complete_tree_from_Expr)
```

```@example ExpressionTreeForge
# get the root convexity status
convexity_status = get_convexity_status(complete_tree)
convexity_status = get_convexity_status(complete_tree_from_Expr)
is_convex(convexity_status)
```

You can observe the bounds and convexity status of each node of `complete_tree` by walking the graph
You can observe the bounds and convexity status of each node of `complete_tree_from_Expr` by walking the graph
```@example ExpressionTreeForge
# convexity statuses of the root's children
statuses = get_convexity_status.(complete_tree.children)
statuses = get_convexity_status.(complete_tree_from_Expr.children)
```

```@example ExpressionTreeForge
# bounds of the root's children
bounds = get_bounds.(complete_tree.children)
bounds = get_bounds.(complete_tree_from_Expr.children)
```

0 comments on commit 67197bf

Please sign in to comment.