Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use technical term 'centrally symmetric' for 'point symmetric' #588

Merged
merged 2 commits into from
Aug 24, 2018
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 9 additions & 8 deletions docs/src/lib/interfaces.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,12 +58,12 @@ diameter(::LazySet, ::Real)
an_element(::LazySet{Real})
```

## Point symmetric set
## Centrally symmetric set

Point symmetric sets such as balls of different norms are characterized by a
Centrally symmetric sets such as balls of different norms are characterized by a
center.
Note that there is a special interface combination
[Point symmetric polytope](@ref).
[Centrally symmetric polytope](@ref).

```@docs
AbstractPointSymmetric
Expand All @@ -81,7 +81,7 @@ an_element(::AbstractPointSymmetric{N}) where {N<:Real}
A polytope has finitely many vertices (*V-representation*) resp. facets
(*H-representation*).
Note that there is a special interface combination
[Point symmetric polytope](@ref).
[Centrally symmetric polytope](@ref).

```@docs
AbstractPolytope
Expand Down Expand Up @@ -128,10 +128,10 @@ addconstraint!(::AbstractHPolygon{Real}, ::LinearConstraint{Real})
constraints_list(::AbstractHPolygon{Real})
```

### Point symmetric polytope
### Centrally symmetric polytope

A point symmetric polytope is a combination of two other interfaces:
[Point symmetric set](@ref) and [Polytope](@ref).
A centrally symmetric polytope is a combination of two other interfaces:
[Centrally symmetric set](@ref) and [Polytope](@ref).

```@docs
AbstractPointSymmetricPolytope
Expand All @@ -146,7 +146,8 @@ an_element(::AbstractPointSymmetricPolytope{N}) where {N<:Real}

#### Hyperrectangle

A hyperrectangle is a special point symmetric polytope with axis-aligned facets.
A hyperrectangle is a special centrally symmetric polytope with axis-aligned
facets.

```@docs
AbstractHyperrectangle
Expand Down
10 changes: 5 additions & 5 deletions src/AbstractPointSymmetric.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ export AbstractPointSymmetric,
"""
AbstractPointSymmetric{N<:Real} <: LazySet{N}

Abstract type for point symmetric sets.
Abstract type for centrally symmetric sets.

### Notes

Expand All @@ -27,7 +27,7 @@ abstract type AbstractPointSymmetric{N<:Real} <: LazySet{N} end
"""
dim(S::AbstractPointSymmetric)::Int

Return the ambient dimension of a point symmetric set.
Return the ambient dimension of a centrally symmetric set.

### Input

Expand All @@ -44,15 +44,15 @@ end
"""
an_element(S::AbstractPointSymmetric{N})::Vector{N} where {N<:Real}

Return some element of a point symmetric set.
Return some element of a centrally symmetric set.

### Input

- `S` -- point symmetric set
- `S` -- centrally symmetric set

### Output

The center of the point symmetric set.
The center of the centrally symmetric set.
"""
function an_element(S::AbstractPointSymmetric{N})::Vector{N} where {N<:Real}
return center(S)
Expand Down
10 changes: 5 additions & 5 deletions src/AbstractPointSymmetricPolytope.jl
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ export AbstractPointSymmetricPolytope,
"""
AbstractPointSymmetricPolytope{N<:Real} <: AbstractPolytope{N}

Abstract type for point symmetric, polytopic sets.
Abstract type for centrally symmetric, polytopic sets.
It combines the `AbstractPointSymmetric` and `AbstractPolytope` interfaces.
Such a type combination is necessary as long as Julia does not support
[multiple inheritance](https://github.com/JuliaLang/julia/issues/5).
Expand Down Expand Up @@ -42,7 +42,7 @@ abstract type AbstractPointSymmetricPolytope{N<:Real} <: AbstractPolytope{N} end
"""
dim(P::AbstractPointSymmetricPolytope)::Int

Return the ambient dimension of a point symmetric set.
Return the ambient dimension of a centrally symmetric set.

### Input

Expand All @@ -60,15 +60,15 @@ end
"""
an_element(P::AbstractPointSymmetricPolytope{N})::Vector{N} where {N<:Real}

Return some element of a point symmetric polytope.
Return some element of a centrally symmetric polytope.

### Input

- `P` -- point symmetric polytope
- `P` -- centrally symmetric polytope

### Output

The center of the point symmetric polytope.
The center of the centrally symmetric polytope.
"""
function an_element(P::AbstractPointSymmetricPolytope{N}
)::Vector{N} where {N<:Real}
Expand Down