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.

Sign up for GitHub

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

#2006 - Add type parameters to Ellipsoid #2031

Merged
merged 2 commits into from
Mar 1, 2020
Merged

#2006 - Add type parameters to Ellipsoid #2031

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
49ebf8d
add type parameters to ellipsoid
mforets Feb 29, 2020
4386188
Update src/Sets/Ellipsoid.jl
mforets Feb 29, 2020
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
30 changes: 17 additions & 13 deletions src/Sets/Ellipsoid.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ export Ellipsoid,
shape_matrix

"""
Ellipsoid{N<:AbstractFloat} <: AbstractCentrallySymmetric{N}
Ellipsoid{N<:AbstractFloat, VN<:AbstractVector{N},
MN<:AbstractMatrix{N}} <: AbstractCentrallySymmetric{N}

Type that represents an ellipsoid.

Expand Down Expand Up @@ -37,20 +38,20 @@ positive definite).

For instance, we create a two-dimensional ellipsoid with center `[1, 1]`:

```julia
```jldoctest ellipsoid_constructor
julia> using LinearAlgebra

julia> E = Ellipsoid(ones(2), Diagonal([2.0, 0.5]))
Ellipsoid{Float64}([1.0, 1.0], [2.0 0.0; 0.0 0.5])
Ellipsoid{Float64,Array{Float64,1},Diagonal{Float64,Array{Float64,1}}}([1.0, 1.0], [2.0 0.0; 0.0 0.5])
```

If the center is not specified, it is assumed that it is the origin. For instance,
a three-dimensional ellipsoid centered at the origin and the shape matrix being
the identity can be created with:

```jldoctest ellipsoid_constructor
julia> using LinearAlgebra

julia> E = Ellipsoid(Matrix(1.0I, 3, 3))
Ellipsoid{Float64}([0.0, 0.0, 0.0], [1.0 0.0 0.0; 0.0 1.0 0.0; 0.0 0.0 1.0])
Ellipsoid{Float64,Array{Float64,1},Array{Float64,2}}([0.0, 0.0, 0.0], [1.0 0.0 0.0; 0.0 1.0 0.0; 0.0 0.0 1.0])

julia> dim(E)
3
Expand Down Expand Up @@ -95,14 +96,16 @@ julia> σ(ones(3), E)
0.5773502691896258
```
"""
struct Ellipsoid{N<:AbstractFloat} <: AbstractCentrallySymmetric{N}
center::AbstractVector{N}
shape_matrix::AbstractMatrix{N}
struct Ellipsoid{N<:AbstractFloat, VN<:AbstractVector{N},
MN<:AbstractMatrix{N}} <: AbstractCentrallySymmetric{N}
center::VN
shape_matrix::MN

# default constructor with dimension check
function Ellipsoid(c::AbstractVector{N},
Q::AbstractMatrix{N};
check_posdef::Bool=true) where {N<:AbstractFloat}
function Ellipsoid(c::VN, Q::MN;
check_posdef::Bool=true) where {N<:AbstractFloat,
VN<:AbstractVector{N},
MN<:AbstractMatrix{N}}

@assert length(c) == checksquare(Q) "the length of the center and the size "
"of the shape matrix do not match; they are $(length(c)) and $(size(Q)) respectively"
Expand All @@ -111,7 +114,7 @@ struct Ellipsoid{N<:AbstractFloat} <: AbstractCentrallySymmetric{N}
isposdef(Q) || throw(ArgumentError("an ellipsoid's shape matrix " *
"must be positive definite"))
end
return new{N}(c, Q)
return new{N, VN, MN}(c, Q)
end
end

Expand All @@ -120,6 +123,7 @@ isconvextype(::Type{<:Ellipsoid}) = true

# convenience constructor for ellipsoid centered in the origin
function Ellipsoid(Q::AbstractMatrix{N}; check_posdef::Bool=true) where {N<:AbstractFloat}
# TODO: use similar vector type for the center, see #2032
return Ellipsoid(zeros(N, size(Q, 1)), Q; check_posdef=check_posdef)
end

Expand Down