Mercurial > repos > public > sbplib_julia

annotate src/Grids/parameter_space.jl @ 1905:238ef43fe92a feature/grids/parameter_spaces

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a bunch of docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:46:23 +0100
parents e54fed6a9ada
children 447ea06bfa07
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
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
30
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
31 function Interval(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32 a, b = promote(a, b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
33 new{typeof(a)}(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
34 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
35 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
36
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
37 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
38 limits(i::Interval)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
39
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
40 The limits of the interval.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
41 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
42 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
43
1905
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 unitinterval(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
46
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
47 The interval ``(0,1)``.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
48 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
49 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
50
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
51
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
52 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
53 HyperBox{T,D} <: ParameterSpace{D}
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
54
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
55 A `ParameterSpace` representing a hyper box.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
56 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
57 struct HyperBox{T,D} <: ParameterSpace{D}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
58 a::SVector{D,T}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
59 b::SVector{D,T}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
60 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
61
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
62 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
63 HyperBox(a,b)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
64
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
65 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
66 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
67 function HyperBox(a,b)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
68 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
69 T = SVector{length(a),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
70 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
71 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
72
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
73 Rectangle{T} = HyperBox{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
74 Box{T} = HyperBox{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
75
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
76 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
77 limits(box::HyperBox, d)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
78
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
79 Limits of `box` along dimension `d`.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
80 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
81 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
82
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(box::HyperBox)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
85
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
86 The lower and upper limits of `box` as tuples.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
87 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
88 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
89
1905
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 unitsquare(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
92
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
93 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
94 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
95 unitsquare(T=Float64) = unithyperbox(T,2)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
96
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 unitcube(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
99
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
100 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
101 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
102 unitcube(T=Float64) = unithyperbox(T,3)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
103
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 unithyperbox(T=Float64, D)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
106
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
107 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
108 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
109 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
110 unithyperbox(D) = unithyperbox(Float64,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
111
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
112
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
113 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
114 Simplex{T,D,NV} <: ParameterSpace{D}
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
115
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
116 A `ParameterSpace` representing a simplex.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
117 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
118 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
119 verticies::NTuple{NV,SVector{D,T}}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
120
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
121 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
122 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
123 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
124
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
125 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
126 Simplex(verticies...)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
127
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
128 A simplex with the given vierticies.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
129 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
130 function Simplex(verticies::Vararg{AbstractArray})
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
131 ET = mapreduce(eltype,promote_type,verticies)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
132 T = SVector{length(verticies[1]),ET}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
133
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
134 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
135 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
136
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
137 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
138 verticies(s::Simplex)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
139
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
140 Verticies of `s`.
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
141 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
142 verticies(s::Simplex) = s.verticies
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
143
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
144 Triangle{T} = Simplex{T,2}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
145 Tetrahedron{T} = Simplex{T,3}
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
146
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
147 """
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
148 unittriangle(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
149
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
150 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
151 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
152 unittriangle(T=Float64) = unitsimplex(T,2)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
153
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 unittetrahedron(T=Float64)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
156
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
157 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
158 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
159 unittetrahedron(T=Float64) = unitsimplex(T,3)
1905
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
160
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 unitsimplex(T=Float64,D)
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
163
238ef43fe92a Add a bunch of docstrings
Jonatan Werpers <jonatan@werpers.com>
parents: 1904
diff changeset
164 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
165 """
1902
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
166 function unitsimplex(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
167 z = @SVector zeros(T,D)
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
168 unitelement = one(eltype(z))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
169 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
170 return Simplex((z,verticies...))
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
171 end
f93ba5832146 Copy changes related to ParameterSpace from feature/grids/manifolds
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
172 unitsimplex(D) = unitsimplex(Float64, D)