Euclidean-norm ball (Ball2)
LazySets.Ball2
— TypeBall2{N<:AbstractFloat, VN<:AbstractVector{N}} <: AbstractCentrallySymmetric{N}
Type that represents a ball in the 2-norm.
Fields
center
– center of the ball as a real vectorradius
– radius of the ball as a real scalar ($≥ 0$)
Notes
Mathematically, a ball in the 2-norm is defined as the set
\[\mathcal{B}_2^n(c, r) = \{ x ∈ \mathbb{R}^n : ‖ x - c ‖_2 ≤ r \},\]
where $c ∈ \mathbb{R}^n$ is its center and $r ∈ \mathbb{R}_+$ its radius. Here $‖ ⋅ ‖_2$ denotes the Euclidean norm (also known as 2-norm), defined as $‖ x ‖_2 = \left( \sum\limits_{i=1}^n |x_i|^2 \right)^{1/2}$ for any $x ∈ \mathbb{R}^n$.
Examples
Create a five-dimensional ball B
in the 2-norm centered at the origin with radius 0.5:
julia> B = Ball2(zeros(5), 0.5)
Ball2{Float64,Array{Float64,1}}([0.0, 0.0, 0.0, 0.0, 0.0], 0.5)
julia> dim(B)
5
Evaluate B
's support vector in the direction $[1,2,3,4,5]$:
julia> σ([1.,2.,3.,4.,5.], B)
5-element Array{Float64,1}:
0.06741998624632421
0.13483997249264842
0.20225995873897262
0.26967994498529685
0.3370999312316211
LazySets.ρ
— Methodρ(d::AbstractVector, B::Ball2)
Return the support function of a 2-norm ball in a given direction.
Input
d
– directionB
– ball in the 2-norm
Output
The support function in the given direction.
Notes
Let $c$ and $r$ be the center and radius of the ball $B$ in the 2-norm, respectively. Then:
\[ρ(d, B) = ⟨d, c⟩ + r ‖d‖_2.\]
LazySets.σ
— Methodσ(d::AbstractVector, B::Ball2)
Return the support vector of a 2-norm ball in a given direction.
Input
d
– directionB
– ball in the 2-norm
Output
The support vector in the given direction. If the direction has norm zero, the origin is returned.
Notes
Let $c$ and $r$ be the center and radius of a ball $B$ in the 2-norm, respectively. For nonzero direction $d$ we have
\[σ_B(d) = c + r \frac{d}{‖d‖_2}.\]
This function requires computing the 2-norm of the input direction, which is performed in the given precision of the numeric datatype of both the direction and the set. Exact inputs are not supported.
Base.:∈
— Method∈(x::AbstractVector, B::Ball2)
Check whether a given point is contained in a ball in the 2-norm.
Input
x
– point/vectorB
– ball in the 2-norm
Output
true
iff $x ∈ B$.
Notes
This implementation is worst-case optimized, i.e., it is optimistic and first computes (see below) the whole sum before comparing to the radius. In applications where the point is typically far away from the ball, a fail-fast implementation with interleaved comparisons could be more efficient.
Algorithm
Let $B$ be an $n$-dimensional ball in the 2-norm with radius $r$ and let $c_i$ and $x_i$ be the ball's center and the vector $x$ in dimension $i$, respectively. Then $x ∈ B$ iff $\left( ∑_{i=1}^n |c_i - x_i|^2 \right)^{1/2} ≤ r$.
Examples
julia> B = Ball2([1., 1.], sqrt(0.5))
Ball2{Float64,Array{Float64,1}}([1.0, 1.0], 0.7071067811865476)
julia> [.5, 1.6] ∈ B
false
julia> [.5, 1.5] ∈ B
true
LazySets.center
— Methodcenter(B::Ball2)
Return the center of a ball in the 2-norm.
Input
B
– ball in the 2-norm
Output
The center of the ball in the 2-norm.
Base.rand
— Methodrand(::Type{Ball2}; [N]::Type{<:Real}=Float64, [dim]::Int=2,
[rng]::AbstractRNG=GLOBAL_RNG, [seed]::Union{Int, Nothing}=nothing)
Create a random ball in the 2-norm.
Input
Ball2
– type for dispatchN
– (optional, default:Float64
) numeric typedim
– (optional, default: 2) dimensionrng
– (optional, default:GLOBAL_RNG
) random number generatorseed
– (optional, default:nothing
) seed for reseeding
Output
A random ball in the 2-norm.
Algorithm
All numbers are normally distributed with mean 0 and standard deviation 1. Additionally, the radius is nonnegative.
LazySets.sample
— Methodsample(B::Ball2{N}, [nsamples]::Int=1;
[rng]::AbstractRNG=GLOBAL_RNG,
[seed]::Union{Int, Nothing}=nothing) where {N}
Return samples from a uniform distribution on the given ball in the 2-norm.
Input
B
– ball in the 2-normnsamples
– (optional, default:1
) number of samplesrng
– (optional, default:GLOBAL_RNG
) random number generatorseed
– (optional, default:nothing
) seed for reseeding
Output
A linear array of nsamples
elements drawn from a uniform distribution in B
.
Algorithm
Random sampling with uniform distribution in B
is computed using Muller's method of normalized Gaussians. This function requires the package Distributions
. See _sample_unit_nball_muller!
for implementation details.
LazySets.translate
— Methodtranslate(B::Ball2, v::AbstractVector)
Translate (i.e., shift) a ball in the 2-norm by a given vector.
Input
B
– ball in the 2-normv
– translation vector
Output
A translated ball in the 2-norm.
Algorithm
We add the vector to the center of the ball.
LazySets.chebyshev_center
— Methodchebyshev_center(B::Ball2; [compute_radius]::Bool=false)
Compute the Chebyshev center of a ball in the 2-norm.
Input
B
– ball in the 2-normcompute_radius
– (optional; default:false
) option to additionally return the radius of the largest ball enclosed byB
around the Chebyshev center
Output
If compute_radius
is false
, the result is the Chebyshev center of B
. If compute_radius
is true
, the result is the pair (c, r)
where c
is the Chebyshev center of B
and r
is the radius of the largest ball with center c
enclosed by B
.
Notes
The Chebyshev center of a ball in the 2-norm is just the center of the ball.
LazySets.volume
— Methodvolume(B::Ball2)
Return the volume of a ball in the 2-norm.
Input
B
– ball in the 2-norm
Output
The volume of $B$.
Algorithm
This function implements the well-known formula for the volume of an n-dimensional ball using factorials. For details see the wikipedia article Volume of an n-ball.
Inherited from LazySet
:
Inherited from AbstractCentrallySymmetric
: