Merge pull request #141 from JuliaApproximation/newinterface

Implementing domains as an interface

Project.toml

@@ -1,6 +1,6 @@
 name = "DomainSets"
 uuid = "5b8099bc-c8ec-5219-889f-1d9e522a28bf"
-version = "0.6.7"
+version = "0.7.0"
 
 [deps]
 CompositeTypes = "b152e2b5-7a66-4b01-a709-34e65c35f657"
@@ -11,15 +11,15 @@ StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
 
 [compat]
+julia = "1.6"
 CompositeTypes = "0.1.2"
 IntervalSets = "0.7.4"
-StaticArrays = "0.12.2, 1"
 StableRNGs = "1"
-julia = "1.6"
+StaticArrays = "0.12.2, 1"
 
 [extras]
-Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 StableRNGs = "860ef19b-820b-49d6-a774-d7a799459cd3"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
 test = ["Test", "StableRNGs"]

src/DomainSets.jl

@@ -43,7 +43,6 @@ export ..
 
 import CompositeTypes: component, components
 
-
 ################################
 ## Exhaustive list of exports
 ################################
@@ -81,14 +80,16 @@ export AffineMap, Translation, LinearMap,
 
 ## Generic domains
 
+@deprecate point_in_domain(d) choice(d)
+
 # from generic/domain.jl
 export Domain, EuclideanDomain, VectorDomain,
     dimension,
     approx_in,
     isopenset, isclosedset, iscompact,
     boundary, ∂,
     interior, closure,
-    point_in_domain
+    choice
 
 # from generic/geometry.jl
 export boundingbox,
@@ -192,6 +193,7 @@ include("maps/basic.jl")
 include("maps/affine.jl")
 include("maps/arithmetics.jl")
 
+include("generic/core.jl")
 include("generic/domain.jl")
 include("generic/geometry.jl")
 include("generic/canonical.jl")

src/domains/ball.jl

@@ -56,7 +56,7 @@ isequaldomain(d1::Ball, d2::Ball) = isclosedset(d1)==isclosedset(d2) &&
     radius(d1)==radius(d2) && center(d1)==center(d2)
 hash(d::Ball, h::UInt) = hashrec("Ball", isclosedset(d), radius(d), center(d), h)
 
-function issubset(d1::Ball, d2::Ball)
+function issubset_domain(d1::Ball, d2::Ball)
     if dimension(d1) == dimension(d2)
         if center(d1) == center(d2)
             if radius(d1) < radius(d2)
@@ -84,7 +84,7 @@ normal(d::Ball, x) = normal(boundary(d), x)
 distance_to(d::Ball, x) = x ∈ d ? zero(prectype(d)) : norm(x-center(d))-radius(d)
 
 # We choose the center of the ball here. Concrete types should implement 'center'
-point_in_domain(d::Ball) = center(d)
+choice(d::Ball) = center(d)
 
 
 "The unit ball."
@@ -119,7 +119,7 @@ approx_indomain(x, d::ClosedUnitBall, tolerance) = norm(x) <= 1+tolerance
 isequaldomain(d1::UnitBall, d2::UnitBall) = isclosedset(d1)==isclosedset(d2) &&
     dimension(d1) == dimension(d2)
 
-issubset(d1::UnitBall, d2::UnitBall) =
+issubset_domain(d1::UnitBall, d2::UnitBall) =
     dimension(d1) == dimension(d2) && (isclosedset(d2) || isopenset(d1))
 
 convert(::Type{SublevelSet}, d::UnitBall{T,C}) where {T,C} =
@@ -304,7 +304,7 @@ normal(d::Sphere, x) = (x-center(d))/norm(x-center(d))
 
 distance_to(d::Sphere, x) = abs(norm(x-center(d))-radius(d))
 
-point_in_domain(d::Sphere) = center(d) + unitvector(d, 1)
+choice(d::Sphere) = center(d) + unitvector(d, 1)
 
 isequaldomain(d1::Sphere, d2::Sphere) =
     radius(d1)==radius(d2) && center(d1)==center(d2)

src/domains/boundingbox.jl

@@ -3,52 +3,54 @@ boundingbox(d::Vector{T}) where {T <: Number} = minimum(d)..maximum(d)
 boundingbox(d::Set{T}) where {T<:Number} = minimum(d)..maximum(d)
 
 "Return the bounding box of the union of two or more bounding boxes."
-unionbox(d::Domain) = d
-unionbox(d1::Domain, d2::Domain) = unionbox(promote_domains(d1, d2)...)
-unionbox(d1::Domain, d2::Domain, domains...) =
+unionbox(d) = d
+unionbox(d1, d2) = unionbox1(promote_domains(d1, d2)...)
+unionbox(d1, d2, domains...) =
     unionbox(unionbox(d1,d2), domains...)
-
-unionbox(d1::Domain{T}, d2::Domain{T}) where {T} = unionbox1(d1, d2)
 unionbox1(d1, d2) = unionbox2(d1, d2)
 unionbox2(d1, d2) = fullspace(d1)
 unionbox1(d1::EmptySpace, d2) = d2
 unionbox1(d1::FullSpace, d2) = d1
 unionbox2(d1, d2::EmptySpace) = d1
 unionbox2(d1, d2::FullSpace) = d2
 
-unionbox(d1::D, d2::D) where {D<:FixedInterval} = d1
+unionbox1(d1::D, d2::D) where {D<:FixedInterval} = d1
 
-function unionbox(d1::AbstractInterval{T}, d2::AbstractInterval{T}) where {T}
+function unionbox1(d1::AbstractInterval, d2::AbstractInterval)
     a, b = endpoints(d1)
     c, d = endpoints(d2)
     A = min(a, c)
     B = max(b, d)
-    isinf(A) && isinf(B) ? fullspace(T) : A..B
+    isinf(A) && isinf(B) ? fullspace(d1) : A..B
 end
 
-unionbox(d1::HyperRectangle{T}, d2::HyperRectangle{T}) where {T} =
+function unionbox(d1::HyperRectangle, d2::HyperRectangle)
+    @assert dimension(d1) == dimension(d2)
+    T = promote_type(eltype(d1),eltype(d2))
     Rectangle{T}(map(unionbox, components(d1), components(d2)))
+end
 
 "Return the bounding box of the intersection of two or more bounding boxes."
-intersectbox(d::Domain) = d
-intersectbox(d1::Domain, d2::Domain) = intersectbox(promote_domains(d1, d2)...)
-intersectbox(d1::Domain, d2::Domain, domains...) =
+intersectbox(d) = d
+intersectbox(d1, d2) = intersectbox1(promote_domains(d1, d2)...)
+intersectbox(d1, d2, domains...) =
     intersectbox(intersectbox(d1,d2), domains...)
 
-intersectbox(d1::Domain{T}, d2::Domain{T}) where {T} = intersectbox1(d1, d2)
 intersectbox1(d1, d2) = intersectbox2(d1, d2)
 intersectbox2(d1, d2) = fullspace(d1)
 intersectbox1(d1::EmptySpace, d2) = d1
 intersectbox1(d1::FullSpace, d2) = d2
 intersectbox2(d1, d2::EmptySpace) = d2
 intersectbox2(d1, d2::FullSpace) = d1
 
-intersectbox(d1::D, d2::D) where {D<:FixedInterval} = d1
+intersectbox1(d1::D, d2::D) where {D<:FixedInterval} = d1
 
-intersectbox(d1::AbstractInterval{T}, d2::AbstractInterval{T}) where {T} =
+intersectbox1(d1::AbstractInterval, d2::AbstractInterval) =
     intersectdomain(d1, d2)
 
-function intersectbox(d1::HyperRectangle{T}, d2::HyperRectangle{T}) where {T}
+function intersectbox1(d1::HyperRectangle, d2::HyperRectangle)
+    @assert dimension(d1) == dimension(d2)
+    T = eltype(d1)
     d = Rectangle{T}(map(intersectbox, components(d1), components(d2)))
     isempty(d) ? emptyspace(d) : d
 end

src/domains/cube.jl

@@ -351,8 +351,8 @@ ProductDomain(domains::NTuple{N,D}) where {N,D <: FixedInterval} =
 ProductDomain(domains::SVector{N,<:FixedInterval}) where {N} =
 	FixedIntervalProduct(domains)
 ProductDomain{T}(domains::D...) where {N,S,T<:SVector{N,S},D <: FixedInterval} =
-	FixedIntervalProduct(convert.(Ref(Domain{S}), domains))
+	FixedIntervalProduct(convert_eltype.(Ref(S), domains))
 ProductDomain{T}(domains::NTuple{N,D}) where {N,S,T<:SVector{N,S},D <: FixedInterval} =
-	FixedIntervalProduct(convert.(Ref(Domain{S}), domains))
+	FixedIntervalProduct(convert_eltype.(Ref(S), domains))
 ProductDomain{T}(domains::SVector{N,<:FixedInterval}) where {N,T<:SVector{N}} =
 	FixedIntervalProduct(domains)

src/domains/indicator.jl

@@ -13,7 +13,7 @@ implementing `in` directly.
 abstract type AbstractIndicatorFunction{T} <: Domain{T} end
 
 "The indicator function of a domain is the function `f(x) = x ∈ D`."
-indicatorfunction(d::Domain) = x -> x ∈ d
+indicatorfunction(d) = x -> x ∈ d
 
 indomain(x, d::AbstractIndicatorFunction) = _indomain(x, d, indicatorfunction(d))
 _indomain(x, d::AbstractIndicatorFunction, f) = f(x)
@@ -35,8 +35,8 @@ indicatorfunction(d::IndicatorFunction) = d.f
 similardomain(d::IndicatorFunction, ::Type{T}) where {T} = IndicatorFunction{T}(d.f)
 
 convert(::Type{IndicatorFunction}, d::AbstractIndicatorFunction) = d
-convert(::Type{IndicatorFunction}, d::Domain{T}) where {T} =
-    IndicatorFunction{T}(indicatorfunction(d))
+convert(::Type{IndicatorFunction}, d) =
+    IndicatorFunction{domaineltype(d)}(indicatorfunction(checkdomain(d)))
 
 isequaldomain(d1::IndicatorFunction, d2::IndicatorFunction) =
     indicatorfunction(d1)==indicatorfunction(d2)
@@ -45,18 +45,19 @@ intersectdomain1(d1::IndicatorFunction, d2) = BoundedIndicatorFunction(d1.f, d2)
 intersectdomain2(d1, d2::IndicatorFunction) = BoundedIndicatorFunction(d2.f, d1)
 
 "An indicator function with a known bounding domain."
-struct BoundedIndicatorFunction{F,D,T} <: AbstractIndicatorFunction{T}
+struct BoundedIndicatorFunction{T,F,D} <: AbstractIndicatorFunction{T}
     f       ::  F
     domain  ::  D
 end
 
-BoundedIndicatorFunction(f, domain::Domain{T}) where {T} =
-    BoundedIndicatorFunction{typeof(f),typeof(domain),T}(f, domain)
-
-function BoundedIndicatorFunction(f, domain)
-    T = eltype(domain)
-    BoundedIndicatorFunction{typeof(f),typeof(domain),T}(f, domain)
-end
+BoundedIndicatorFunction(f, domain) =
+    BoundedIndicatorFunction{domaineltype(domain)}(f, domain)
+BoundedIndicatorFunction{T}(f, domain::Domain{T}) where {T} =
+    BoundedIndicatorFunction{T,typeof(f),typeof(domain)}(f, domain)
+BoundedIndicatorFunction{T}(f, domain) where {T} =
+    _BoundedIndicatorFunction(T, f, checkdomain(domain))
+_BoundedIndicatorFunction(::Type{T}, f, domain) where {T} =
+    BoundedIndicatorFunction{T,typeof(f),typeof(domain)}(f, domain)
 
 indicatorfunction(d::BoundedIndicatorFunction) = d.f
 
@@ -70,7 +71,7 @@ hash(d::BoundedIndicatorFunction, h::UInt) =
     hashrec(indicatorfunction(d), boundingdomain(d), h)
 
 similardomain(d::BoundedIndicatorFunction, ::Type{T}) where {T} =
-    BoundedIndicatorFunction(d.f, convert(Domain{T}, d.domain))
+    BoundedIndicatorFunction(d.f, convert_eltype(T, d.domain))
 
 boundingbox(d::BoundedIndicatorFunction) = boundingbox(boundingdomain(d))
 

src/domains/interval.jl

@@ -2,7 +2,7 @@
 iscompact(d::TypedEndpointsInterval{:closed,:closed}) = true
 iscompact(d::TypedEndpointsInterval) = false
 
-isinterval(d::Domain) = false
+isinterval(d) = false
 isinterval(d::AbstractInterval) = true
 
 hash(d::AbstractInterval, h::UInt) =
@@ -23,15 +23,15 @@ approx_indomain(x, d::TypedEndpointsInterval{:open,:open}, tolerance) =
     (x > leftendpoint(d)-tolerance) && (x < rightendpoint(d)+tolerance)
 
 
-function point_in_domain(d::AbstractInterval)
+function choice(d::AbstractInterval)
     isempty(d) && throw(BoundsError())
     mean(d)
 end
 
 center(d::AbstractInterval) = mean(d)
 
 # For an interval of integers, try to find an integer point
-function point_in_domain(d::AbstractInterval{T}) where {T<:Integer}
+function choice(d::AbstractInterval{T}) where {T<:Integer}
     isempty(d) && throw(BoundsError())
     x = round(T, mean(d))
     if x ∈ d
@@ -54,9 +54,9 @@ end
 boundary(d::AbstractInterval) = Point(leftendpoint(d)) ∪ Point(rightendpoint(d))
 corners(d::AbstractInterval) = [leftendpoint(d), rightendpoint(d)]
 
-normal(d::AbstractInterval, x) = (abs(minimum(d)-x) < abs(maximum(d)-x)) ? -one(eltype(d)) : one(eltype(d))
+normal(d::AbstractInterval, x) = (abs(minimum(d)-x) < abs(maximum(d)-x)) ? -one(domaineltype(d)) : one(domaineltype(d))
 
-distance_to(d::AbstractInterval, x) = x ∈ d ? zero(eltype(d)) : min(abs(x-supremum(d)), abs(x-infimum(d)))
+distance_to(d::AbstractInterval, x) = x ∈ d ? zero(domaineltype(d)) : min(abs(x-supremum(d)), abs(x-infimum(d)))
 
 boundingbox(d::AbstractInterval) = d
 
@@ -79,6 +79,10 @@ and `ChebyshevInterval`.
 abstract type FixedInterval{L,R,T} <: TypedEndpointsInterval{L,R,T} end
 const ClosedFixedInterval{T} = FixedInterval{:closed,:closed,T}
 
+convert(::Type{AbstractInterval{T}}, d::FixedInterval{L,R,T}) where {L,R,T} = d
+convert(::Type{AbstractInterval{T}}, d::FixedInterval{L,R,S}) where {L,R,S,T} =
+    similardomain(d, T)
+
 closure(d::AbstractInterval) = ClosedInterval(endpoints(d)...)
 closure(d::ClosedInterval) = d
 
@@ -244,8 +248,8 @@ function similar_interval(d::HalfLine{T,C}, a::S, b::S) where {T,S,C}
     HalfLine{promote_type(float(T),S),C}()
 end
 
-point_in_domain(d::NonnegativeRealLine) = zero(eltype(d))
-point_in_domain(d::PositiveRealLine) = one(eltype(d))
+choice(d::NonnegativeRealLine) = zero(domaineltype(d))
+choice(d::PositiveRealLine) = one(domaineltype(d))
 
 
 "The negative halfline `(-∞,0]` or `(-∞,0)`, right-closed or right-open."
@@ -276,15 +280,15 @@ function similar_interval(d::NegativeHalfLine{T,C}, a::S, b::S) where {S,T,C}
     NegativeHalfLine{promote_type(S,float(T)),C}()
 end
 
-point_in_domain(d::NegativeRealLine) = -one(eltype(d))
-point_in_domain(d::NonpositiveRealLine) = zero(eltype(d))
+choice(d::NegativeRealLine) = -one(domaineltype(d))
+choice(d::NonpositiveRealLine) = zero(domaineltype(d))
 
 
 "The real line `(-∞,∞)`."
 struct RealLine{T} <: FixedInterval{:open,:open,T} end
 RealLine() = RealLine{Float64}()
 
-point_in_domain(d::RealLine) = zero(eltype(d))
+choice(d::RealLine) = zero(eltype(d))
 
 similardomain(::RealLine, ::Type{T}) where {T} = RealLine{T}()
 
@@ -318,11 +322,11 @@ intersect(d1::FixedInterval, d2::FixedInterval) = intersectdomain(d1, d2)
 
 # Promotion to joint type T
 uniondomain(d1::TypedEndpointsInterval, d2::TypedEndpointsInterval) =
-    uniondomain(promote(d1,d2)...)
+    uniondomain(promote_domains(d1,d2)...)
 intersectdomain(d1::TypedEndpointsInterval, d2::TypedEndpointsInterval) =
-    intersectdomain(promote(d1,d2)...)
+    intersectdomain(promote_domains(d1,d2)...)
 setdiffdomain(d1::AbstractInterval, d2::AbstractInterval) =
-    setdiffdomain(promote(d1,d2)...)
+    setdiffdomain(promote_domains(d1,d2)...)
 
 
 

src/domains/point.jl

@@ -48,7 +48,7 @@ supremum(d::Point) = pointval(d)
 interior(d::Point) = emptyspace(d)
 closure(d::Point) = d
 
-point_in_domain(d::Point) = pointval(d)
+choice(d::Point) = pointval(d)
 
 distance_to(d::Point, x) = norm(x-pointval(d))
 

src/domains/simplex.jl

@@ -143,7 +143,7 @@ closure(d::VectorUnitSimplex{T}) where {T} = VectorUnitSimplex{T,:closed}(dimens
 
 # We pick the center point, because it belongs to the domain regardless of
 # whether it is open or closed.
-point_in_domain(d::UnitSimplex) = center(d)
+choice(d::UnitSimplex) = center(d)
 
 similardomain(d::StaticUnitSimplex{S,C}, ::Type{T}) where {S,T,C} =
     StaticUnitSimplex{T,C}()

src/domains/trivial.jl

@@ -13,7 +13,7 @@ EmptySpace(::Type{T}) where {T} = EmptySpace{T}()
 similardomain(::EmptySpace, ::Type{T}) where {T} = EmptySpace{T}()
 
 "Return the empty space with the same element type as the given domain."
-emptyspace(d) = emptyspace(eltype(d))
+emptyspace(d) = emptyspace(domaineltype(d))
 emptyspace(::Type{T}) where {T} = EmptySpace{T}()
 
 indomain(x::T, d::EmptySpace{T}) where {T} = false
@@ -64,14 +64,17 @@ struct FullSpace{T} <: Domain{T} end
 const AnyFullSpace = FullSpace{Any}
 
 FullSpace() = FullSpace{Float64}()
-FullSpace(d) = FullSpace{eltype(d)}()
+FullSpace(d) = FullSpace{domaineltype(d)}()
 
 "Return the full space with the same element type as the given domain."
-fullspace(d) = fullspace(eltype(d))
+fullspace(d) = fullspace(domaineltype(d))
 fullspace(::Type{T}) where {T} = FullSpace{T}()
 
 isfullspace(d::FullSpace) = true
 isfullspace(d::Domain) = false
+isfullspace(d) = _isfullspace(d, DomainStyle(d))
+_isfullspace(d, ::IsDomain) = false
+_isfullspace(d, ::NotDomain) = error("isfullspace invoked on non-domain type")
 
 similardomain(::FullSpace, ::Type{T}) where {T} = FullSpace{T}()
 
@@ -84,7 +87,7 @@ approx_indomain(x, d::FullSpace, tolerance) = in(x, d)
 show(io::IO, d::FullSpace) = print(io, "{x} (full space)")
 
 # We choose the origin as a point in the full space
-point_in_domain(d::FullSpace) = zero(eltype(d))
+choice(d::FullSpace) = zero(eltype(d))
 
 isempty(::FullSpace) = false
 
@@ -125,7 +128,7 @@ type `T`.
 struct TypeDomain{T} <: Domain{T} end
 
 "Return the domain for the element type of the given domain."
-typedomain(d) = typedomain(eltype(d))
+typedomain(d) = typedomain(domaineltype(d))
 typedomain(::Type{T}) where {T} = TypeDomain{T}()
 
 iscompatiblepair(x::T, d::TypeDomain{T}) where {T} = true