Mercurial > repos > public > sbplib_julia
changeset 1911:449cce897da9 feature/grids/parameter_spaces
Update some docstrings
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Fri, 07 Feb 2025 21:50:35 +0100 |
| parents | 15be190a40cd |
| children | 34dcad2f2cd6 |
| files | src/Grids/parameter_space.jl |
| diffstat | 1 files changed, 4 insertions(+), 4 deletions(-) [+] |
line wrap: on
line diff
diff -r 15be190a40cd -r 449cce897da9 src/Grids/parameter_space.jl --- a/src/Grids/parameter_space.jl Fri Feb 07 15:29:05 2025 +0100 +++ b/src/Grids/parameter_space.jl Fri Feb 07 21:50:35 2025 +0100 @@ -106,21 +106,21 @@ """ unitsquare(T=Float64) -The square starting at ``(0,0)`` with side length 1. +The square limited by 0 and 1 in each dimension. """ unitsquare(T=Float64) = unithyperbox(T,2) """ unitcube(T=Float64) -The cube starting at ``(0,0,0)`` with side length 1. +The cube limited by 0 and 1 in each dimension. """ unitcube(T=Float64) = unithyperbox(T,3) """ unithyperbox(T=Float64, D) -The hypercube in dimension `D` starting at ``(0,0,0,...)`` with side length 1. +The hypercube limited by 0 and 1 in each dimension. """ unithyperbox(T, D) = HyperBox((@SVector zeros(T,D)), (@SVector ones(T,D))) unithyperbox(D) = unithyperbox(Float64,D) @@ -141,7 +141,7 @@ """ Simplex(verticies...) -A simplex with the given vierticies. +A simplex with the given verticies. """ function Simplex(verticies::Vararg{AbstractArray}) ET = mapreduce(eltype,promote_type,verticies)