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

Improve documentation for ParameterSpace
author Jonatan Werpers <jonatan@werpers.com>
date Sat, 01 Feb 2025 22:24:56 +0100
parents f93ba5832146
children 238ef43fe92a
comparison
equal deleted inserted replaced
1902:f93ba5832146 1904:e54fed6a9ada
1 """ 1 """
2 ParameterSpace{D} 2 ParameterSpace{D}
3 3
4 A space of parameters of dimension `D`. Used with `Chart` to indicate which 4 A space of parameters of dimension `D`.
5 parameters are valid for that chart.
6 5
7 Common parameter spaces are created using the functions unit sized spaces 6 Common parameter spaces are created using functions for unit sized spaces
8 * `unitinterval` 7 * [`unitinterval`](@ref)
9 * `unitrectangle` 8 * [`unitsquare`](@ref)
10 * `unitbox` 9 * [`unitcube`](@ref)
11 * `unittriangle` 10 * [`unithyperbox`](@ref)
12 * `unittetrahedron` 11 * [`unittriangle`](@ref)
13 * `unithyperbox` 12 * [`unittetrahedron`](@ref)
14 * `unitsimplex` 13 * [`unitsimplex`](@ref)
15 14
16 See also: [`Interval`](@ref), [`Rectangle`](@ref), [`Box`](@ref), 15 See also: [`Interval`](@ref), [`Rectangle`](@ref), [`Box`](@ref),
17 [`Triangle`](@ref), [`Tetrahedron`](@ref), [`HyperBox`](@ref), 16 [`Triangle`](@ref), [`Tetrahedron`](@ref), [`HyperBox`](@ref),
18 [`Simplex`](@ref), 17 [`Simplex`](@ref),
19 """ 18 """