-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Documenter.jl
committed
Jun 10, 2024
1 parent
5a1cfc2
commit 53d63f0
Showing
33 changed files
with
17,960 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
v0.3.3 | ||
v0.4.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
v0.4.0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
#src Generate README.md by running `docs/make.jl` | ||
|
||
# <img align="right" width="180px" src="https://avatars.githubusercontent.com/u/58918144?s=200&v=4"> | ||
|
||
# <!-- DO NOT EDIT README.md directly, instead edit docs/README.jl and generate the markdown--> | ||
|
||
# # Logic<wbr>Circuits<wbr>.jl | ||
|
||
# [![Unit Tests](https://github.com/Tractables/LogicCircuits.jl/workflows/Unit%20Tests/badge.svg)](https://github.com/Tractables/LogicCircuits.jl/actions?query=workflow%3A%22Unit+Tests%22+branch%3Amaster) [![codecov](https://codecov.io/gh/Tractables/LogicCircuits.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Tractables/LogicCircuits.jl) [![](https://img.shields.io/badge/docs-stable-green.svg)](https://Tractables.github.io/LogicCircuits.jl/stable) [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://Tractables.github.io/LogicCircuits.jl/dev) | ||
|
||
# This package provides basic functionality for doing logical reasoning using logical circuits. It has the stand-alone functionality illustrated below, and it serves as the logical foundations for other [Juice packages](https://github.com/Tractables) (Julia Circuit Empanada). | ||
|
||
include("usage.jl") | ||
|
||
# Please see [![](https://img.shields.io/badge/docs-stable-green.svg)](https://Tractables.github.io/LogicCircuits.jl/stable) or [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://Tractables.github.io/LogicCircuits.jl/dev) for further details. | ||
|
||
# ## Development | ||
|
||
# If you are interested in modifying the package please see the [development readme](https://Tractables.github.io/LogicCircuits.jl/dev/development/). | ||
|
||
# ## Acknowledgements | ||
|
||
# To acknowledge this package, please cite: | ||
# ``` | ||
# @inproceedings{DangAAAI21, | ||
# title = {Juice: A Julia Package for Logic and Probabilistic Circuits}, | ||
# author = {Dang, Meihua and Khosravi, Pasha and Liang, Yitao and Vergari, Antonio and Van den Broeck, Guy}, | ||
# booktitle = {Proceedings of the 35th AAAI Conference on Artificial Intelligence (Demo Track)}, | ||
# year = {2021} | ||
# } | ||
# ``` |
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
<!DOCTYPE html> | ||
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Type Trees · LogicCircuits.jl</title><script>(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ | ||
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), | ||
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) | ||
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); | ||
|
||
ga('create', 'UA-136089579-2', 'auto'); | ||
ga('send', 'pageview', {'page': location.pathname + location.search + location.hash}); | ||
</script><link rel="canonical" href="https://Tractables.github.io/LogicCircuits.jl/stable/api/types/"/><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><link href="../../assets/favicon.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.png" alt="LogicCircuits.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit">LogicCircuits.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="../../">Home</a></li><li><a class="tocitem" href="../../generated/usage/">Quick Tutorial</a></li><li><a class="tocitem" href="../../installation/">Installation</a></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Manual</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../manual/properties/">Structural Properties</a></li><li><a class="tocitem" href="../../manual/transformations/">Tranformations</a></li><li><a class="tocitem" href="../../manual/queries/">Queries</a></li><li><a class="tocitem" href="../../manual/compilation/">Compilation</a></li><li><a class="tocitem" href="../../manual/sdd/">Sentential Decision Diagrams</a></li><li><a class="tocitem" href="../../manual/internals/">Internals</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-5" type="checkbox" checked/><label class="tocitem" for="menuitem-5"><span class="docs-label">API</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../public/">Public APIs</a></li><li class="is-active"><a class="tocitem" href>Type Trees</a></li><li><input class="collapse-toggle" id="menuitem-5-3" type="checkbox"/><label class="tocitem" for="menuitem-5-3"><span class="docs-label">Internals</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../internals/logiccircuits/">LogicCircuits</a></li><li><a class="tocitem" href="../internals/utils/">Utils</a></li></ul></li></ul></li><li><a class="tocitem" href="../../development/">Development</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><a class="is-disabled">API</a></li><li class="is-active"><a href>Type Trees</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Type Trees</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/Tractables/LogicCircuits.jl/blob/master/docs/src/api/types.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="api-types"><a class="docs-heading-anchor" href="#api-types">Type Trees</a><a id="api-types-1"></a><a class="docs-heading-anchor-permalink" href="#api-types" title="Permalink"></a></h1><p>The following code snippet provides an easy way to print the type tree of logic circuits.</p><pre><code class="language-julia">using InteractiveUtils; | ||
using LogicCircuits; | ||
using AbstractTrees; | ||
AbstractTrees.children(x::Type) = subtypes(x);</code></pre><p>For example, we can see <a href="../internals/logiccircuits/#LogicCircuits.LogicCircuit"><code>LogicCircuits.LogicCircuit</code></a>'s type tree.</p><pre><code class="language-julia">AbstractTrees.print_tree(LogicCircuit)</code></pre><pre class="documenter-example-output">LogicCircuit | ||
├─ PlainLogicCircuit | ||
│ ├─ PlainLogicInnerNode | ||
│ │ ├─ PlainConstantNode | ||
│ │ ├─ Plain⋀Node | ||
│ │ └─ Plain⋁Node | ||
│ └─ PlainLogicLeafNode | ||
│ └─ PlainLiteralNode | ||
└─ StructLogicCircuit | ||
├─ PlainStructLogicCircuit | ||
│ ├─ PlainStructLogicInnerNode | ||
│ │ ├─ PlainStructConstantNode | ||
│ │ ├─ PlainStruct⋀Node | ||
│ │ └─ PlainStruct⋁Node | ||
│ └─ PlainStructLogicLeafNode | ||
│ └─ PlainStructLiteralNode | ||
└─ Sdd | ||
├─ SddInnerNode | ||
│ ├─ Sdd⋀Node | ||
│ └─ Sdd⋁Node | ||
└─ SddLeafNode | ||
├─ SddConstantNode | ||
└─ SddLiteralNode</pre><p>Alternatively, here's <a href="../internals/logiccircuits/#LogicCircuits.Vtree"><code>Vtree</code></a>'s type tree.</p><pre><code class="language-julia">AbstractTrees.print_tree(Vtree)</code></pre><pre class="documenter-example-output">Vtree | ||
├─ PlainVtree | ||
│ ├─ PlainVtreeInnerNode | ||
│ └─ PlainVtreeLeafNode | ||
└─ SddMgr | ||
├─ SddMgrInnerNode | ||
└─ SddMgrLeafNode</pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../public/">« Public APIs</a><a class="docs-footer-nextpage" href="../internals/logiccircuits/">LogicCircuits »</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> on <span class="colophon-date" title="Monday 10 June 2024 20:45">Monday 10 June 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.