-
Notifications
You must be signed in to change notification settings - Fork 20
/
index.html
2 lines (2 loc) · 10.2 KB
/
index.html
1
2
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Library Reference · AlgebraicPetri.jl</title><link href="https://fonts.googleapis.com/css?family=Lato|Roboto+Mono" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.11.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.11.1/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"/><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><script src="../assets/analytics.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit">AlgebraicPetri.jl</span></div><form class="docs-search" action="../search/"><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="../">AlgebraicPetri.jl</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../examples/predation/lotka-volterra/">Lotka-Volterra Model</a></li><li><a class="tocitem" href="../examples/covid/epidemiology/">Basic Epidemiology Models</a></li><li><a class="tocitem" href="../examples/covid/covid/">Multi-City COVID-19 Model</a></li></ul></li><li class="is-active"><a class="tocitem" href>Library Reference</a></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 class="is-active"><a href>Library Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Library Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/master/docs/src/api.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="Library-Reference"><a class="docs-heading-anchor" href="#Library-Reference">Library Reference</a><a id="Library-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Library-Reference" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.AlgebraicPetri" href="#AlgebraicPetri.AlgebraicPetri"><code>AlgebraicPetri.AlgebraicPetri</code></a> — <span class="docstring-category">Module</span></header><section><div><p>Computing in the category of finite sets and Petri cospans</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriCospan" href="#AlgebraicPetri.PetriCospan"><code>AlgebraicPetri.PetriCospan</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Petri Cospan</p><p>A morphism in the category of Open Petri Nets defined as a decorated cospan with a <a href="#AlgebraicPetri.PetriFunctor"><code>PetriFunctor</code></a> as the decorator which maps the category of finite ordinals to the category Petri and a Petri.Model as the decoration</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L86-L92">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriCospanOb" href="#AlgebraicPetri.PetriCospanOb"><code>AlgebraicPetri.PetriCospanOb</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Finite ordinal (natural number)</p><p>An object in the category of Open Petri Nets.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaLang/julia/blob/44fa15b1502a45eac76c9017af94332d4557b251/base/#L0-L4">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriDecorator-Tuple{Catlab.CategoricalAlgebra.FinSets.FinOrdFunction}" href="#AlgebraicPetri.PetriDecorator-Tuple{Catlab.CategoricalAlgebra.FinSets.FinOrdFunction}"><code>AlgebraicPetri.PetriDecorator</code></a> — <span class="docstring-category">Method</span></header><section><div><p>AlgebraicPetri.PetriDecorator(f::FinOrdFunction)</p><p>A functor from FinOrd to Set has a hom part, which given a hom f in FinOrd (a function n::Int->m::Int) should return a representation of F(f)::F(n)->F(m), here we implement this as a function that takes a Petri net of size n to a Petri net of size m, such that the transitions are mapped appropriately.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L64-L71">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriDecorator-Tuple{Catlab.CategoricalAlgebra.FinSets.FinOrd}" href="#AlgebraicPetri.PetriDecorator-Tuple{Catlab.CategoricalAlgebra.FinSets.FinOrd}"><code>AlgebraicPetri.PetriDecorator</code></a> — <span class="docstring-category">Method</span></header><section><div><p>AlgebraicPetri.PetriDecorator(n::FinOrd)</p><p>A functor from FinOrd to Set has an objects part, which given an object n in FinOrd (a natural number) should return a representation of F(n)::Set, sets can be represented as a predicate that takes an element and returns true if the element is in the set. Here we take any julia value and test whether it is a Petri net on n states.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L38-L46">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriFunctor" href="#AlgebraicPetri.PetriFunctor"><code>AlgebraicPetri.PetriFunctor</code></a> — <span class="docstring-category">Type</span></header><section><div><p>Petri Functor</p><p>A functor from FinOrd to Petri defined as a PetriDecorator and a PetriLaxator</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L30-L34">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="AlgebraicPetri.PetriLaxator-Tuple{Petri.Model,Petri.Model}" href="#AlgebraicPetri.PetriLaxator-Tuple{Petri.Model,Petri.Model}"><code>AlgebraicPetri.PetriLaxator</code></a> — <span class="docstring-category">Method</span></header><section><div><p>AlgebraicPetri.PetriLaxator(p::Petri.Model, q::Petri.Model)</p><p>The laxitor takes a pair of decorations and returns the coproduct decoration For Petri nets, this encodes the idea that you shift the states of q up by the number of states in p.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L75-L81">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Core.Type-Tuple{AbstractArray{T,1} where T,Petri.Model,AbstractArray{T,1} where T}" href="#Core.Type-Tuple{AbstractArray{T,1} where T,Petri.Model,AbstractArray{T,1} where T}"><code>Core.Type</code></a> — <span class="docstring-category">Method</span></header><section><div><p>AlgebraicPetri.PetriCospan(l::Vector{Int}, m::Petri.Model, r::Vector{Int})</p><p>A constructor for Petri Cospans where <code>l</code> is a vector of the input states from Petri.Model <code>m</code>, and <code>r</code> is a vector of the output states from Petri.Model <code>m</code></p><p>Constructs the cospan: l → m ← r</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/AlgebraicJulia/AlgebraicPetri.jl/blob/cc1a938553d163023036a37b2716239a7f94605a/src/AlgebraicPetri.jl#L94-L101">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples/covid/covid/">« Multi-City COVID-19 Model</a></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> on <span class="colophon-date" title="Friday 10 July 2020 16:00">Friday 10 July 2020</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>