From 5a387303a61bb82604e0137eaadcf4c1074615d7 Mon Sep 17 00:00:00 2001 From: schillic Date: Wed, 6 Mar 2019 12:27:15 +0100 Subject: [PATCH] revise docstrings --- src/Ellipsoid.jl | 2 +- src/HPolygon.jl | 3 ++- src/HPolygonOpt.jl | 3 ++- src/HPolyhedron.jl | 3 ++- src/HalfSpace.jl | 3 ++- src/Hyperplane.jl | 3 ++- src/Hyperrectangle.jl | 2 +- src/Line.jl | 3 ++- src/Zonotope.jl | 2 +- 9 files changed, 15 insertions(+), 9 deletions(-) diff --git a/src/Ellipsoid.jl b/src/Ellipsoid.jl index 577f9a5213..85babb7a70 100644 --- a/src/Ellipsoid.jl +++ b/src/Ellipsoid.jl @@ -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 diff --git a/src/HPolygon.jl b/src/HPolygon.jl index bd5282355f..d8a14c2a60 100644 --- a/src/HPolygon.jl +++ b/src/HPolygon.jl @@ -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 diff --git a/src/HPolygonOpt.jl b/src/HPolygonOpt.jl index c6f58f0673..12eb74bcd2 100644 --- a/src/HPolygonOpt.jl +++ b/src/HPolygonOpt.jl @@ -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 diff --git a/src/HPolyhedron.jl b/src/HPolyhedron.jl index eb8c110a41..b724d9b63e 100644 --- a/src/HPolyhedron.jl +++ b/src/HPolyhedron.jl @@ -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 diff --git a/src/HalfSpace.jl b/src/HalfSpace.jl index 1bc2849275..9ceb4771b0 100644 --- a/src/HalfSpace.jl +++ b/src/HalfSpace.jl @@ -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 diff --git a/src/Hyperplane.jl b/src/Hyperplane.jl index cf9b143db6..19cfe575b0 100644 --- a/src/Hyperplane.jl +++ b/src/Hyperplane.jl @@ -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 diff --git a/src/Hyperrectangle.jl b/src/Hyperrectangle.jl index 431ea0ffa9..cdc7d5cc36 100644 --- a/src/Hyperrectangle.jl +++ b/src/Hyperrectangle.jl @@ -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 diff --git a/src/Line.jl b/src/Line.jl index 7d1f23ccd1..77f95ca1a4 100644 --- a/src/Line.jl +++ b/src/Line.jl @@ -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 diff --git a/src/Zonotope.jl b/src/Zonotope.jl index 3599ca4dbb..b816f03d2c 100644 --- a/src/Zonotope.jl +++ b/src/Zonotope.jl @@ -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