Mercurial > repos > public > sbplib_julia

annotate src/Grids/parameter_space.jl @ 1904:e54fed6a9ada feature/grids/parameter_spaces

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Improve documentation for ParameterSpace
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:24:56 +0100
parents f93ba5832146
children 238ef43fe92a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
1 """
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 ParameterSpace{D}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3
1904
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
4 A space of parameters of dimension `D`.
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5
1904
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
6 Common parameter spaces are created using functions for unit sized spaces
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
7 * [`unitinterval`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
8 * [`unitsquare`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
9 * [`unitcube`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
10 * [`unithyperbox`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
11 * [`unittriangle`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
12 * [`unittetrahedron`](@ref)
e54fed6a9ada Improve documentation for ParameterSpace
Jonatan Werpers <jonatan@werpers.com>
parents: 1902
diff changeset
13 * [`unitsimplex`](@ref)
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 See also: [`Interval`](@ref), [`Rectangle`](@ref), [`Box`](@ref),
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
16 [`Triangle`](@ref), [`Tetrahedron`](@ref), [`HyperBox`](@ref),
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
17 [`Simplex`](@ref),
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
18 """
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
19 abstract type ParameterSpace{D} end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
20 Base.ndims(::ParameterSpace{D}) where D = D
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
21
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
22 struct Interval{T} <: ParameterSpace{1}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
23 a::T
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
24 b::T
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
25
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
26 function Interval(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
27 a, b = promote(a, b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 new{typeof(a)}(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 limits(i::Interval) = (i.a, i.b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 unitinterval(T=Float64) = Interval(zero(T), one(T))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
37 struct HyperBox{T,D} <: ParameterSpace{D}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
38 a::SVector{D,T}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
39 b::SVector{D,T}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
40 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
41
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
42 function HyperBox(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
43 ET = promote_type(eltype(a),eltype(b))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
44 T = SVector{length(a),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
45 HyperBox(convert(T,a), convert(T,b))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
46 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
47
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
48 Rectangle{T} = HyperBox{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
49 Box{T} = HyperBox{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
50
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
51 limits(box::HyperBox, d) = (box.a[d], box.b[d])
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
52 limits(box::HyperBox) = (box.a, box.b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
53
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
54 unitsquare(T=Float64) = unithyperbox(T,2)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
55 unitcube(T=Float64) = unithyperbox(T,3)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
56 unithyperbox(T, D) = HyperBox((@SVector zeros(T,D)), (@SVector ones(T,D)))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
57 unithyperbox(D) = unithyperbox(Float64,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
58
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
59
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
60 struct Simplex{T,D,NV} <: ParameterSpace{D}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
61 verticies::NTuple{NV,SVector{D,T}}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
62
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
63 Simplex(verticies::Tuple{SVector{D,T}, Vararg{SVector{D,T},N}}) where {T,D,N} = new{T,D,N+1}(verticies)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64 Simplex(::Tuple{}) = throw(ArgumentError("Must provide at least one vertex."))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
65 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67 function Simplex(verticies::Vararg{AbstractArray})
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
68 ET = mapreduce(eltype,promote_type,verticies)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
69 T = SVector{length(verticies[1]),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
70
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
71 return Simplex(Tuple(convert(T,v) for v ∈ verticies))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
74 verticies(s::Simplex) = s.verticies
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
75
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
76 Triangle{T} = Simplex{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
77 Tetrahedron{T} = Simplex{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
78
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
79 unittriangle(T=Float64) = unitsimplex(T,2)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
80 unittetrahedron(T=Float64) = unitsimplex(T,3)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
81 function unitsimplex(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
82 z = @SVector zeros(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
83 unitelement = one(eltype(z))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
84 verticies = ntuple(i->setindex(z, unitelement, i), D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
85 return Simplex((z,verticies...))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
86 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
87 unitsimplex(D) = unitsimplex(Float64, D)