Skip to content

Commit

Permalink
build based on 50e7567
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Sep 5, 2024
1 parent 77129f1 commit 7cbff90
Show file tree
Hide file tree
Showing 14 changed files with 119 additions and 119 deletions.
2 changes: 1 addition & 1 deletion dev/index.html
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions dev/ref/absint/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/ref/compiler/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Compiler · PDDL.jl</title><meta name="title" content="Compiler · PDDL.jl"/><meta property="og:title" content="Compiler · PDDL.jl"/><meta property="twitter:title" content="Compiler · PDDL.jl"/><meta name="description" content="Documentation for the PDDL.jl automated planning library."/><meta property="og:description" content="Documentation for the PDDL.jl automated planning library."/><meta property="twitter:description" content="Documentation for the PDDL.jl automated planning library."/><meta property="og:url" content="https://juliaplanners.github.io/PDDL.jl/stable/ref/compiler/"/><meta property="twitter:url" content="https://juliaplanners.github.io/PDDL.jl/stable/ref/compiler/"/><link rel="canonical" href="https://juliaplanners.github.io/PDDL.jl/stable/ref/compiler/"/><meta property="og:image" content="https://juliaplanners.github.io/PDDL.jl/stable/assets/preview.png"/><meta property="twitter:image" content="https://juliaplanners.github.io/PDDL.jl/stable/assets/preview.png"/><meta property="twitter:card" content="summary_large_image"/><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><link href="../../assets/logo.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.svg" alt="PDDL.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">PDDL.jl</a></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="../../">PDDL.jl</a></li><li><span class="tocitem">Tutorials</span><ul><li><a class="tocitem" href="../../tutorials/getting_started/">Getting Started</a></li><li><a class="tocitem" href="../../tutorials/writing_planners/">Writing Planners</a></li><li><a class="tocitem" href="../../tutorials/speeding_up/">Speeding Up PDDL.jl</a></li></ul></li><li><span class="tocitem">Reference</span><ul><li><a class="tocitem" href="../overview/">Architecture Overview</a></li><li><a class="tocitem" href="../datatypes/">Concepts and Data Types</a></li><li><a class="tocitem" href="../interface/">Interface Functions</a></li><li><a class="tocitem" href="../parser_writer/">Parser and Writer</a></li><li><a class="tocitem" href="../interpreter/">Interpreter</a></li><li class="is-active"><a class="tocitem" href>Compiler</a></li><li><a class="tocitem" href="../absint/">Abstract Interpretation</a></li><li><a class="tocitem" href="../extensions/">Extension Interfaces</a></li><li><a class="tocitem" href="../utilities/">Utilities</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">Reference</a></li><li class="is-active"><a href>Compiler</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Compiler</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaPlanners/PDDL.jl" title="View the repository on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/JuliaPlanners/PDDL.jl/blob/master/docs/src/ref/compiler.md" title="Edit source on GitHub"><span class="docs-icon fas"></span></a><a class="docs-settings-button docs-navbar-link fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button docs-navbar-link fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Compiler"><a class="docs-heading-anchor" href="#Compiler">Compiler</a><a id="Compiler-1"></a><a class="docs-heading-anchor-permalink" href="#Compiler" title="Permalink"></a></h1><p>PDDL.jl supports compilation of the semantics of PDDL domains through code-generation for PDDL actions and custom datatypes for PDDL states. See <a href="../../tutorials/speeding_up/">Speeding Up PDDL.jl</a> for a more detailed explanation.</p><article class="docstring"><header><a class="docstring-binding" id="PDDL.compiled" href="#PDDL.compiled"><code>PDDL.compiled</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">compiled(domain, state)
compiled(domain, problem)</code></pre><p>Compile a <code>domain</code> and <code>state</code> and return the resulting compiled domain and compiled state. A <code>problem</code> maybe provided instead of a state.</p><div class="admonition is-warning"><header class="admonition-header">Top-Level Only</header><div class="admonition-body"><p>Because <code>compiled</code> defines new types and methods, it should only be called at the top-level in order to avoid world-age errors.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Precompilation Not Supported</header><div class="admonition-body"><p>Because <code>compiled</code> evaluates code in the <code>PDDL</code> module, it will lead to precompilation errors when used in another module or package. Modules which call <code>compiled</code> should hence disable precompilation.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPlanners/PDDL.jl/blob/e34cc1fa403f01515a97ff137aff99d66cc7f82d/src/compiler/compiler.jl#L22-L37">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PDDL.compilestate" href="#PDDL.compilestate"><code>PDDL.compilestate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">compilestate(domain, state)</code></pre><p>Return compiled version of a state compatible with the compiled <code>domain</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPlanners/PDDL.jl/blob/e34cc1fa403f01515a97ff137aff99d66cc7f82d/src/compiler/compiler.jl#L69-L73">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interpreter/">« Interpreter</a><a class="docs-footer-nextpage" href="../absint/">Abstract Interpretation »</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.28.0-DEV on <span class="colophon-date" title="Thursday 9 May 2024 10:41">Thursday 9 May 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
compiled(domain, problem)</code></pre><p>Compile a <code>domain</code> and <code>state</code> and return the resulting compiled domain and compiled state. A <code>problem</code> maybe provided instead of a state.</p><div class="admonition is-warning"><header class="admonition-header">Top-Level Only</header><div class="admonition-body"><p>Because <code>compiled</code> defines new types and methods, it should only be called at the top-level in order to avoid world-age errors.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Precompilation Not Supported</header><div class="admonition-body"><p>Because <code>compiled</code> evaluates code in the <code>PDDL</code> module, it will lead to precompilation errors when used in another module or package. Modules which call <code>compiled</code> should hence disable precompilation.</p></div></div></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPlanners/PDDL.jl/blob/50e7567deab755667d9da303371f9f0e768ed54b/src/compiler/compiler.jl#L22-L37">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PDDL.compilestate" href="#PDDL.compilestate"><code>PDDL.compilestate</code></a> — <span class="docstring-category">Function</span></header><section><div><pre><code class="language-julia hljs">compilestate(domain, state)</code></pre><p>Return compiled version of a state compatible with the compiled <code>domain</code>.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaPlanners/PDDL.jl/blob/50e7567deab755667d9da303371f9f0e768ed54b/src/compiler/compiler.jl#L69-L73">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../interpreter/">« Interpreter</a><a class="docs-footer-nextpage" href="../absint/">Abstract Interpretation »</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.28.0-DEV on <span class="colophon-date" title="Thursday 5 September 2024 13:22">Thursday 5 September 2024</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 7cbff90

Please sign in to comment.