Fix docs
Some checks failed
MetagraphOptimization_CI / prepare (push) Has been cancelled
MetagraphOptimization_CI / test (push) Has been cancelled
MetagraphOptimization_CI / docs (push) Has been cancelled

This commit is contained in:
2023-09-17 11:20:10 +02:00
parent 4c452dce98
commit 62791ab422
6 changed files with 22 additions and 11 deletions

View File

@ -5,9 +5,9 @@ using DataStructures
Generate the code for a given graph. The return value is a tuple of:
- `code::Expr`: The julia expression containing the code for the whole graph.
- `inputSymbols::Dict{String, Symbol}`: A dictionary of symbols mapping the names of the input nodes of the graph to the symbols their inputs should be provided on.
- `outputSymbol::Symbol`: The symbol of the final calculated value
- `code::Expr`: The julia expression containing the code for the whole graph.
- `inputSymbols::Dict{String, Symbol}`: A dictionary of symbols mapping the names of the input nodes of the graph to the symbols their inputs should be provided on.
- `outputSymbol::Symbol`: The symbol of the final calculated value
See also: [`execute`](@ref)
"""
@ -53,7 +53,7 @@ end
"""
execute(generated_code, input::Dict{ParticleType, Vector{Particle}})
Execute the given generated_code (as returned by [`gen_code`](@ref)) on the given input particles.
Execute the given `generated_code` (as returned by [`gen_code`](@ref)) on the given input particles.
"""
function execute(generated_code, input::Dict{ParticleType, Vector{Particle}})
(code, inputSymbols, outputSymbol) = generated_code
@ -89,7 +89,7 @@ end
"""
execute(graph::DAG, input::Dict{ParticleType, Vector{Particle}})
Execute the given generated_code (as returned by [`gen_code`](@ref)) on the given input particles.
Execute the given `generated_code` (as returned by [`gen_code`](@ref)) on the given input particles.
The input particles should be sorted correctly into the dictionary to their according [`ParticleType`](@ref)s.
See also: [`gen_particles`](@ref)