Mercurial > repos > public > sbplib_julia

annotate src/Grids/parameter_space.jl @ 1907:09c4fda8779d feature/grids/parameter_spaces

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