Skip to content

Commit

Permalink
revise docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
schillic committed Mar 6, 2019
1 parent 363819a commit 5a38730
Show file tree
Hide file tree
Showing 9 changed files with 15 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/Ellipsoid.jl
Original file line number Diff line number Diff line change
Expand Up @@ -251,7 +251,7 @@ A translated ellipsoid.
### Notes
The shape matrix is shared with the original ellipsoid.
The shape matrix is shared with the original ellipsoid if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/HPolygon.jl
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,8 @@ A translated polygon in constraint representation.
### Notes
The `a` vectors of the constraints are shared with the original constraints.
The normal vectors of the constraints (vector `a` in `a⋅x ≤ b`) are shared with
the original constraints if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/HPolygonOpt.jl
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,8 @@ A translated optimized polygon in constraint representation.
### Notes
The `a` vectors of the constraints are shared with the original constraints.
The normal vectors of the constraints (vector `a` in `a⋅x ≤ b`) are shared with
the original constraints if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/HPolyhedron.jl
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,8 @@ A translated polyhedron in constraint representation.
### Notes
The `a` vectors of the constraints are shared with the original constraints.
The normal vectors of the constraints (vector `a` in `a⋅x ≤ b`) are shared with
the original constraints if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/HalfSpace.jl
Original file line number Diff line number Diff line change
Expand Up @@ -441,7 +441,8 @@ A translated half-space.
### Notes
The `a` vector is shared with the original half-space.
The normal vectors of the halfspace (vector `a` in `a⋅x ≤ b`) is shared with the
original halfspace if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/Hyperplane.jl
Original file line number Diff line number Diff line change
Expand Up @@ -420,7 +420,8 @@ A translated hyperplane.
### Notes
The `a` vector is shared with the original hyperplane.
The normal vectors of the hyperplane (vector `a` in `a⋅x = b`) is shared with
the original hyperplane if `share == true`.
### Algorithm
Expand Down
2 changes: 1 addition & 1 deletion src/Hyperrectangle.jl
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ A translated hyperrectangle.
### Notes
The radius vector is shared with the original hyperrectangle.
The radius vector is shared with the original hyperrectangle if `share == true`.
### Algorithm
Expand Down
3 changes: 2 additions & 1 deletion src/Line.jl
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,8 @@ A translated line.
### Notes
The `a` vector is shared with the original line.
The normal vector of the line (vector `a` in `a⋅x = b`) is shared with the
original line if `share == true`.
### Algorithm
Expand Down
2 changes: 1 addition & 1 deletion src/Zonotope.jl
Original file line number Diff line number Diff line change
Expand Up @@ -610,7 +610,7 @@ A translated zonotope.
### Notes
The generator matrix is shared with the original zonotope.
The generator matrix is shared with the original zonotope if `share == true`.
### Algorithm
Expand Down

0 comments on commit 5a38730

Please sign in to comment.