Mercurial > repos > public > sbplib_julia
changeset 861:b1f65b98778d operator_storage_array_of_table
Merge review
| author | Jonatan Werpers <jonatan@werpers.com> |
|---|---|
| date | Wed, 19 Jan 2022 07:28:08 +0100 |
| parents | bdc718c38096 (current diff) 568058183791 (diff) |
| children | 336e8d1a553c |
| files | |
| diffstat | 2 files changed, 10 insertions(+), 9 deletions(-) [+] |
line wrap: on
line diff
--- a/src/SbpOperators/readoperator.jl Mon Jan 17 15:05:43 2022 +0100 +++ b/src/SbpOperators/readoperator.jl Wed Jan 19 07:28:08 2022 +0100 @@ -11,14 +11,14 @@ """ - read_stencil_set(fn; filters) + read_stencil_set(filename; filters) -Picks out a stencil set from the given toml file based on some key-value +Picks out a stencil set from a TOML file based on some key-value filters. If more than one set matches the filters an error is raised. The -returned stencil set contains parsed toml intended for functions like +returned stencil set contains parsed TOML intended for functions like `parse_scalar` and `parse_stencil`. -The stencil set is not parsed beyond the inital toml parse. To get usable +The stencil set is not parsed beyond the inital TOML parse. To get usable stencils use the `parse_stencil` functions on the fields of the stencil set. The reason for this is that since stencil sets are intended to be very @@ -29,12 +29,13 @@ See also [`sbp_operators_path`](@ref), [`get_stencil_set`](@ref), [`parse_stencil`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref),. """ -read_stencil_set(fn; filters...) = get_stencil_set(TOML.parsefile(fn); filters...) +read_stencil_set(filename; filters...) = get_stencil_set(TOML.parsefile(filename); filters...) """ get_stencil_set(parsed_toml; filters...) -Same as `read_stencil_set` but works on already parsed TOML. +Picks out a stencil set from an already parsed TOML based on some key-value +filters. See also [`read_stencil_set`](@ref). """ @@ -60,7 +61,7 @@ """ parse_stencil(parsed_toml) -Accepts parsed toml and reads it as a stencil. +Accepts parsed TOML and reads it as a stencil. See also [`read_stencil_set`](@ref), [`parse_scalar`](@ref), [`parse_tuple`](@ref). """
--- a/src/StaticDicts/StaticDicts.jl Mon Jan 17 15:05:43 2022 +0100 +++ b/src/StaticDicts/StaticDicts.jl Wed Jan 19 07:28:08 2022 +0100 @@ -10,9 +10,9 @@ The immutable nature means that `StaticDict` can be compared with `===`, in constrast to regular `Dict` or `ImmutableDict` which can not. (See -<https://github.com/JuliaLang/julia/issues/4648> for details) One important +<https://github.com/JuliaLang/julia/issues/4648> for details.) One important aspect of this is that `StaticDict` can be used in a struct while still -allowing the struct to be comared using the default implementation of `==` for +allowing the struct to be compared using the default implementation of `==` for structs. Lookups are done by linear search.