Skip to content
Snippets Groups Projects
Normal view Permalink
model.html 12.1 KiB
Newer Older
Documenter.jl's avatar
build based on 8bdd9bc
Documenter.jl committed
1 
<!DOCTYPE html>
Documenter.jl's avatar
build based on 5d12a7a  
Documenter.jl committed
2 
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Model · MarkovProcesses.jl</title><script data-outdated-warner src="../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL=".."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../assets/documenter.js"></script><script src="../siteinfo.js"></script><script src="../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../index.html"><img src="../assets/logo.png" alt="MarkovProcesses.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">MarkovProcesses.jl</a></span></div><form class="docs-search" action="../search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../index.html">Home</a></li><li><a class="tocitem" href="../starting.html">Getting Started</a></li><li><a class="tocitem" href="../create_model.html">Create a model</a></li><li><span class="tocitem">API</span><ul><li class="is-active"><a class="tocitem" href="model.html">Model</a></li><li><a class="tocitem" href="trajectory.html">Trajectory</a></li><li><a class="tocitem" href="abc.html">Approximate Bayesian Computation</a></li><li><a class="tocitem" href="plots.html">Plots</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API</a></li><li class="is-active"><a href="model.html">Model</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="model.html">Model</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com//blob/master/docs/src/api/model.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Model-test-related-methods"><a class="docs-heading-anchor" href="#Model-test-related-methods">Model test related methods</a><a id="Model-test-related-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Model-test-related-methods" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.change_simulation_stop_criteria-Tuple{ContinuousTimeModel, Symbol}" href="#MarkovProcesses.change_simulation_stop_criteria-Tuple{ContinuousTimeModel, Symbol}"><code>MarkovProcesses.change_simulation_stop_criteria</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>change_simulation_stop_criteria(m::ContinuousTimeModel, isabsorbing_func::Symbol)</code></p><p>Change the simulation of the model <code>m</code> by adding a stop criteria based on the function named <code>isabsorbing_func::Symbol</code>. <code>isabsorbing_func</code> must have the type signature <code>isabsorbing_func(p::Vector{Float64}, x::Vector{Int})</code> where <code>p</code> is the parameter vector of the model and <code>x</code> a state (not an observed state) of the model.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.distribute_mean_value_lha-Tuple{SynchronizedModel, Symbol, Int64}" href="#MarkovProcesses.distribute_mean_value_lha-Tuple{SynchronizedModel, Symbol, Int64}"><code>MarkovProcesses.distribute_mean_value_lha</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>distribute_mean_value_lha(sm::SynchronizedModel, sym_var::Symbol, nbr_stim::Int)</code></p><p>Distribute over workers the computation of the mean value  of an LHA over <code>nbr_sim</code> simulations of the model.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.draw!-Tuple{AbstractMatrix{Float64}, ParametricModel}" href="#MarkovProcesses.draw!-Tuple{AbstractMatrix{Float64}, ParametricModel}"><code>MarkovProcesses.draw!</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>draw!(mat_p, pm)</code></p><p>Draw <code>size(mat_p)[2]</code> (number of columns of <code>mat_p</code>) parameters from the prior distribution  defined in <code>pm</code> and stores it in <code>mat_p</code>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.draw!-Tuple{AbstractVector{Float64}, ParametricModel}" href="#MarkovProcesses.draw!-Tuple{AbstractVector{Float64}, ParametricModel}"><code>MarkovProcesses.draw!</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>draw!(vec_p, pm)</code></p><p>Draw a parameter from the prior distribution defined in pm and stores it in <code>vec_p</code>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.draw_model!-Tuple{ParametricModel}" href="#MarkovProcesses.draw_model!-Tuple{ParametricModel}"><code>MarkovProcesses.draw_model!</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>draw_model!(pm::ParametricModel)</code></p><p>Draw a parameter from the prior disitribution defined in <code>pm::ParametricModel</code> and save it in the model contained in <code>pm</code>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.prior_pdf!-Tuple{AbstractVector{Float64}, ParametricModel, AbstractMatrix{Float64}}" href="#MarkovProcesses.prior_pdf!-Tuple{AbstractVector{Float64}, ParametricModel, AbstractMatrix{Float64}}"><code>MarkovProcesses.prior_pdf!</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>prior_pdf(res_pdf, mat_p, pm)</code></p><p>Computes the density for each column of <code>mat_p</code> of the prior distribution defined in <code>pm</code>. Stores it in <code>res_pdf</code>. (<code>length(vec_res) == size(mat_p)[2]</code>)</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.prior_pdf-Tuple{ParametricModel, AbstractVector{Float64}}" href="#MarkovProcesses.prior_pdf-Tuple{ParametricModel, AbstractVector{Float64}}"><code>MarkovProcesses.prior_pdf</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>prior_pdf(p_prior, pm)</code></p><p>Computes the density at <code>p_prior</code> of the prior distribution defined in <code>pm</code>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.probability_var_value_lha-Tuple{SynchronizedModel, Int64}" href="#MarkovProcesses.probability_var_value_lha-Tuple{SynchronizedModel, Int64}"><code>MarkovProcesses.probability_var_value_lha</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>distribute_var_value_lha(sm::SynchronizedModel, nbr_sim::Int, value = 0, sym_var = :d)</code></p><p>Compute the probability that the variable <code>sym_var</code> is equal to <code>value</code> of an LHA over <code>nbr_sim</code> simulations of the model.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.simulate-Tuple{ParametricModel, AbstractVector{Float64}}" href="#MarkovProcesses.simulate-Tuple{ParametricModel, AbstractVector{Float64}}"><code>MarkovProcesses.simulate</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>simulate(pm::ParametricModel, p_prior::AbstractVector{Float64})</code></p><p>Simulates the model contained in the parametric model <code>pm</code> with the <code>p_prior</code> parameters. It simulates the model by taking the parameters contained in <code>get_proba_model(pm).p</code> and replace the 1D parameters pm.params with <code>p_prior</code>.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.volatile_simulate-Tuple{ParametricModel, AbstractVector{Float64}}" href="#MarkovProcesses.volatile_simulate-Tuple{ParametricModel, AbstractVector{Float64}}"><code>MarkovProcesses.volatile_simulate</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>volatile_simulate(pm::ParametricModel, p_prior::AbstractVector{Float64})</code></p><p>A volatile version of <code>simulate(pm::ParametricModel, p_prior::AbstractVector{Float64})</code>. The model in <code>pm</code> should be of type SynchronizedModel (<code>typeof(pm.m) &lt;: SynchronizedModel</code>). It returns <code>S::StateLHA</code>, not a trajectory.</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.volatile_simulate-Tuple{SynchronizedModel}" href="#MarkovProcesses.volatile_simulate-Tuple{SynchronizedModel}"><code>MarkovProcesses.volatile_simulate</code></a> — <span class="docstring-category">Method</span></header><section><div><p><code>volatile_simulate(sm::SynchronizedModel; p, verbose)</code></p><p>Simulates a model synchronized with an automaton but does not store the values of the simulation  in order to improve performance. It returns the last state of the simulation <code>S::StateLHA</code> not a trajectory <code>σ::SynchronizedTrajectory</code>.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../create_model.html">« Create a model</a><a class="docs-footer-nextpage" href="trajectory.html">Trajectory »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.24 on <span class="colophon-date" title="Monday 22 May 2023 14:03">Monday 22 May 2023</span>. Using Julia version 1.7.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>