Skip to content
Snippets Groups Projects
trajectory.html 8.5 KiB
Newer Older
Documenter.jl's avatar
Documenter.jl committed
<!DOCTYPE html>
Documenter.jl's avatar
Documenter.jl committed
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Trajectory · 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><a class="tocitem" href="model.html">Model</a></li><li class="is-active"><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="trajectory.html">Trajectory</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="trajectory.html">Trajectory</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com//blob/master/docs/src/api/trajectory.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="Trajectory-related-methods"><a class="docs-heading-anchor" href="#Trajectory-related-methods">Trajectory related methods</a><a id="Trajectory-related-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Trajectory-related-methods" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.dist_lp-Tuple{AbstractTrajectory, AbstractTrajectory, Symbol}" href="#MarkovProcesses.dist_lp-Tuple{AbstractTrajectory, AbstractTrajectory, Symbol}"><code>MarkovProcesses.dist_lp</code></a><span class="docstring-category">Method</span></header><section><div><p><code>dist_lp(σ1, σ2, var; verbose, p, str_stat)</code>   </p><p>Function that computes Lp distance between two trajectories of any dimension. It computes Lp distances for each observed variable (contained in <code>get_obs_var(σ)</code>). and then apply a statistic on these distances. Requires <code>get_obs_var(σ1) == get_obs_var(σ2)</code>, it is verified if they are simulated from the same model. ...</p><p><strong>Arguments</strong></p><ul><li><code>σ1::AbstractTrajectory</code> is the first trajectory. σ2 is the second.</li><li><code>var::Symbol</code> is an observed variable. Have to be contained in <code>get_obs_var(σ1)</code> and <code>get_obs_var(σ2)</code>.</li><li><code>verbose::Bool</code> If <code>true</code>, launch a verbose execution of the computation. </li></ul><p>...</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.dist_lp-Tuple{AbstractTrajectory, AbstractTrajectory}" href="#MarkovProcesses.dist_lp-Tuple{AbstractTrajectory, AbstractTrajectory}"><code>MarkovProcesses.dist_lp</code></a><span class="docstring-category">Method</span></header><section><div><p><code>dist_lp(σ1, σ2; verbose, p, str_stat)</code>   </p><p>Function that computes Lp distance between two trajectories of any dimension. It computes Lp distances for each observed variable (contained in <code>get_obs_var(σ)</code>). and then apply a statistic on these distances. Requires <code>get_obs_var(σ1) == get_obs_var(σ2)</code>, it is verified if they are simulated from the same model. ...</p><p><strong>Arguments</strong></p><ul><li><code>σ1::AbstractTrajectory</code> is the first trajectory. σ2 is the second.</li><li><code>verbose::Bool</code> If <code>true</code>, launch a verbose execution of the computation. </li><li><code>str_stat::String</code> allows to set the statistic to apply on the distances computed  of the trajectories. </li></ul><p>Only &quot;mean&quot; is available for now on. ...</p></div></section></article><article class="docstring"><header><a class="docstring-binding" id="MarkovProcesses.dist_lp-Tuple{Vector{&lt;:AbstractTrajectory}, Vector{&lt;:AbstractTrajectory}}" href="#MarkovProcesses.dist_lp-Tuple{Vector{&lt;:AbstractTrajectory}, Vector{&lt;:AbstractTrajectory}}"><code>MarkovProcesses.dist_lp</code></a><span class="docstring-category">Method</span></header><section><div><p><code>dist_lp(l_σ1, l_σ2; verbose, p, str_stat_list, str_stat_trajectory)</code> </p><p>Function that computes Lp distance between two set of any dimensional trajectories. ...</p><p><strong>Arguments</strong></p><ul><li><code>l_σ1::Vector{AbstractTrajectory}</code> is the first set of trajectories. l_σ2 is the second.</li><li><code>verbose::Bool</code> If <code>true</code>, launch a verbose execution of the computation. </li><li><code>str_stat_list::String</code> allows to set the statistic to apply on the distances of the trajectories. </li></ul><p>It is salso called linkage function in clustering field. Only &quot;mean&quot; is available for now on. ...</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="model.html">« Model</a><a class="docs-footer-nextpage" href="abc.html">Approximate Bayesian Computation »</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>