changeset 1905:238ef43fe92a feature/grids/parameter_spaces

Add a bunch of docstrings
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:46:23 +0100
parents e54fed6a9ada
children 447ea06bfa07
files src/Grids/parameter_space.jl
diffstat 1 files changed, 85 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/Grids/parameter_space.jl	Sat Feb 01 22:24:56 2025 +0100
+++ b/src/Grids/parameter_space.jl	Sat Feb 01 22:46:23 2025 +0100
@@ -19,6 +19,11 @@
 abstract type ParameterSpace{D} end
 Base.ndims(::ParameterSpace{D}) where D = D
 
+"""
+    Interval{T} <: ParameterSpace{1}
+
+A `ParameterSpace` representing an interval.
+"""
 struct Interval{T} <: ParameterSpace{1}
     a::T
     b::T
@@ -29,16 +34,36 @@
     end
 end
 
+"""
+    limits(i::Interval)
+
+The limits of the interval.
+"""
 limits(i::Interval) = (i.a, i.b)
 
+"""
+    unitinterval(T=Float64)
+
+The interval ``(0,1)``.
+"""
 unitinterval(T=Float64) = Interval(zero(T), one(T))
 
 
+"""
+    HyperBox{T,D} <: ParameterSpace{D}
+
+A `ParameterSpace` representing a hyper box.
+"""
 struct HyperBox{T,D} <: ParameterSpace{D}
     a::SVector{D,T}
     b::SVector{D,T}
 end
 
+"""
+    HyperBox(a,b)
+
+A `HyperBox` with lower limits `a` and upper limits `b` for each dimension.
+"""
 function HyperBox(a,b)
     ET = promote_type(eltype(a),eltype(b))
     T = SVector{length(a),ET}
@@ -48,15 +73,48 @@
 Rectangle{T} = HyperBox{T,2}
 Box{T} = HyperBox{T,3}
 
+"""
+    limits(box::HyperBox, d)
+
+Limits of `box` along dimension `d`.
+"""
 limits(box::HyperBox, d) = (box.a[d], box.b[d])
+
+"""
+    limits(box::HyperBox)
+
+The lower and upper limits of `box` as tuples.
+"""
 limits(box::HyperBox) = (box.a, box.b)
 
+"""
+    unitsquare(T=Float64)
+
+The square starting at ``(0,0)`` with side length 1.
+"""
 unitsquare(T=Float64) = unithyperbox(T,2)
+
+"""
+    unitcube(T=Float64)
+
+The cube starting at ``(0,0,0)`` with side length 1.
+"""
 unitcube(T=Float64) = unithyperbox(T,3)
+
+"""
+    unithyperbox(T=Float64, D)
+
+The hypercube in dimension `D` starting at ``(0,0,0,...)`` with side length 1.
+"""
 unithyperbox(T, D) = HyperBox((@SVector zeros(T,D)), (@SVector ones(T,D)))
 unithyperbox(D) = unithyperbox(Float64,D)
 
 
+"""
+    Simplex{T,D,NV} <: ParameterSpace{D}
+
+A `ParameterSpace` representing a simplex.
+"""
 struct Simplex{T,D,NV} <: ParameterSpace{D}
     verticies::NTuple{NV,SVector{D,T}}
 
@@ -64,6 +122,11 @@
     Simplex(::Tuple{}) = throw(ArgumentError("Must provide at least one vertex."))
 end
 
+"""
+    Simplex(verticies...)
+
+A simplex with the given vierticies.
+"""
 function Simplex(verticies::Vararg{AbstractArray})
     ET = mapreduce(eltype,promote_type,verticies)
     T = SVector{length(verticies[1]),ET}
@@ -71,13 +134,35 @@
     return Simplex(Tuple(convert(T,v) for v ∈ verticies))
 end
 
+"""
+    verticies(s::Simplex)
+
+Verticies of `s`.
+"""
 verticies(s::Simplex) = s.verticies
 
 Triangle{T} = Simplex{T,2}
 Tetrahedron{T} = Simplex{T,3}
 
+"""
+    unittriangle(T=Float64)
+
+The simplex with verticies ``(0,0)``, ``(1,0)``, and ``(0,1).
+"""
 unittriangle(T=Float64) = unitsimplex(T,2)
+
+"""
+    unittetrahedron(T=Float64)
+
+The simplex with verticies ``(0,0,0)``, ``(1,0,0)``, ``(0,1,0)``, and ``(0,0,1)``.
+"""
 unittetrahedron(T=Float64) = unitsimplex(T,3)
+
+"""
+    unitsimplex(T=Float64,D)
+
+The unit simplex in dimension ``D`` with verticies ``(0,0,0,...)``, ``(1,0,0,...)``, ``(0,1,0,...)``, ``(0,0,1,...)``...
+"""
 function unitsimplex(T,D)
     z = @SVector zeros(T,D)
     unitelement = one(eltype(z))