annotate src/Grids/parameter_space.jl @ 1906:447ea06bfa07 feature/grids/parameter_spaces

Make promoting constructor for Interval an outer constructor
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:48:13 +0100
parents 238ef43fe92a
children 09c4fda8779d
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
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
22 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
23 Interval{T} <: ParameterSpace{1}
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
24
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
25 A `ParameterSpace` representing an interval.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
26 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
27 struct Interval{T} <: ParameterSpace{1}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
28 a::T
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
29 b::T
1906
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
30 end
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31
1906
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
32 """
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
33 Interval(a,b)
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
34
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
35 An interval with limits `a` and `b`.
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
36 """
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
37 function Interval(a,b)
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
38 a, b = promote(a, b)
447ea06bfa07 Make promoting constructor for Interval an outer constructor
Jonatan Werpers <jonatan@werpers.com>
parents: 1905
diff changeset
39 Interval{typeof(a)}(a,b)
1902
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
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
42 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
43 limits(i::Interval)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
44
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
45 The limits of the interval.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
46 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
47 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
48
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
49 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
50 unitinterval(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
51
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
52 The interval ``(0,1)``.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
53 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
54 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
55
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
56
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
57 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
58 HyperBox{T,D} <: ParameterSpace{D}
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
59
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
60 A `ParameterSpace` representing a hyper box.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
61 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
62 struct HyperBox{T,D} <: ParameterSpace{D}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
63 a::SVector{D,T}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64 b::SVector{D,T}
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
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
67 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
68 HyperBox(a,b)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
69
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
70 A `HyperBox` with lower limits `a` and upper limits `b` for each dimension.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
71 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72 function HyperBox(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73 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
74 T = SVector{length(a),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
75 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
76 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
77
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
78 Rectangle{T} = HyperBox{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
79 Box{T} = HyperBox{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
80
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
81 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
82 limits(box::HyperBox, d)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
83
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
84 Limits of `box` along dimension `d`.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
85 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
86 limits(box::HyperBox, d) = (box.a[d], box.b[d])
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
87
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
88 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
89 limits(box::HyperBox)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
90
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
91 The lower and upper limits of `box` as tuples.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
92 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
93 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
94
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
95 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
96 unitsquare(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
97
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
98 The square starting at ``(0,0)`` with side length 1.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
99 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
100 unitsquare(T=Float64) = unithyperbox(T,2)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
101
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
102 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
103 unitcube(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
104
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
105 The cube starting at ``(0,0,0)`` with side length 1.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
106 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
107 unitcube(T=Float64) = unithyperbox(T,3)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
108
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
109 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
110 unithyperbox(T=Float64, D)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
111
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
112 The hypercube in dimension `D` starting at ``(0,0,0,...)`` with side length 1.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
113 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
114 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
115 unithyperbox(D) = unithyperbox(Float64,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
116
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
117
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
118 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
119 Simplex{T,D,NV} <: ParameterSpace{D}
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
120
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
121 A `ParameterSpace` representing a simplex.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
122 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
123 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
124 verticies::NTuple{NV,SVector{D,T}}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
125
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
126 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
127 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
128 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
129
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
130 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
131 Simplex(verticies...)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
132
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
133 A simplex with the given vierticies.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
134 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
135 function Simplex(verticies::Vararg{AbstractArray})
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
136 ET = mapreduce(eltype,promote_type,verticies)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
137 T = SVector{length(verticies[1]),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
138
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
139 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
140 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
141
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
142 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
143 verticies(s::Simplex)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
144
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
145 Verticies of `s`.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
146 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
147 verticies(s::Simplex) = s.verticies
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
148
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
149 Triangle{T} = Simplex{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
150 Tetrahedron{T} = Simplex{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
151
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
152 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
153 unittriangle(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
154
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
155 The simplex with verticies ``(0,0)``, ``(1,0)``, and ``(0,1).
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
156 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
157 unittriangle(T=Float64) = unitsimplex(T,2)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
158
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
159 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
160 unittetrahedron(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
161
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
162 The simplex with verticies ``(0,0,0)``, ``(1,0,0)``, ``(0,1,0)``, and ``(0,0,1)``.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
163 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
164 unittetrahedron(T=Float64) = unitsimplex(T,3)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
165
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
166 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
167 unitsimplex(T=Float64,D)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
168
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
169 The unit simplex in dimension ``D`` with verticies ``(0,0,0,...)``, ``(1,0,0,...)``, ``(0,1,0,...)``, ``(0,0,1,...)``...
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
170 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
171 function unitsimplex(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
172 z = @SVector zeros(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
173 unitelement = one(eltype(z))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
174 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
175 return Simplex((z,verticies...))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
176 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
177 unitsimplex(D) = unitsimplex(Float64, D)