├── .gitignore ├── .readthedocs.yml ├── .travis.yml ├── README.md ├── docs ├── .buildinfo ├── .nojekyll ├── _modules │ ├── index.html │ └── muk │ │ └── core.html ├── _sources │ ├── index.rst.txt │ ├── mclock.rst.txt │ ├── primer.rst.txt │ ├── reasoned_schemer.rst.txt │ ├── under_the_hood.rst.txt │ └── write_the_doc.rst.txt ├── _static │ ├── alabaster.css │ ├── basic.css │ ├── custom.css │ ├── doctools.js │ ├── documentation_options.js │ ├── file.png │ ├── jquery-3.5.1.js │ ├── jquery.js │ ├── language_data.js │ ├── minus.png │ ├── plus.png │ ├── pygments.css │ ├── searchtools.js │ ├── underscore-1.3.1.js │ └── underscore.js ├── genindex.html ├── index.html ├── mclock.html ├── objects.inv ├── primer.html ├── py-modindex.html ├── reasoned_schemer.html ├── search.html ├── searchindex.js ├── under_the_hood.html └── write_the_doc.html ├── documentation ├── .gitignore ├── Makefile └── source │ ├── _static │ └── .gitignore │ ├── _templates │ └── .gitignore │ ├── conf.py │ ├── index.rst │ ├── mclock.rst │ ├── primer.rst │ ├── reasoned_schemer.rst │ ├── under_the_hood.rst │ └── write_the_doc.rst └── src ├── Makefile ├── __init__.py ├── difference_structures_test.py ├── mclock.py ├── mclock_test.py ├── microkanren_test.py ├── muk ├── __init__.py ├── core.py ├── ext.py ├── sexp.py └── utils.py ├── reasonedschemer.py ├── reasonedschemer_test.py └── sexp_test.py /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | *.swp 3 | *.pyc 4 | *.DS_Store 5 | src/__pycache__/ 6 | venv/ 7 | -------------------------------------------------------------------------------- /.readthedocs.yml: -------------------------------------------------------------------------------- 1 | 2 | 3 | python: 4 | version: 3.5 5 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | 2 | language: python 3 | python: 4 | - "3.5" 5 | - "3.6" 6 | # command to install dependencies 7 | install: 8 | - pip install sphinx sympy # necessary for Python version not present in the default test container 9 | # command to run tests 10 | script: 11 | - make suite -C src PYTHON=python # pass plain `python` to be instantiate according to virtual env 12 | - make -C docs # to run doctests and code snippet in the documentation 13 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | μkanrenpy 3 | ========= 4 | 5 | [![Build Status](https://travis-ci.org/massimo-nocentini/microkanrenpy.svg?branch=master)](https://travis-ci.org/massimo-nocentini/microkanrenpy) 6 | [![Documentation Status](https://readthedocs.org/projects/microkanrenpy/badge/?version=latest)](http://microkanrenpy.readthedocs.io/en/latest/?badge=latest) 7 | 8 | A *pythonic* implementation of the relational interpreter **μkanren** in the 9 | family of *miniKanren* languages. 10 | 11 | A comprehesive documentation ([read latest][read:doc]) is hosted at 12 | https://readthedocs.org/projects/microkanrenpy/ 13 | 14 | [read:doc]: http://microkanrenpy.readthedocs.io/en/latest/ 15 | -------------------------------------------------------------------------------- /docs/.buildinfo: -------------------------------------------------------------------------------- 1 | # Sphinx build info version 1 2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 | config: db48ba976c5f1723a5a84a1fa249b363 4 | tags: 645f666f9bcd5a90fca523b33c5a78b7 5 | -------------------------------------------------------------------------------- /docs/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/docs/.nojekyll -------------------------------------------------------------------------------- /docs/_modules/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Overview: module code — microkanrenpy 1.0 documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |
30 |
31 | 32 | 33 |
34 | 35 |

All modules for which code is available

36 | 38 | 39 |
40 | 41 |
42 |
43 | 90 |
91 |
92 |
93 | ©2017, Massimo Nocentini. 94 | 95 | | 96 | Powered by Sphinx 3.3.1 97 | & Alabaster 0.7.12 98 | 99 |
100 | 101 | 102 | 103 | 104 | 105 | -------------------------------------------------------------------------------- /docs/_sources/index.rst.txt: -------------------------------------------------------------------------------- 1 | .. microkanrenpy documentation master file, created by 2 | sphinx-quickstart on Wed Apr 19 15:20:56 2017. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | ========= 7 | μkanrenpy 8 | ========= 9 | 10 | Introduction 11 | ------------ 12 | 13 | Welcome to documentation of *μkanrenpy*, a *pythonic* implementation of a 14 | *relational interpreter* and an effort to port the `original code written in 15 | Scheme `_ by Jason Hemann and Daniel P. Friedman. We report 16 | their words to describe what this work is about: 17 | 18 | This paper presents μKanren, a minimalist language in the miniKanren family of 19 | relational (logic) programming languages. Its implementation comprises fewer 20 | than 40 lines of Scheme. We motivate the need for a minimalist miniKanren 21 | language, and iteratively develop a complete search strategy. Finally, we 22 | demonstrate that through sufficient user-level features one regains much of the 23 | expressiveness of other miniKanren languages. In our opinion its brevity and 24 | simple semantics make μKanren uniquely elegant. 25 | 26 | Contents 27 | -------- 28 | We organize our thoughts according to the following outline: 29 | 30 | 31 | .. toctree:: 32 | :maxdepth: 3 33 | 34 | write_the_doc 35 | primer 36 | reasoned_schemer 37 | mclock 38 | under_the_hood 39 | 40 | This documentation is automatically generated using `Sphinx `_, which 41 | provides content search facilities, so a `dedicated page `_ is provided 42 | for free for open searches. 43 | 44 | About 45 | ----- 46 | My name is Massimo Nocentini, I'm: 47 | * a PhD student @ `University of Florence `_ 48 | * coding @ `GitHub `_ 49 | 50 | .. * :ref:`modindex` 51 | * :ref:`genindex` 52 | * :ref:`search` 53 | 54 | .. REFERENCES {{{ 55 | 56 | 57 | .. _microkanren_scheme: https://github.com/jasonhemann/microKanren 58 | .. _sphinx: http://www.sphinx-doc.org/en/stable/ 59 | .. _unifi: http://www.unifi.it/ 60 | 61 | .. }}} 62 | -------------------------------------------------------------------------------- /docs/_sources/mclock.rst.txt: -------------------------------------------------------------------------------- 1 | 2 | .. _montecarlo_lock: 3 | 4 | *********************** 5 | Monte Carlo Lock puzzle 6 | *********************** 7 | 8 | .. literalinclude:: ../../src/mclock.py 9 | -------------------------------------------------------------------------------- /docs/_sources/reasoned_schemer.rst.txt: -------------------------------------------------------------------------------- 1 | 2 | .. _reasoned_schemer: 3 | 4 | ******************** 5 | The Reasoned Schemer 6 | ******************** 7 | 8 | .. literalinclude:: ../../src/reasonedschemer.py 9 | -------------------------------------------------------------------------------- /docs/_sources/under_the_hood.rst.txt: -------------------------------------------------------------------------------- 1 | 2 | 3 | ``muk.core`` module 4 | =================== 5 | .. automodule:: muk.core 6 | 7 | Primitive goals and ctors 8 | ~~~~~~~~~~~~~~~~~~~~~~~~~ 9 | .. autoclass:: muk.core.succeed 10 | .. autoclass:: muk.core.fail 11 | .. autoclass:: muk.core._disj 12 | .. autoclass:: muk.core._conj 13 | .. autoclass:: muk.core.fresh 14 | .. autoclass:: muk.core._unify 15 | .. autofunction:: muk.core.unification 16 | 17 | States streams and enumerations 18 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 19 | .. autofunction:: muk.core.mplus 20 | .. autofunction:: muk.core.bind 21 | 22 | Solver and interface 23 | ~~~~~~~~~~~~~~~~~~~~ 24 | .. autofunction:: muk.core.run 25 | -------------------------------------------------------------------------------- /docs/_sources/write_the_doc.rst.txt: -------------------------------------------------------------------------------- 1 | 2 | ***** 3 | Intro 4 | ***** 5 | 6 | I love *Lisp*, *Python* too. The work I'm going to describe has born *for fun*, 7 | for my education, to bang my head against a taugh, beautiful, not so simple to 8 | grasp yet elegant piece of software which is *μkanren* [HF13]_, in the 9 | *miniKanren* [RS05]_ family of logic languages. 10 | 11 | To be honest, this documentations has many targets: 12 | 13 | * it (should) describes what I've done 14 | * it is used to get credits for my PhD course 15 | * to clear my thoughts about the system I'm keeping alive 16 | * to understand and play with documentation tools 17 | * to write down abstract machines that I believe *charming* and *elegant* 18 | * to keep one foot in Lisp and the other in Python, however keep coding 19 | 20 | I would like to structure my exposition following advices from `an interesting 21 | group of people `_, and `one of them in particular 22 | `_, much more experienced that me on writing this kind of stuff; 23 | consequently, in what follows you will find the same sections as you find in 24 | the referenced page, hoping to provide answers and to taylor paragraphs to this 25 | particular project. Quoting their `Sidebar on open source 26 | `_: 27 | 28 | There is a magical feeling that happens when you release your code. It comes in 29 | a variety of ways, but it always hits you the same. Someone is using my code?! 30 | A mix of terror and excitement. 31 | 32 | I made something of value! 33 | What if it breaks?! 34 | I am a real open source developer! 35 | Oh god, someone else is using my code... 36 | 37 | Writing good documentation will help alleviate some of these fears. A lot of 38 | this fear comes from putting something into the world. My favorite quote about 39 | this is something along these lines: 40 | 41 | Fear is what happens when you're doing something important. 42 | If you are doing work that isn't scary, 43 | it isn't improving you or the world. 44 | 45 | Congrats on being afraid! It means you're doing something important. 46 | 47 | from my little and humble point of view, I'm proud to have been afraid as I was 48 | doing all this stuff... 49 | 50 | Why write docs 51 | ============== 52 | 53 | You will be using your code in 6 months (aka, *the future of this project*) 54 | --------------------------------------------------------------------------- 55 | 56 | The reality: 57 | 58 | I find it best to start off with a selfish appeal. The best reason to write 59 | docs is because you will be using your code in 6 months. Code that you 60 | wrote 6 months ago is often indistinguishable from code that someone else 61 | has written. You will look upon a file with a fond sense of remembrance. 62 | Then a sneaking feeling of foreboding, knowing that someone less 63 | experienced, less wise, had written it. 64 | 65 | I started to document what I've done because I would like to keep this code 66 | alive, after the core has been proven mature enough, I would like to add 67 | *constraints* [HF15]_, *guided search* [CF15]_ and *uncertainty* [GS17]_. 68 | 69 | You want people to use your code 70 | -------------------------------- 71 | 72 | *If people don't know why your project exists, they won't use it.* 73 | This project exists mainly *for fun*, to code something beautiful and understand 74 | core and elegant ideas underlying *logic programming*. In parallel, instead of 75 | providing a clone implementation again in Scheme as the original authors do, 76 | we prefere to target the *Python* language which allows us to characterize our version with respect to: 77 | 78 | * we stick to the original language as possible, so we use the same names for functions and 79 | objects; moreover, we adopt the same functional style, without messing up with different paradigms 80 | 81 | * we use native *generator* objects provided by Python to handle relations that can be 82 | satisfied by both a finite or a *countably* infinite set of substitutions for *logic variables* 83 | 84 | * we rewrite the fundamental function that explores the space of substitutions that satisfy a relation 85 | as an *iterative* process instead of *recursive*, in this way we lose the elegance of recursion (inspite of 86 | limit on recursive calls imposed by the language), gaining a *fair* exploration of the solutions space 87 | even if it infinite respect to both the number of streams and the content in each one of them ( 88 | for more details on the topic, have a look at docstring of function :py:func:`muk.core.mplus`) 89 | 90 | * try to write concise, powerful and idiomatic python code for a non-trivial problem, 91 | we would like to keep functions and definitions as small and simple as possible; remember the mantra 92 | 93 | .. doctest:: 94 | 95 | >>> import this 96 | The Zen of Python, by Tim Peters 97 | 98 | Beautiful is better than ugly. 99 | Explicit is better than implicit. 100 | Simple is better than complex. 101 | Complex is better than complicated. 102 | Flat is better than nested. 103 | Sparse is better than dense. 104 | Readability counts. 105 | Special cases aren't special enough to break the rules. 106 | Although practicality beats purity. 107 | Errors should never pass silently. 108 | Unless explicitly silenced. 109 | In the face of ambiguity, refuse the temptation to guess. 110 | There should be one-- and preferably only one --obvious way to do it. 111 | Although that way may not be obvious at first unless you're Dutch. 112 | Now is better than never. 113 | Although never is often better than *right* now. 114 | If the implementation is hard to explain, it's a bad idea. 115 | If the implementation is easy to explain, it may be a good idea. 116 | Namespaces are one honking great idea -- let's do more of those! 117 | 118 | 119 | *If people can't figure out how to install your code, they won't use it.* 120 | All that is required is to have a `Git client `_ 121 | available, so type the following in a console: 122 | 123 | .. code-block:: shell 124 | 125 | git clone https://github.com/massimo-nocentini/microkanrenpy.git # get stuff 126 | cd microkanrenpy/src # go into there 127 | python3 # start the Python interpreter 128 | 129 | Now in the python interpreter it is possible to load our core module: 130 | 131 | .. code-block:: python 132 | 133 | >>> from muk.core import * 134 | 135 | that's it! 136 | 137 | *If people can't figure out how to use your code, they won't use it.* 138 | We provide a simple tutorial in a dedicated page :ref:`primer`. 139 | 140 | You want people to help out 141 | --------------------------- 142 | 143 | *You only get contributions after you have put in a lot of work.* 144 | We work our μkanren with: 145 | 146 | * the little book [RS05]_ or https://mitpress.mit.edu/books/reasoned-schemer, 147 | reproducing **all relations** and answering **all questions**: definitions are 148 | literally included in the page :ref:`reasoned_schemer`, while we record with in a 149 | `unit test file `_ about **350 asserts** to cover questions in the book; 150 | * the puzzle **The Mistery of the Monte Carlo lock** from the book [RS82]_ by Raymond Smullyan, 151 | where we implement a generic machine based on *inference rules*, coding and plugging in 152 | those rule necessary to build McCulloch's machines to find **he key of the lock**, finally. 153 | All defs and some comments are recorded in :ref:`montecarlo_lock` and 154 | in the `tests suite `_ there are about **60 asserts**. 155 | 156 | 157 | *You only get contributions after you have users (aka, to whet your appetite).* 158 | Although I've played with μkanren mostly by writing down definitions in the 159 | context of sexp, namely ``cons`` cells manipulations, I believe of interest 160 | the definition of a generic machine to be configured with *arbitrary inference 161 | rules*: this allows us to implement a relational interpreter for some *process 162 | algebras*, one of them is Milner's CCS calculus. 163 | 164 | *You only get contributions after you have documentation.* 165 | I'm building it! Moreover, this is an *executable documentation*: every 166 | snippet of Python code appearing in these pages, in particular in 167 | :ref:`primer`, is required to pass in the sense of `doctests 168 | `_, in other words a line 169 | that fails to produce the expected output does preevent the generation of 170 | the *whole* documentation. This is possible by running Sphinx with the 171 | corresponding `doctest extension 172 | `_; moreover, 173 | this extension runs and checks doctests written in docstrings of **any** 174 | referenced Python definition stored in source files. 175 | 176 | 177 | 178 | 179 | 180 | It makes your code better 181 | ------------------------- 182 | I would like to enhance each definition in the :py:mod:`muk.core` module with a solid and 183 | consistent docstring, mainly to clarify my thoughts as done for function :py:func:`muk.core.mplus` 184 | in my humble opinion, where we try to explain different enumeration strategies to achieve 185 | *interleaving* of satisfying substitutions. 186 | 187 | Moreover, looking for some chunk of code that needs better doc allows us to find new ideas and 188 | possible refactorings and/or enhancements, the following is a list of ideas: 189 | 190 | * introduce a ``goal`` class, in order to implement magic methods ``__and__, __or__`` to 191 | provide syntactic sugar for goal composition; 192 | * override method ``__radd__`` in class ``var`` in order to write something like ``[1,2,3]+a``, 193 | where ``a`` is a logic variable; this should construct an object that represent an *extension list*, 194 | currently implemented using ``cons`` objects; 195 | * override method ``__add__`` in class ``var`` in order to write something like ``a+[1,2,3]``, 196 | where ``a`` is a logic variable; this should construct an object that represent an *append list* , 197 | currently not; 198 | * from the previous two points would be possible to write ``([1,2,3]+a)-a``, namely a *difference list* 199 | as provided by standard Prolog. 200 | 201 | You want to be a better writer (aka, *looking at the past*) 202 | ----------------------------------------------------------- 203 | I use this section to summarize references and existing works. 204 | 205 | First of all, thank you `William E. Byrd `_ for your hard 206 | work. Will wrote his PhD thesis [WB09]_ and shared a series of hangout video lectures 207 | known as `miniKanran uncourse 208 | `_; moreover, 209 | he is a coauthor of [RS05]_ and maintains a tremendous archive at http://minikanren.org/, 210 | where it is possible to find references to scientific publications, existing implementation in lots of 211 | different programming languages and, finally, links to talks presented in many confs, all of this stuff 212 | related to the field of *relational programming*. 213 | 214 | Python implementations 215 | ~~~~~~~~~~~~~~~~~~~~~~ 216 | 217 | According to Will, we just review the following existing projects: 218 | 219 | `pykanren `_ 220 | which implements the very basic definitions of the core system of both 221 | miniKanren and μkanren: variables, unification only for `list` objects, 222 | reification and a complete enumeration strategy in the style of [RS05]_ 223 | without *interleaving* of satisfying substitutions. Tests are present to 224 | catch the essentials, no application to particular problems. 225 | 226 | `pythological `_ 227 | which implements a *domain specific language* in the style of Prolog 228 | clauses on top of Python. The core interpreter uses primitive *generators* 229 | as we do, implements all the basic definitions of the logic system with 230 | *interleaving* and *occur-check* to detect circular substitutions. In my 231 | opinion it is an interesting project due to the parsing of the dsl which we do 232 | not provide; for what concerns testing, there are no test suites but simple 233 | and nice examples written in the defined language. 234 | 235 | `logpy `_ 236 | which implements the core system, supports relations satisfiable by 237 | infinite substitutions using primitive Python generator objects and 238 | the style is close to the canonical version, although not closer; in 239 | in our humble opinion, the code seems a bit complex to read and understand 240 | because of the presence of many auxiliary functions to handle streams of 241 | satisfying substitutions and to combine goals. Moreover, this project 242 | aims to extend unification over objects of arbitrary types using two 243 | dependencies to perform *double dispatching* and *structural unification*, 244 | which we aim to reach just by sending messages in a more pure and fundamental 245 | way keeping the *Smalltalk way* as tenet. 246 | 247 | `microkanren `_ 248 | which implements the very very basic implementation in about 100 lines of 249 | code: due to its brevity, it supplies variables, primitive goals, disjs and 250 | conjs as combinators, without interleaving and tests. It is released as a 251 | GitHub gist. 252 | 253 | In spite of these existing projects, our main principle is to remain as close 254 | as possible to ideas presented in [HF13]_: we use the same names for functions 255 | as they use in the paper and we write definitions in the same *purely 256 | functional style*. This allows us to preserve compact and concise defs, most of 257 | them do not exceed 5 lines of code. A drawback is some boilerplate and 258 | redundancy, which can be seen immediately in the unit tests, due to the 259 | presence of many ``lambda`` expressions and to the repeated use of ``run``, 260 | ``fresh`` and ``conj``. Finally, our main contribution comprises two test suites, 261 | the first reproduces all examples (including those about the *discrete logarithm*) 262 | of [RS05]_, the second solves a logic puzzle by building an abstract machine composing 263 | inference rules. 264 | 265 | Lisp implementations 266 | ~~~~~~~~~~~~~~~~~~~~ 267 | There are many implementation in the Lisp family: 268 | 269 | * for vanilla `Scheme `_ there are the 270 | `canonical one `_, 271 | `with symbolic constraints `_, 272 | `with probabilistic inference `_ and 273 | `with guided search `_; 274 | finally, I'm particular interested in a `recent impl `_ 275 | which uses the last `r7rs `_ Scheme standard. 276 | * for `Clojure `_ there is the outstanding 277 | `core.logic `_ maintained by `David Nolen `_; 278 | otherwise, two plain ports for `Racket `_ and for 279 | `CommonLisp `_, respectively. 280 | 281 | Other languages and links 282 | ~~~~~~~~~~~~~~~~~~~~~~~~~ 283 | I would like to list some resources that I've discovered in the meanwhile: 284 | 285 | `μkanren in Haskell `_ 286 | a blog post by *Michael J. Sullivan*, also a `recorded talk `_ 287 | `μkanren in Ruby `_ 288 | a Ruby implementation by *Tom Stuart* 289 | `Hakaru `_ 290 | an embedded probabilistic programming language in Haskell 291 | `Logic Programming `_ 292 | 15-819K Logic Programming course, Fall 2006, taught by prof. *Frank Pfenning* 293 | `Prolog course `_ 294 | Prolog course, 2008–09, Principal lecturer: Dr *David Eyers* 295 | 296 | What technology 297 | =============== 298 | 299 | Information for people who want to contribute back 300 | -------------------------------------------------- 301 | I think that `GitHub `_ is a very strong platform where we 302 | can keep alive this project. Moreover, I think also that the decentralized 303 | model and the `workflow `_ 304 | proposed by GitHub itself, which is based on `pull requests 305 | `_, is a clean and 306 | healthy methodology to do development. Therefore, I would like to accept 307 | contributions according to this settings, using facilities provided by the 308 | platform to do discussions and to track issues. Finally, here is the address 309 | of the repository: 310 | 311 | https://github.com/massimo-nocentini/microkanrenpy 312 | 313 | .. note:: 314 | 315 | The actual repository has its roots from: 316 | 317 | https://github.com/massimo-nocentini/on-python/tree/master/microkanren 318 | 319 | the transition to its new independent location has been possible by the following guide: 320 | https://help.github.com/articles/splitting-a-subfolder-out-into-a-new-repository/ 321 | 322 | Together with simplicity and elegance, we believe that *automated testing* is a 323 | vital principle to keep the code base healthy. Therefore, we link the git repo with: 324 | 325 | *Travis CI* 326 | which performs continuous integration by running **all** test suites when we push 327 | something on the git repository; moreover, we use its capabilities to run doctests 328 | and code snippets described in this documentation. The corresponding page is the following: 329 | 330 | https://travis-ci.org/massimo-nocentini/microkanrenpy 331 | 332 | *Read The Docs* 333 | which allows us to have an up-to-date documentation, namely the one you are reading, 334 | with the code base; although this service doesn't allow us to run doctests, this flaw 335 | is covered by Travis just described above. The corresponding page is the following: 336 | 337 | https://readthedocs.org/projects/microkanrenpy/ 338 | 339 | 340 | README.rd first 341 | --------------- 342 | As raccomanded by `this article `_, 343 | have a look to our `README.md `_ first. 344 | 345 | How to get support 346 | ------------------ 347 | If you are having issues, please let us know and feel free to drop me an 348 | email at massimo.nocentini@unifi.it for any info you would like to known. 349 | 350 | 351 | Your project's license 352 | ---------------------- 353 | 354 | Copyright 2017 Massimo Nocentini 355 | 356 | Permission is hereby granted, free of charge, to any person obtaining a copy of 357 | this software and associated documentation files (the "Software"), to deal in 358 | the Software without restriction, including without limitation the rights to 359 | use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies 360 | of the Software, and to permit persons to whom the Software is furnished to do 361 | so, subject to the following conditions: 362 | 363 | The above copyright notice and this permission notice shall be included in all 364 | copies or substantial portions of the Software. 365 | 366 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 367 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 368 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 369 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 370 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 371 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 372 | SOFTWARE. 373 | 374 | -------------------------------------------------- 375 | 376 | .. [HF13] 377 | Jason Hemann and Daniel P. Friedman, 378 | *microKanren: A Minimal Functional Core for Relational Programming*, 379 | In Proceedings of the 2013 Workshop on Scheme and Functional Programming (Scheme '13), Alexandria, VA, 2013. 380 | 381 | .. [HF15] 382 | Jason Hemann and Daniel P. Friedman, 383 | *A Framework for Extending microKanren with Constraints*, 384 | In Proceedings of the 2015 Workshop on Scheme and Functional Programming (Scheme '15), Vancouver, British Columbia, 2015. 385 | 386 | .. [CF15] 387 | Cameron Swords and Daniel P. Friedman, 388 | *rKanren: Guided Search in miniKanren*, 389 | In Proceedings of the 2013 Workshop on Scheme and Functional Programming (Scheme '13), Alexandria, VA, 2013. 390 | 391 | .. [GS17] 392 | N. D. Goodman and A. Stuhlmüller (electronic), 393 | *The Design and Implementation of Probabilistic Programming Languages*, 394 | Retrieved 2017-4-27 from http://dippl.org 395 | 396 | .. [RS05] 397 | Daniel P. Friedman, William E. Byrd and Oleg Kiselyov, 398 | *The Reasoned Schemer*, 399 | The MIT Press, Cambridge, MA, 2005 400 | 401 | .. [RS82] 402 | Raymond Eric Smullyan, 403 | *The Lady or the Tiger*, 404 | Knopf; 1st edition, 1982 405 | 406 | .. [WB09] 407 | William E. Byrd, 408 | *Relational Programming in miniKanren: Techniques, Applications, and Implementations*, 409 | Ph.D. thesis, Indiana University, Bloomington, IN, 2009. 410 | 411 | .. _write_the_doc: http://www.writethedocs.org/guide/writing/beginners-guide-to-docs/ 412 | .. _reasoned_schemer_unitests: https://github.com/massimo-nocentini/microkanrenpy/blob/master/src/reasonedschemer_test.py 413 | .. _mclock_unitests: https://github.com/massimo-nocentini/microkanrenpy/blob/master/src/mclock_test.py 414 | .. _holscher: http://ericholscher.com/blog/2016/jul/1/sphinx-and-rtd-for-writers/ 415 | -------------------------------------------------------------------------------- /docs/_static/alabaster.css: -------------------------------------------------------------------------------- 1 | @import url("basic.css"); 2 | 3 | /* -- page layout ----------------------------------------------------------- */ 4 | 5 | body { 6 | font-family: Georgia, serif; 7 | font-size: 17px; 8 | background-color: #fff; 9 | color: #000; 10 | margin: 0; 11 | padding: 0; 12 | } 13 | 14 | 15 | div.document { 16 | width: 940px; 17 | margin: 30px auto 0 auto; 18 | } 19 | 20 | div.documentwrapper { 21 | float: left; 22 | width: 100%; 23 | } 24 | 25 | div.bodywrapper { 26 | margin: 0 0 0 220px; 27 | } 28 | 29 | div.sphinxsidebar { 30 | width: 220px; 31 | font-size: 14px; 32 | line-height: 1.5; 33 | } 34 | 35 | hr { 36 | border: 1px solid #B1B4B6; 37 | } 38 | 39 | div.body { 40 | background-color: #fff; 41 | color: #3E4349; 42 | padding: 0 30px 0 30px; 43 | } 44 | 45 | div.body > .section { 46 | text-align: left; 47 | } 48 | 49 | div.footer { 50 | width: 940px; 51 | margin: 20px auto 30px auto; 52 | font-size: 14px; 53 | color: #888; 54 | text-align: right; 55 | } 56 | 57 | div.footer a { 58 | color: #888; 59 | } 60 | 61 | p.caption { 62 | font-family: inherit; 63 | font-size: inherit; 64 | } 65 | 66 | 67 | div.relations { 68 | display: none; 69 | } 70 | 71 | 72 | div.sphinxsidebar a { 73 | color: #444; 74 | text-decoration: none; 75 | border-bottom: 1px dotted #999; 76 | } 77 | 78 | div.sphinxsidebar a:hover { 79 | border-bottom: 1px solid #999; 80 | } 81 | 82 | div.sphinxsidebarwrapper { 83 | padding: 18px 10px; 84 | } 85 | 86 | div.sphinxsidebarwrapper p.logo { 87 | padding: 0; 88 | margin: -10px 0 0 0px; 89 | text-align: center; 90 | } 91 | 92 | div.sphinxsidebarwrapper h1.logo { 93 | margin-top: -10px; 94 | text-align: center; 95 | margin-bottom: 5px; 96 | text-align: left; 97 | } 98 | 99 | div.sphinxsidebarwrapper h1.logo-name { 100 | margin-top: 0px; 101 | } 102 | 103 | div.sphinxsidebarwrapper p.blurb { 104 | margin-top: 0; 105 | font-style: normal; 106 | } 107 | 108 | div.sphinxsidebar h3, 109 | div.sphinxsidebar h4 { 110 | font-family: Georgia, serif; 111 | color: #444; 112 | font-size: 24px; 113 | font-weight: normal; 114 | margin: 0 0 5px 0; 115 | padding: 0; 116 | } 117 | 118 | div.sphinxsidebar h4 { 119 | font-size: 20px; 120 | } 121 | 122 | div.sphinxsidebar h3 a { 123 | color: #444; 124 | } 125 | 126 | div.sphinxsidebar p.logo a, 127 | div.sphinxsidebar h3 a, 128 | div.sphinxsidebar p.logo a:hover, 129 | div.sphinxsidebar h3 a:hover { 130 | border: none; 131 | } 132 | 133 | div.sphinxsidebar p { 134 | color: #555; 135 | margin: 10px 0; 136 | } 137 | 138 | div.sphinxsidebar ul { 139 | margin: 10px 0; 140 | padding: 0; 141 | color: #000; 142 | } 143 | 144 | div.sphinxsidebar ul li.toctree-l1 > a { 145 | font-size: 120%; 146 | } 147 | 148 | div.sphinxsidebar ul li.toctree-l2 > a { 149 | font-size: 110%; 150 | } 151 | 152 | div.sphinxsidebar input { 153 | border: 1px solid #CCC; 154 | font-family: Georgia, serif; 155 | font-size: 1em; 156 | } 157 | 158 | div.sphinxsidebar hr { 159 | border: none; 160 | height: 1px; 161 | color: #AAA; 162 | background: #AAA; 163 | 164 | text-align: left; 165 | margin-left: 0; 166 | width: 50%; 167 | } 168 | 169 | div.sphinxsidebar .badge { 170 | border-bottom: none; 171 | } 172 | 173 | div.sphinxsidebar .badge:hover { 174 | border-bottom: none; 175 | } 176 | 177 | /* To address an issue with donation coming after search */ 178 | div.sphinxsidebar h3.donation { 179 | margin-top: 10px; 180 | } 181 | 182 | /* -- body styles ----------------------------------------------------------- */ 183 | 184 | a { 185 | color: #004B6B; 186 | text-decoration: underline; 187 | } 188 | 189 | a:hover { 190 | color: #6D4100; 191 | text-decoration: underline; 192 | } 193 | 194 | div.body h1, 195 | div.body h2, 196 | div.body h3, 197 | div.body h4, 198 | div.body h5, 199 | div.body h6 { 200 | font-family: Georgia, serif; 201 | font-weight: normal; 202 | margin: 30px 0px 10px 0px; 203 | padding: 0; 204 | } 205 | 206 | div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } 207 | div.body h2 { font-size: 180%; } 208 | div.body h3 { font-size: 150%; } 209 | div.body h4 { font-size: 130%; } 210 | div.body h5 { font-size: 100%; } 211 | div.body h6 { font-size: 100%; } 212 | 213 | a.headerlink { 214 | color: #DDD; 215 | padding: 0 4px; 216 | text-decoration: none; 217 | } 218 | 219 | a.headerlink:hover { 220 | color: #444; 221 | background: #EAEAEA; 222 | } 223 | 224 | div.body p, div.body dd, div.body li { 225 | line-height: 1.4em; 226 | } 227 | 228 | div.admonition { 229 | margin: 20px 0px; 230 | padding: 10px 30px; 231 | background-color: #EEE; 232 | border: 1px solid #CCC; 233 | } 234 | 235 | div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { 236 | background-color: #FBFBFB; 237 | border-bottom: 1px solid #fafafa; 238 | } 239 | 240 | div.admonition p.admonition-title { 241 | font-family: Georgia, serif; 242 | font-weight: normal; 243 | font-size: 24px; 244 | margin: 0 0 10px 0; 245 | padding: 0; 246 | line-height: 1; 247 | } 248 | 249 | div.admonition p.last { 250 | margin-bottom: 0; 251 | } 252 | 253 | div.highlight { 254 | background-color: #fff; 255 | } 256 | 257 | dt:target, .highlight { 258 | background: #FAF3E8; 259 | } 260 | 261 | div.warning { 262 | background-color: #FCC; 263 | border: 1px solid #FAA; 264 | } 265 | 266 | div.danger { 267 | background-color: #FCC; 268 | border: 1px solid #FAA; 269 | -moz-box-shadow: 2px 2px 4px #D52C2C; 270 | -webkit-box-shadow: 2px 2px 4px #D52C2C; 271 | box-shadow: 2px 2px 4px #D52C2C; 272 | } 273 | 274 | div.error { 275 | background-color: #FCC; 276 | border: 1px solid #FAA; 277 | -moz-box-shadow: 2px 2px 4px #D52C2C; 278 | -webkit-box-shadow: 2px 2px 4px #D52C2C; 279 | box-shadow: 2px 2px 4px #D52C2C; 280 | } 281 | 282 | div.caution { 283 | background-color: #FCC; 284 | border: 1px solid #FAA; 285 | } 286 | 287 | div.attention { 288 | background-color: #FCC; 289 | border: 1px solid #FAA; 290 | } 291 | 292 | div.important { 293 | background-color: #EEE; 294 | border: 1px solid #CCC; 295 | } 296 | 297 | div.note { 298 | background-color: #EEE; 299 | border: 1px solid #CCC; 300 | } 301 | 302 | div.tip { 303 | background-color: #EEE; 304 | border: 1px solid #CCC; 305 | } 306 | 307 | div.hint { 308 | background-color: #EEE; 309 | border: 1px solid #CCC; 310 | } 311 | 312 | div.seealso { 313 | background-color: #EEE; 314 | border: 1px solid #CCC; 315 | } 316 | 317 | div.topic { 318 | background-color: #EEE; 319 | } 320 | 321 | p.admonition-title { 322 | display: inline; 323 | } 324 | 325 | p.admonition-title:after { 326 | content: ":"; 327 | } 328 | 329 | pre, tt, code { 330 | font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; 331 | font-size: 0.9em; 332 | } 333 | 334 | .hll { 335 | background-color: #FFC; 336 | margin: 0 -12px; 337 | padding: 0 12px; 338 | display: block; 339 | } 340 | 341 | img.screenshot { 342 | } 343 | 344 | tt.descname, tt.descclassname, code.descname, code.descclassname { 345 | font-size: 0.95em; 346 | } 347 | 348 | tt.descname, code.descname { 349 | padding-right: 0.08em; 350 | } 351 | 352 | img.screenshot { 353 | -moz-box-shadow: 2px 2px 4px #EEE; 354 | -webkit-box-shadow: 2px 2px 4px #EEE; 355 | box-shadow: 2px 2px 4px #EEE; 356 | } 357 | 358 | table.docutils { 359 | border: 1px solid #888; 360 | -moz-box-shadow: 2px 2px 4px #EEE; 361 | -webkit-box-shadow: 2px 2px 4px #EEE; 362 | box-shadow: 2px 2px 4px #EEE; 363 | } 364 | 365 | table.docutils td, table.docutils th { 366 | border: 1px solid #888; 367 | padding: 0.25em 0.7em; 368 | } 369 | 370 | table.field-list, table.footnote { 371 | border: none; 372 | -moz-box-shadow: none; 373 | -webkit-box-shadow: none; 374 | box-shadow: none; 375 | } 376 | 377 | table.footnote { 378 | margin: 15px 0; 379 | width: 100%; 380 | border: 1px solid #EEE; 381 | background: #FDFDFD; 382 | font-size: 0.9em; 383 | } 384 | 385 | table.footnote + table.footnote { 386 | margin-top: -15px; 387 | border-top: none; 388 | } 389 | 390 | table.field-list th { 391 | padding: 0 0.8em 0 0; 392 | } 393 | 394 | table.field-list td { 395 | padding: 0; 396 | } 397 | 398 | table.field-list p { 399 | margin-bottom: 0.8em; 400 | } 401 | 402 | /* Cloned from 403 | * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 404 | */ 405 | .field-name { 406 | -moz-hyphens: manual; 407 | -ms-hyphens: manual; 408 | -webkit-hyphens: manual; 409 | hyphens: manual; 410 | } 411 | 412 | table.footnote td.label { 413 | width: .1px; 414 | padding: 0.3em 0 0.3em 0.5em; 415 | } 416 | 417 | table.footnote td { 418 | padding: 0.3em 0.5em; 419 | } 420 | 421 | dl { 422 | margin: 0; 423 | padding: 0; 424 | } 425 | 426 | dl dd { 427 | margin-left: 30px; 428 | } 429 | 430 | blockquote { 431 | margin: 0 0 0 30px; 432 | padding: 0; 433 | } 434 | 435 | ul, ol { 436 | /* Matches the 30px from the narrow-screen "li > ul" selector below */ 437 | margin: 10px 0 10px 30px; 438 | padding: 0; 439 | } 440 | 441 | pre { 442 | background: #EEE; 443 | padding: 7px 30px; 444 | margin: 15px 0px; 445 | line-height: 1.3em; 446 | } 447 | 448 | div.viewcode-block:target { 449 | background: #ffd; 450 | } 451 | 452 | dl pre, blockquote pre, li pre { 453 | margin-left: 0; 454 | padding-left: 30px; 455 | } 456 | 457 | tt, code { 458 | background-color: #ecf0f3; 459 | color: #222; 460 | /* padding: 1px 2px; */ 461 | } 462 | 463 | tt.xref, code.xref, a tt { 464 | background-color: #FBFBFB; 465 | border-bottom: 1px solid #fff; 466 | } 467 | 468 | a.reference { 469 | text-decoration: none; 470 | border-bottom: 1px dotted #004B6B; 471 | } 472 | 473 | /* Don't put an underline on images */ 474 | a.image-reference, a.image-reference:hover { 475 | border-bottom: none; 476 | } 477 | 478 | a.reference:hover { 479 | border-bottom: 1px solid #6D4100; 480 | } 481 | 482 | a.footnote-reference { 483 | text-decoration: none; 484 | font-size: 0.7em; 485 | vertical-align: top; 486 | border-bottom: 1px dotted #004B6B; 487 | } 488 | 489 | a.footnote-reference:hover { 490 | border-bottom: 1px solid #6D4100; 491 | } 492 | 493 | a:hover tt, a:hover code { 494 | background: #EEE; 495 | } 496 | 497 | 498 | @media screen and (max-width: 870px) { 499 | 500 | div.sphinxsidebar { 501 | display: none; 502 | } 503 | 504 | div.document { 505 | width: 100%; 506 | 507 | } 508 | 509 | div.documentwrapper { 510 | margin-left: 0; 511 | margin-top: 0; 512 | margin-right: 0; 513 | margin-bottom: 0; 514 | } 515 | 516 | div.bodywrapper { 517 | margin-top: 0; 518 | margin-right: 0; 519 | margin-bottom: 0; 520 | margin-left: 0; 521 | } 522 | 523 | ul { 524 | margin-left: 0; 525 | } 526 | 527 | li > ul { 528 | /* Matches the 30px from the "ul, ol" selector above */ 529 | margin-left: 30px; 530 | } 531 | 532 | .document { 533 | width: auto; 534 | } 535 | 536 | .footer { 537 | width: auto; 538 | } 539 | 540 | .bodywrapper { 541 | margin: 0; 542 | } 543 | 544 | .footer { 545 | width: auto; 546 | } 547 | 548 | .github { 549 | display: none; 550 | } 551 | 552 | 553 | 554 | } 555 | 556 | 557 | 558 | @media screen and (max-width: 875px) { 559 | 560 | body { 561 | margin: 0; 562 | padding: 20px 30px; 563 | } 564 | 565 | div.documentwrapper { 566 | float: none; 567 | background: #fff; 568 | } 569 | 570 | div.sphinxsidebar { 571 | display: block; 572 | float: none; 573 | width: 102.5%; 574 | margin: 50px -30px -20px -30px; 575 | padding: 10px 20px; 576 | background: #333; 577 | color: #FFF; 578 | } 579 | 580 | div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, 581 | div.sphinxsidebar h3 a { 582 | color: #fff; 583 | } 584 | 585 | div.sphinxsidebar a { 586 | color: #AAA; 587 | } 588 | 589 | div.sphinxsidebar p.logo { 590 | display: none; 591 | } 592 | 593 | div.document { 594 | width: 100%; 595 | margin: 0; 596 | } 597 | 598 | div.footer { 599 | display: none; 600 | } 601 | 602 | div.bodywrapper { 603 | margin: 0; 604 | } 605 | 606 | div.body { 607 | min-height: 0; 608 | padding: 0; 609 | } 610 | 611 | .rtd_doc_footer { 612 | display: none; 613 | } 614 | 615 | .document { 616 | width: auto; 617 | } 618 | 619 | .footer { 620 | width: auto; 621 | } 622 | 623 | .footer { 624 | width: auto; 625 | } 626 | 627 | .github { 628 | display: none; 629 | } 630 | } 631 | 632 | 633 | /* misc. */ 634 | 635 | .revsys-inline { 636 | display: none!important; 637 | } 638 | 639 | /* Make nested-list/multi-paragraph items look better in Releases changelog 640 | * pages. Without this, docutils' magical list fuckery causes inconsistent 641 | * formatting between different release sub-lists. 642 | */ 643 | div#changelog > div.section > ul > li > p:only-child { 644 | margin-bottom: 0; 645 | } 646 | 647 | /* Hide fugly table cell borders in ..bibliography:: directive output */ 648 | table.docutils.citation, table.docutils.citation td, table.docutils.citation th { 649 | border: none; 650 | /* Below needed in some edge cases; if not applied, bottom shadows appear */ 651 | -moz-box-shadow: none; 652 | -webkit-box-shadow: none; 653 | box-shadow: none; 654 | } 655 | 656 | 657 | /* relbar */ 658 | 659 | .related { 660 | line-height: 30px; 661 | width: 100%; 662 | font-size: 0.9rem; 663 | } 664 | 665 | .related.top { 666 | border-bottom: 1px solid #EEE; 667 | margin-bottom: 20px; 668 | } 669 | 670 | .related.bottom { 671 | border-top: 1px solid #EEE; 672 | } 673 | 674 | .related ul { 675 | padding: 0; 676 | margin: 0; 677 | list-style: none; 678 | } 679 | 680 | .related li { 681 | display: inline; 682 | } 683 | 684 | nav#rellinks { 685 | float: right; 686 | } 687 | 688 | nav#rellinks li+li:before { 689 | content: "|"; 690 | } 691 | 692 | nav#breadcrumbs li+li:before { 693 | content: "\00BB"; 694 | } 695 | 696 | /* Hide certain items when printing */ 697 | @media print { 698 | div.related { 699 | display: none; 700 | } 701 | } -------------------------------------------------------------------------------- /docs/_static/basic.css: -------------------------------------------------------------------------------- 1 | /* 2 | * basic.css 3 | * ~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- basic theme. 6 | * 7 | * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /* -- main layout ----------------------------------------------------------- */ 13 | 14 | div.clearer { 15 | clear: both; 16 | } 17 | 18 | div.section::after { 19 | display: block; 20 | content: ''; 21 | clear: left; 22 | } 23 | 24 | /* -- relbar ---------------------------------------------------------------- */ 25 | 26 | div.related { 27 | width: 100%; 28 | font-size: 90%; 29 | } 30 | 31 | div.related h3 { 32 | display: none; 33 | } 34 | 35 | div.related ul { 36 | margin: 0; 37 | padding: 0 0 0 10px; 38 | list-style: none; 39 | } 40 | 41 | div.related li { 42 | display: inline; 43 | } 44 | 45 | div.related li.right { 46 | float: right; 47 | margin-right: 5px; 48 | } 49 | 50 | /* -- sidebar --------------------------------------------------------------- */ 51 | 52 | div.sphinxsidebarwrapper { 53 | padding: 10px 5px 0 10px; 54 | } 55 | 56 | div.sphinxsidebar { 57 | float: left; 58 | width: 230px; 59 | margin-left: -100%; 60 | font-size: 90%; 61 | word-wrap: break-word; 62 | overflow-wrap : break-word; 63 | } 64 | 65 | div.sphinxsidebar ul { 66 | list-style: none; 67 | } 68 | 69 | div.sphinxsidebar ul ul, 70 | div.sphinxsidebar ul.want-points { 71 | margin-left: 20px; 72 | list-style: square; 73 | } 74 | 75 | div.sphinxsidebar ul ul { 76 | margin-top: 0; 77 | margin-bottom: 0; 78 | } 79 | 80 | div.sphinxsidebar form { 81 | margin-top: 10px; 82 | } 83 | 84 | div.sphinxsidebar input { 85 | border: 1px solid #98dbcc; 86 | font-family: sans-serif; 87 | font-size: 1em; 88 | } 89 | 90 | div.sphinxsidebar #searchbox form.search { 91 | overflow: hidden; 92 | } 93 | 94 | div.sphinxsidebar #searchbox input[type="text"] { 95 | float: left; 96 | width: 80%; 97 | padding: 0.25em; 98 | box-sizing: border-box; 99 | } 100 | 101 | div.sphinxsidebar #searchbox input[type="submit"] { 102 | float: left; 103 | width: 20%; 104 | border-left: none; 105 | padding: 0.25em; 106 | box-sizing: border-box; 107 | } 108 | 109 | 110 | img { 111 | border: 0; 112 | max-width: 100%; 113 | } 114 | 115 | /* -- search page ----------------------------------------------------------- */ 116 | 117 | ul.search { 118 | margin: 10px 0 0 20px; 119 | padding: 0; 120 | } 121 | 122 | ul.search li { 123 | padding: 5px 0 5px 20px; 124 | background-image: url(file.png); 125 | background-repeat: no-repeat; 126 | background-position: 0 7px; 127 | } 128 | 129 | ul.search li a { 130 | font-weight: bold; 131 | } 132 | 133 | ul.search li div.context { 134 | color: #888; 135 | margin: 2px 0 0 30px; 136 | text-align: left; 137 | } 138 | 139 | ul.keywordmatches li.goodmatch a { 140 | font-weight: bold; 141 | } 142 | 143 | /* -- index page ------------------------------------------------------------ */ 144 | 145 | table.contentstable { 146 | width: 90%; 147 | margin-left: auto; 148 | margin-right: auto; 149 | } 150 | 151 | table.contentstable p.biglink { 152 | line-height: 150%; 153 | } 154 | 155 | a.biglink { 156 | font-size: 1.3em; 157 | } 158 | 159 | span.linkdescr { 160 | font-style: italic; 161 | padding-top: 5px; 162 | font-size: 90%; 163 | } 164 | 165 | /* -- general index --------------------------------------------------------- */ 166 | 167 | table.indextable { 168 | width: 100%; 169 | } 170 | 171 | table.indextable td { 172 | text-align: left; 173 | vertical-align: top; 174 | } 175 | 176 | table.indextable ul { 177 | margin-top: 0; 178 | margin-bottom: 0; 179 | list-style-type: none; 180 | } 181 | 182 | table.indextable > tbody > tr > td > ul { 183 | padding-left: 0em; 184 | } 185 | 186 | table.indextable tr.pcap { 187 | height: 10px; 188 | } 189 | 190 | table.indextable tr.cap { 191 | margin-top: 10px; 192 | background-color: #f2f2f2; 193 | } 194 | 195 | img.toggler { 196 | margin-right: 3px; 197 | margin-top: 3px; 198 | cursor: pointer; 199 | } 200 | 201 | div.modindex-jumpbox { 202 | border-top: 1px solid #ddd; 203 | border-bottom: 1px solid #ddd; 204 | margin: 1em 0 1em 0; 205 | padding: 0.4em; 206 | } 207 | 208 | div.genindex-jumpbox { 209 | border-top: 1px solid #ddd; 210 | border-bottom: 1px solid #ddd; 211 | margin: 1em 0 1em 0; 212 | padding: 0.4em; 213 | } 214 | 215 | /* -- domain module index --------------------------------------------------- */ 216 | 217 | table.modindextable td { 218 | padding: 2px; 219 | border-collapse: collapse; 220 | } 221 | 222 | /* -- general body styles --------------------------------------------------- */ 223 | 224 | div.body { 225 | min-width: 450px; 226 | max-width: 800px; 227 | } 228 | 229 | div.body p, div.body dd, div.body li, div.body blockquote { 230 | -moz-hyphens: auto; 231 | -ms-hyphens: auto; 232 | -webkit-hyphens: auto; 233 | hyphens: auto; 234 | } 235 | 236 | a.headerlink { 237 | visibility: hidden; 238 | } 239 | 240 | a.brackets:before, 241 | span.brackets > a:before{ 242 | content: "["; 243 | } 244 | 245 | a.brackets:after, 246 | span.brackets > a:after { 247 | content: "]"; 248 | } 249 | 250 | h1:hover > a.headerlink, 251 | h2:hover > a.headerlink, 252 | h3:hover > a.headerlink, 253 | h4:hover > a.headerlink, 254 | h5:hover > a.headerlink, 255 | h6:hover > a.headerlink, 256 | dt:hover > a.headerlink, 257 | caption:hover > a.headerlink, 258 | p.caption:hover > a.headerlink, 259 | div.code-block-caption:hover > a.headerlink { 260 | visibility: visible; 261 | } 262 | 263 | div.body p.caption { 264 | text-align: inherit; 265 | } 266 | 267 | div.body td { 268 | text-align: left; 269 | } 270 | 271 | .first { 272 | margin-top: 0 !important; 273 | } 274 | 275 | p.rubric { 276 | margin-top: 30px; 277 | font-weight: bold; 278 | } 279 | 280 | img.align-left, .figure.align-left, object.align-left { 281 | clear: left; 282 | float: left; 283 | margin-right: 1em; 284 | } 285 | 286 | img.align-right, .figure.align-right, object.align-right { 287 | clear: right; 288 | float: right; 289 | margin-left: 1em; 290 | } 291 | 292 | img.align-center, .figure.align-center, object.align-center { 293 | display: block; 294 | margin-left: auto; 295 | margin-right: auto; 296 | } 297 | 298 | img.align-default, .figure.align-default { 299 | display: block; 300 | margin-left: auto; 301 | margin-right: auto; 302 | } 303 | 304 | .align-left { 305 | text-align: left; 306 | } 307 | 308 | .align-center { 309 | text-align: center; 310 | } 311 | 312 | .align-default { 313 | text-align: center; 314 | } 315 | 316 | .align-right { 317 | text-align: right; 318 | } 319 | 320 | /* -- sidebars -------------------------------------------------------------- */ 321 | 322 | div.sidebar { 323 | margin: 0 0 0.5em 1em; 324 | border: 1px solid #ddb; 325 | padding: 7px; 326 | background-color: #ffe; 327 | width: 40%; 328 | float: right; 329 | clear: right; 330 | overflow-x: auto; 331 | } 332 | 333 | p.sidebar-title { 334 | font-weight: bold; 335 | } 336 | 337 | div.admonition, div.topic, blockquote { 338 | clear: left; 339 | } 340 | 341 | /* -- topics ---------------------------------------------------------------- */ 342 | 343 | div.topic { 344 | border: 1px solid #ccc; 345 | padding: 7px; 346 | margin: 10px 0 10px 0; 347 | } 348 | 349 | p.topic-title { 350 | font-size: 1.1em; 351 | font-weight: bold; 352 | margin-top: 10px; 353 | } 354 | 355 | /* -- admonitions ----------------------------------------------------------- */ 356 | 357 | div.admonition { 358 | margin-top: 10px; 359 | margin-bottom: 10px; 360 | padding: 7px; 361 | } 362 | 363 | div.admonition dt { 364 | font-weight: bold; 365 | } 366 | 367 | p.admonition-title { 368 | margin: 0px 10px 5px 0px; 369 | font-weight: bold; 370 | } 371 | 372 | div.body p.centered { 373 | text-align: center; 374 | margin-top: 25px; 375 | } 376 | 377 | /* -- content of sidebars/topics/admonitions -------------------------------- */ 378 | 379 | div.sidebar > :last-child, 380 | div.topic > :last-child, 381 | div.admonition > :last-child { 382 | margin-bottom: 0; 383 | } 384 | 385 | div.sidebar::after, 386 | div.topic::after, 387 | div.admonition::after, 388 | blockquote::after { 389 | display: block; 390 | content: ''; 391 | clear: both; 392 | } 393 | 394 | /* -- tables ---------------------------------------------------------------- */ 395 | 396 | table.docutils { 397 | margin-top: 10px; 398 | margin-bottom: 10px; 399 | border: 0; 400 | border-collapse: collapse; 401 | } 402 | 403 | table.align-center { 404 | margin-left: auto; 405 | margin-right: auto; 406 | } 407 | 408 | table.align-default { 409 | margin-left: auto; 410 | margin-right: auto; 411 | } 412 | 413 | table caption span.caption-number { 414 | font-style: italic; 415 | } 416 | 417 | table caption span.caption-text { 418 | } 419 | 420 | table.docutils td, table.docutils th { 421 | padding: 1px 8px 1px 5px; 422 | border-top: 0; 423 | border-left: 0; 424 | border-right: 0; 425 | border-bottom: 1px solid #aaa; 426 | } 427 | 428 | table.footnote td, table.footnote th { 429 | border: 0 !important; 430 | } 431 | 432 | th { 433 | text-align: left; 434 | padding-right: 5px; 435 | } 436 | 437 | table.citation { 438 | border-left: solid 1px gray; 439 | margin-left: 1px; 440 | } 441 | 442 | table.citation td { 443 | border-bottom: none; 444 | } 445 | 446 | th > :first-child, 447 | td > :first-child { 448 | margin-top: 0px; 449 | } 450 | 451 | th > :last-child, 452 | td > :last-child { 453 | margin-bottom: 0px; 454 | } 455 | 456 | /* -- figures --------------------------------------------------------------- */ 457 | 458 | div.figure { 459 | margin: 0.5em; 460 | padding: 0.5em; 461 | } 462 | 463 | div.figure p.caption { 464 | padding: 0.3em; 465 | } 466 | 467 | div.figure p.caption span.caption-number { 468 | font-style: italic; 469 | } 470 | 471 | div.figure p.caption span.caption-text { 472 | } 473 | 474 | /* -- field list styles ----------------------------------------------------- */ 475 | 476 | table.field-list td, table.field-list th { 477 | border: 0 !important; 478 | } 479 | 480 | .field-list ul { 481 | margin: 0; 482 | padding-left: 1em; 483 | } 484 | 485 | .field-list p { 486 | margin: 0; 487 | } 488 | 489 | .field-name { 490 | -moz-hyphens: manual; 491 | -ms-hyphens: manual; 492 | -webkit-hyphens: manual; 493 | hyphens: manual; 494 | } 495 | 496 | /* -- hlist styles ---------------------------------------------------------- */ 497 | 498 | table.hlist { 499 | margin: 1em 0; 500 | } 501 | 502 | table.hlist td { 503 | vertical-align: top; 504 | } 505 | 506 | 507 | /* -- other body styles ----------------------------------------------------- */ 508 | 509 | ol.arabic { 510 | list-style: decimal; 511 | } 512 | 513 | ol.loweralpha { 514 | list-style: lower-alpha; 515 | } 516 | 517 | ol.upperalpha { 518 | list-style: upper-alpha; 519 | } 520 | 521 | ol.lowerroman { 522 | list-style: lower-roman; 523 | } 524 | 525 | ol.upperroman { 526 | list-style: upper-roman; 527 | } 528 | 529 | :not(li) > ol > li:first-child > :first-child, 530 | :not(li) > ul > li:first-child > :first-child { 531 | margin-top: 0px; 532 | } 533 | 534 | :not(li) > ol > li:last-child > :last-child, 535 | :not(li) > ul > li:last-child > :last-child { 536 | margin-bottom: 0px; 537 | } 538 | 539 | ol.simple ol p, 540 | ol.simple ul p, 541 | ul.simple ol p, 542 | ul.simple ul p { 543 | margin-top: 0; 544 | } 545 | 546 | ol.simple > li:not(:first-child) > p, 547 | ul.simple > li:not(:first-child) > p { 548 | margin-top: 0; 549 | } 550 | 551 | ol.simple p, 552 | ul.simple p { 553 | margin-bottom: 0; 554 | } 555 | 556 | dl.footnote > dt, 557 | dl.citation > dt { 558 | float: left; 559 | margin-right: 0.5em; 560 | } 561 | 562 | dl.footnote > dd, 563 | dl.citation > dd { 564 | margin-bottom: 0em; 565 | } 566 | 567 | dl.footnote > dd:after, 568 | dl.citation > dd:after { 569 | content: ""; 570 | clear: both; 571 | } 572 | 573 | dl.field-list { 574 | display: grid; 575 | grid-template-columns: fit-content(30%) auto; 576 | } 577 | 578 | dl.field-list > dt { 579 | font-weight: bold; 580 | word-break: break-word; 581 | padding-left: 0.5em; 582 | padding-right: 5px; 583 | } 584 | 585 | dl.field-list > dt:after { 586 | content: ":"; 587 | } 588 | 589 | dl.field-list > dd { 590 | padding-left: 0.5em; 591 | margin-top: 0em; 592 | margin-left: 0em; 593 | margin-bottom: 0em; 594 | } 595 | 596 | dl { 597 | margin-bottom: 15px; 598 | } 599 | 600 | dd > :first-child { 601 | margin-top: 0px; 602 | } 603 | 604 | dd ul, dd table { 605 | margin-bottom: 10px; 606 | } 607 | 608 | dd { 609 | margin-top: 3px; 610 | margin-bottom: 10px; 611 | margin-left: 30px; 612 | } 613 | 614 | dl > dd:last-child, 615 | dl > dd:last-child > :last-child { 616 | margin-bottom: 0; 617 | } 618 | 619 | dt:target, span.highlighted { 620 | background-color: #fbe54e; 621 | } 622 | 623 | rect.highlighted { 624 | fill: #fbe54e; 625 | } 626 | 627 | dl.glossary dt { 628 | font-weight: bold; 629 | font-size: 1.1em; 630 | } 631 | 632 | .optional { 633 | font-size: 1.3em; 634 | } 635 | 636 | .sig-paren { 637 | font-size: larger; 638 | } 639 | 640 | .versionmodified { 641 | font-style: italic; 642 | } 643 | 644 | .system-message { 645 | background-color: #fda; 646 | padding: 5px; 647 | border: 3px solid red; 648 | } 649 | 650 | .footnote:target { 651 | background-color: #ffa; 652 | } 653 | 654 | .line-block { 655 | display: block; 656 | margin-top: 1em; 657 | margin-bottom: 1em; 658 | } 659 | 660 | .line-block .line-block { 661 | margin-top: 0; 662 | margin-bottom: 0; 663 | margin-left: 1.5em; 664 | } 665 | 666 | .guilabel, .menuselection { 667 | font-family: sans-serif; 668 | } 669 | 670 | .accelerator { 671 | text-decoration: underline; 672 | } 673 | 674 | .classifier { 675 | font-style: oblique; 676 | } 677 | 678 | .classifier:before { 679 | font-style: normal; 680 | margin: 0.5em; 681 | content: ":"; 682 | } 683 | 684 | abbr, acronym { 685 | border-bottom: dotted 1px; 686 | cursor: help; 687 | } 688 | 689 | /* -- code displays --------------------------------------------------------- */ 690 | 691 | pre { 692 | overflow: auto; 693 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ 694 | } 695 | 696 | pre, div[class*="highlight-"] { 697 | clear: both; 698 | } 699 | 700 | span.pre { 701 | -moz-hyphens: none; 702 | -ms-hyphens: none; 703 | -webkit-hyphens: none; 704 | hyphens: none; 705 | } 706 | 707 | div[class*="highlight-"] { 708 | margin: 1em 0; 709 | } 710 | 711 | td.linenos pre { 712 | border: 0; 713 | background-color: transparent; 714 | color: #aaa; 715 | } 716 | 717 | table.highlighttable { 718 | display: block; 719 | } 720 | 721 | table.highlighttable tbody { 722 | display: block; 723 | } 724 | 725 | table.highlighttable tr { 726 | display: flex; 727 | } 728 | 729 | table.highlighttable td { 730 | margin: 0; 731 | padding: 0; 732 | } 733 | 734 | table.highlighttable td.linenos { 735 | padding-right: 0.5em; 736 | } 737 | 738 | table.highlighttable td.code { 739 | flex: 1; 740 | overflow: hidden; 741 | } 742 | 743 | .highlight .hll { 744 | display: block; 745 | } 746 | 747 | div.highlight pre, 748 | table.highlighttable pre { 749 | margin: 0; 750 | } 751 | 752 | div.code-block-caption + div { 753 | margin-top: 0; 754 | } 755 | 756 | div.code-block-caption { 757 | margin-top: 1em; 758 | padding: 2px 5px; 759 | font-size: small; 760 | } 761 | 762 | div.code-block-caption code { 763 | background-color: transparent; 764 | } 765 | 766 | table.highlighttable td.linenos, 767 | span.linenos, 768 | div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ 769 | user-select: none; 770 | } 771 | 772 | div.code-block-caption span.caption-number { 773 | padding: 0.1em 0.3em; 774 | font-style: italic; 775 | } 776 | 777 | div.code-block-caption span.caption-text { 778 | } 779 | 780 | div.literal-block-wrapper { 781 | margin: 1em 0; 782 | } 783 | 784 | code.descname { 785 | background-color: transparent; 786 | font-weight: bold; 787 | font-size: 1.2em; 788 | } 789 | 790 | code.descclassname { 791 | background-color: transparent; 792 | } 793 | 794 | code.xref, a code { 795 | background-color: transparent; 796 | font-weight: bold; 797 | } 798 | 799 | h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { 800 | background-color: transparent; 801 | } 802 | 803 | .viewcode-link { 804 | float: right; 805 | } 806 | 807 | .viewcode-back { 808 | float: right; 809 | font-family: sans-serif; 810 | } 811 | 812 | div.viewcode-block:target { 813 | margin: -1px -10px; 814 | padding: 0 10px; 815 | } 816 | 817 | /* -- math display ---------------------------------------------------------- */ 818 | 819 | img.math { 820 | vertical-align: middle; 821 | } 822 | 823 | div.body div.math p { 824 | text-align: center; 825 | } 826 | 827 | span.eqno { 828 | float: right; 829 | } 830 | 831 | span.eqno a.headerlink { 832 | position: absolute; 833 | z-index: 1; 834 | } 835 | 836 | div.math:hover a.headerlink { 837 | visibility: visible; 838 | } 839 | 840 | /* -- printout stylesheet --------------------------------------------------- */ 841 | 842 | @media print { 843 | div.document, 844 | div.documentwrapper, 845 | div.bodywrapper { 846 | margin: 0 !important; 847 | width: 100%; 848 | } 849 | 850 | div.sphinxsidebar, 851 | div.related, 852 | div.footer, 853 | #top-link { 854 | display: none; 855 | } 856 | } -------------------------------------------------------------------------------- /docs/_static/custom.css: -------------------------------------------------------------------------------- 1 | /* This file intentionally left blank. */ 2 | -------------------------------------------------------------------------------- /docs/_static/doctools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * doctools.js 3 | * ~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for all documentation. 6 | * 7 | * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /** 13 | * select a different prefix for underscore 14 | */ 15 | $u = _.noConflict(); 16 | 17 | /** 18 | * make the code below compatible with browsers without 19 | * an installed firebug like debugger 20 | if (!window.console || !console.firebug) { 21 | var names = ["log", "debug", "info", "warn", "error", "assert", "dir", 22 | "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", 23 | "profile", "profileEnd"]; 24 | window.console = {}; 25 | for (var i = 0; i < names.length; ++i) 26 | window.console[names[i]] = function() {}; 27 | } 28 | */ 29 | 30 | /** 31 | * small helper function to urldecode strings 32 | */ 33 | jQuery.urldecode = function(x) { 34 | return decodeURIComponent(x).replace(/\+/g, ' '); 35 | }; 36 | 37 | /** 38 | * small helper function to urlencode strings 39 | */ 40 | jQuery.urlencode = encodeURIComponent; 41 | 42 | /** 43 | * This function returns the parsed url parameters of the 44 | * current request. Multiple values per key are supported, 45 | * it will always return arrays of strings for the value parts. 46 | */ 47 | jQuery.getQueryParameters = function(s) { 48 | if (typeof s === 'undefined') 49 | s = document.location.search; 50 | var parts = s.substr(s.indexOf('?') + 1).split('&'); 51 | var result = {}; 52 | for (var i = 0; i < parts.length; i++) { 53 | var tmp = parts[i].split('=', 2); 54 | var key = jQuery.urldecode(tmp[0]); 55 | var value = jQuery.urldecode(tmp[1]); 56 | if (key in result) 57 | result[key].push(value); 58 | else 59 | result[key] = [value]; 60 | } 61 | return result; 62 | }; 63 | 64 | /** 65 | * highlight a given string on a jquery object by wrapping it in 66 | * span elements with the given class name. 67 | */ 68 | jQuery.fn.highlightText = function(text, className) { 69 | function highlight(node, addItems) { 70 | if (node.nodeType === 3) { 71 | var val = node.nodeValue; 72 | var pos = val.toLowerCase().indexOf(text); 73 | if (pos >= 0 && 74 | !jQuery(node.parentNode).hasClass(className) && 75 | !jQuery(node.parentNode).hasClass("nohighlight")) { 76 | var span; 77 | var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); 78 | if (isInSVG) { 79 | span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); 80 | } else { 81 | span = document.createElement("span"); 82 | span.className = className; 83 | } 84 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 85 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( 86 | document.createTextNode(val.substr(pos + text.length)), 87 | node.nextSibling)); 88 | node.nodeValue = val.substr(0, pos); 89 | if (isInSVG) { 90 | var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); 91 | var bbox = node.parentElement.getBBox(); 92 | rect.x.baseVal.value = bbox.x; 93 | rect.y.baseVal.value = bbox.y; 94 | rect.width.baseVal.value = bbox.width; 95 | rect.height.baseVal.value = bbox.height; 96 | rect.setAttribute('class', className); 97 | addItems.push({ 98 | "parent": node.parentNode, 99 | "target": rect}); 100 | } 101 | } 102 | } 103 | else if (!jQuery(node).is("button, select, textarea")) { 104 | jQuery.each(node.childNodes, function() { 105 | highlight(this, addItems); 106 | }); 107 | } 108 | } 109 | var addItems = []; 110 | var result = this.each(function() { 111 | highlight(this, addItems); 112 | }); 113 | for (var i = 0; i < addItems.length; ++i) { 114 | jQuery(addItems[i].parent).before(addItems[i].target); 115 | } 116 | return result; 117 | }; 118 | 119 | /* 120 | * backward compatibility for jQuery.browser 121 | * This will be supported until firefox bug is fixed. 122 | */ 123 | if (!jQuery.browser) { 124 | jQuery.uaMatch = function(ua) { 125 | ua = ua.toLowerCase(); 126 | 127 | var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || 128 | /(webkit)[ \/]([\w.]+)/.exec(ua) || 129 | /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || 130 | /(msie) ([\w.]+)/.exec(ua) || 131 | ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || 132 | []; 133 | 134 | return { 135 | browser: match[ 1 ] || "", 136 | version: match[ 2 ] || "0" 137 | }; 138 | }; 139 | jQuery.browser = {}; 140 | jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; 141 | } 142 | 143 | /** 144 | * Small JavaScript module for the documentation. 145 | */ 146 | var Documentation = { 147 | 148 | init : function() { 149 | this.fixFirefoxAnchorBug(); 150 | this.highlightSearchWords(); 151 | this.initIndexTable(); 152 | if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) { 153 | this.initOnKeyListeners(); 154 | } 155 | }, 156 | 157 | /** 158 | * i18n support 159 | */ 160 | TRANSLATIONS : {}, 161 | PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, 162 | LOCALE : 'unknown', 163 | 164 | // gettext and ngettext don't access this so that the functions 165 | // can safely bound to a different name (_ = Documentation.gettext) 166 | gettext : function(string) { 167 | var translated = Documentation.TRANSLATIONS[string]; 168 | if (typeof translated === 'undefined') 169 | return string; 170 | return (typeof translated === 'string') ? translated : translated[0]; 171 | }, 172 | 173 | ngettext : function(singular, plural, n) { 174 | var translated = Documentation.TRANSLATIONS[singular]; 175 | if (typeof translated === 'undefined') 176 | return (n == 1) ? singular : plural; 177 | return translated[Documentation.PLURALEXPR(n)]; 178 | }, 179 | 180 | addTranslations : function(catalog) { 181 | for (var key in catalog.messages) 182 | this.TRANSLATIONS[key] = catalog.messages[key]; 183 | this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); 184 | this.LOCALE = catalog.locale; 185 | }, 186 | 187 | /** 188 | * add context elements like header anchor links 189 | */ 190 | addContextElements : function() { 191 | $('div[id] > :header:first').each(function() { 192 | $('\u00B6'). 193 | attr('href', '#' + this.id). 194 | attr('title', _('Permalink to this headline')). 195 | appendTo(this); 196 | }); 197 | $('dt[id]').each(function() { 198 | $('\u00B6'). 199 | attr('href', '#' + this.id). 200 | attr('title', _('Permalink to this definition')). 201 | appendTo(this); 202 | }); 203 | }, 204 | 205 | /** 206 | * workaround a firefox stupidity 207 | * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 208 | */ 209 | fixFirefoxAnchorBug : function() { 210 | if (document.location.hash && $.browser.mozilla) 211 | window.setTimeout(function() { 212 | document.location.href += ''; 213 | }, 10); 214 | }, 215 | 216 | /** 217 | * highlight the search words provided in the url in the text 218 | */ 219 | highlightSearchWords : function() { 220 | var params = $.getQueryParameters(); 221 | var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; 222 | if (terms.length) { 223 | var body = $('div.body'); 224 | if (!body.length) { 225 | body = $('body'); 226 | } 227 | window.setTimeout(function() { 228 | $.each(terms, function() { 229 | body.highlightText(this.toLowerCase(), 'highlighted'); 230 | }); 231 | }, 10); 232 | $('

' + _('Hide Search Matches') + '

') 234 | .appendTo($('#searchbox')); 235 | } 236 | }, 237 | 238 | /** 239 | * init the domain index toggle buttons 240 | */ 241 | initIndexTable : function() { 242 | var togglers = $('img.toggler').click(function() { 243 | var src = $(this).attr('src'); 244 | var idnum = $(this).attr('id').substr(7); 245 | $('tr.cg-' + idnum).toggle(); 246 | if (src.substr(-9) === 'minus.png') 247 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 248 | else 249 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 250 | }).css('display', ''); 251 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 252 | togglers.click(); 253 | } 254 | }, 255 | 256 | /** 257 | * helper function to hide the search marks again 258 | */ 259 | hideSearchWords : function() { 260 | $('#searchbox .highlight-link').fadeOut(300); 261 | $('span.highlighted').removeClass('highlighted'); 262 | }, 263 | 264 | /** 265 | * make the url absolute 266 | */ 267 | makeURL : function(relativeURL) { 268 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 269 | }, 270 | 271 | /** 272 | * get the current relative url 273 | */ 274 | getCurrentURL : function() { 275 | var path = document.location.pathname; 276 | var parts = path.split(/\//); 277 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 278 | if (this === '..') 279 | parts.pop(); 280 | }); 281 | var url = parts.join('/'); 282 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 283 | }, 284 | 285 | initOnKeyListeners: function() { 286 | $(document).keydown(function(event) { 287 | var activeElementType = document.activeElement.tagName; 288 | // don't navigate when in search box, textarea, dropdown or button 289 | if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' 290 | && activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey 291 | && !event.shiftKey) { 292 | switch (event.keyCode) { 293 | case 37: // left 294 | var prevHref = $('link[rel="prev"]').prop('href'); 295 | if (prevHref) { 296 | window.location.href = prevHref; 297 | return false; 298 | } 299 | case 39: // right 300 | var nextHref = $('link[rel="next"]').prop('href'); 301 | if (nextHref) { 302 | window.location.href = nextHref; 303 | return false; 304 | } 305 | } 306 | } 307 | }); 308 | } 309 | }; 310 | 311 | // quick alias for translations 312 | _ = Documentation.gettext; 313 | 314 | $(document).ready(function() { 315 | Documentation.init(); 316 | }); 317 | -------------------------------------------------------------------------------- /docs/_static/documentation_options.js: -------------------------------------------------------------------------------- 1 | var DOCUMENTATION_OPTIONS = { 2 | URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), 3 | VERSION: '1.0', 4 | LANGUAGE: 'None', 5 | COLLAPSE_INDEX: false, 6 | BUILDER: 'html', 7 | FILE_SUFFIX: '.html', 8 | LINK_SUFFIX: '.html', 9 | HAS_SOURCE: true, 10 | SOURCELINK_SUFFIX: '.txt', 11 | NAVIGATION_WITH_KEYS: false 12 | }; -------------------------------------------------------------------------------- /docs/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/docs/_static/file.png -------------------------------------------------------------------------------- /docs/_static/language_data.js: -------------------------------------------------------------------------------- 1 | /* 2 | * language_data.js 3 | * ~~~~~~~~~~~~~~~~ 4 | * 5 | * This script contains the language-specific data used by searchtools.js, 6 | * namely the list of stopwords, stemmer, scorer and splitter. 7 | * 8 | * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. 9 | * :license: BSD, see LICENSE for details. 10 | * 11 | */ 12 | 13 | var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"]; 14 | 15 | 16 | /* Non-minified version JS is _stemmer.js if file is provided */ 17 | /** 18 | * Porter Stemmer 19 | */ 20 | var Stemmer = function() { 21 | 22 | var step2list = { 23 | ational: 'ate', 24 | tional: 'tion', 25 | enci: 'ence', 26 | anci: 'ance', 27 | izer: 'ize', 28 | bli: 'ble', 29 | alli: 'al', 30 | entli: 'ent', 31 | eli: 'e', 32 | ousli: 'ous', 33 | ization: 'ize', 34 | ation: 'ate', 35 | ator: 'ate', 36 | alism: 'al', 37 | iveness: 'ive', 38 | fulness: 'ful', 39 | ousness: 'ous', 40 | aliti: 'al', 41 | iviti: 'ive', 42 | biliti: 'ble', 43 | logi: 'log' 44 | }; 45 | 46 | var step3list = { 47 | icate: 'ic', 48 | ative: '', 49 | alize: 'al', 50 | iciti: 'ic', 51 | ical: 'ic', 52 | ful: '', 53 | ness: '' 54 | }; 55 | 56 | var c = "[^aeiou]"; // consonant 57 | var v = "[aeiouy]"; // vowel 58 | var C = c + "[^aeiouy]*"; // consonant sequence 59 | var V = v + "[aeiou]*"; // vowel sequence 60 | 61 | var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 62 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 63 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 64 | var s_v = "^(" + C + ")?" + v; // vowel in stem 65 | 66 | this.stemWord = function (w) { 67 | var stem; 68 | var suffix; 69 | var firstch; 70 | var origword = w; 71 | 72 | if (w.length < 3) 73 | return w; 74 | 75 | var re; 76 | var re2; 77 | var re3; 78 | var re4; 79 | 80 | firstch = w.substr(0,1); 81 | if (firstch == "y") 82 | w = firstch.toUpperCase() + w.substr(1); 83 | 84 | // Step 1a 85 | re = /^(.+?)(ss|i)es$/; 86 | re2 = /^(.+?)([^s])s$/; 87 | 88 | if (re.test(w)) 89 | w = w.replace(re,"$1$2"); 90 | else if (re2.test(w)) 91 | w = w.replace(re2,"$1$2"); 92 | 93 | // Step 1b 94 | re = /^(.+?)eed$/; 95 | re2 = /^(.+?)(ed|ing)$/; 96 | if (re.test(w)) { 97 | var fp = re.exec(w); 98 | re = new RegExp(mgr0); 99 | if (re.test(fp[1])) { 100 | re = /.$/; 101 | w = w.replace(re,""); 102 | } 103 | } 104 | else if (re2.test(w)) { 105 | var fp = re2.exec(w); 106 | stem = fp[1]; 107 | re2 = new RegExp(s_v); 108 | if (re2.test(stem)) { 109 | w = stem; 110 | re2 = /(at|bl|iz)$/; 111 | re3 = new RegExp("([^aeiouylsz])\\1$"); 112 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 113 | if (re2.test(w)) 114 | w = w + "e"; 115 | else if (re3.test(w)) { 116 | re = /.$/; 117 | w = w.replace(re,""); 118 | } 119 | else if (re4.test(w)) 120 | w = w + "e"; 121 | } 122 | } 123 | 124 | // Step 1c 125 | re = /^(.+?)y$/; 126 | if (re.test(w)) { 127 | var fp = re.exec(w); 128 | stem = fp[1]; 129 | re = new RegExp(s_v); 130 | if (re.test(stem)) 131 | w = stem + "i"; 132 | } 133 | 134 | // Step 2 135 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; 136 | if (re.test(w)) { 137 | var fp = re.exec(w); 138 | stem = fp[1]; 139 | suffix = fp[2]; 140 | re = new RegExp(mgr0); 141 | if (re.test(stem)) 142 | w = stem + step2list[suffix]; 143 | } 144 | 145 | // Step 3 146 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; 147 | if (re.test(w)) { 148 | var fp = re.exec(w); 149 | stem = fp[1]; 150 | suffix = fp[2]; 151 | re = new RegExp(mgr0); 152 | if (re.test(stem)) 153 | w = stem + step3list[suffix]; 154 | } 155 | 156 | // Step 4 157 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; 158 | re2 = /^(.+?)(s|t)(ion)$/; 159 | if (re.test(w)) { 160 | var fp = re.exec(w); 161 | stem = fp[1]; 162 | re = new RegExp(mgr1); 163 | if (re.test(stem)) 164 | w = stem; 165 | } 166 | else if (re2.test(w)) { 167 | var fp = re2.exec(w); 168 | stem = fp[1] + fp[2]; 169 | re2 = new RegExp(mgr1); 170 | if (re2.test(stem)) 171 | w = stem; 172 | } 173 | 174 | // Step 5 175 | re = /^(.+?)e$/; 176 | if (re.test(w)) { 177 | var fp = re.exec(w); 178 | stem = fp[1]; 179 | re = new RegExp(mgr1); 180 | re2 = new RegExp(meq1); 181 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 182 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) 183 | w = stem; 184 | } 185 | re = /ll$/; 186 | re2 = new RegExp(mgr1); 187 | if (re.test(w) && re2.test(w)) { 188 | re = /.$/; 189 | w = w.replace(re,""); 190 | } 191 | 192 | // and turn initial Y back to y 193 | if (firstch == "y") 194 | w = firstch.toLowerCase() + w.substr(1); 195 | return w; 196 | } 197 | } 198 | 199 | 200 | 201 | 202 | 203 | var splitChars = (function() { 204 | var result = {}; 205 | var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648, 206 | 1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702, 207 | 2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971, 208 | 2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345, 209 | 3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761, 210 | 3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823, 211 | 4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125, 212 | 8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695, 213 | 11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587, 214 | 43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141]; 215 | var i, j, start, end; 216 | for (i = 0; i < singles.length; i++) { 217 | result[singles[i]] = true; 218 | } 219 | var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709], 220 | [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161], 221 | [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568], 222 | [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807], 223 | [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047], 224 | [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383], 225 | [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450], 226 | [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547], 227 | [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673], 228 | [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820], 229 | [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946], 230 | [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023], 231 | [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173], 232 | [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332], 233 | [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481], 234 | [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718], 235 | [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791], 236 | [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095], 237 | [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205], 238 | [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687], 239 | [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968], 240 | [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869], 241 | [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102], 242 | [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271], 243 | [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592], 244 | [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822], 245 | [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167], 246 | [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959], 247 | [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143], 248 | [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318], 249 | [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483], 250 | [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101], 251 | [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567], 252 | [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292], 253 | [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444], 254 | [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783], 255 | [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311], 256 | [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511], 257 | [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774], 258 | [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071], 259 | [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263], 260 | [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519], 261 | [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647], 262 | [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967], 263 | [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295], 264 | [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274], 265 | [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007], 266 | [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381], 267 | [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]]; 268 | for (i = 0; i < ranges.length; i++) { 269 | start = ranges[i][0]; 270 | end = ranges[i][1]; 271 | for (j = start; j <= end; j++) { 272 | result[j] = true; 273 | } 274 | } 275 | return result; 276 | })(); 277 | 278 | function splitQuery(query) { 279 | var result = []; 280 | var start = -1; 281 | for (var i = 0; i < query.length; i++) { 282 | if (splitChars[query.charCodeAt(i)]) { 283 | if (start !== -1) { 284 | result.push(query.slice(start, i)); 285 | start = -1; 286 | } 287 | } else if (start === -1) { 288 | start = i; 289 | } 290 | } 291 | if (start !== -1) { 292 | result.push(query.slice(start)); 293 | } 294 | return result; 295 | } 296 | 297 | 298 | -------------------------------------------------------------------------------- /docs/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/docs/_static/minus.png -------------------------------------------------------------------------------- /docs/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/docs/_static/plus.png -------------------------------------------------------------------------------- /docs/_static/pygments.css: -------------------------------------------------------------------------------- 1 | pre { line-height: 125%; margin: 0; } 2 | td.linenos pre { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; } 3 | span.linenos { color: #000000; background-color: #f0f0f0; padding-left: 5px; padding-right: 5px; } 4 | td.linenos pre.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 5 | span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; } 6 | .highlight .hll { background-color: #ffffcc } 7 | .highlight { background: #eeffcc; } 8 | .highlight .c { color: #408090; font-style: italic } /* Comment */ 9 | .highlight .err { border: 1px solid #FF0000 } /* Error */ 10 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */ 11 | .highlight .o { color: #666666 } /* Operator */ 12 | .highlight .ch { color: #408090; font-style: italic } /* Comment.Hashbang */ 13 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ 14 | .highlight .cp { color: #007020 } /* Comment.Preproc */ 15 | .highlight .cpf { color: #408090; font-style: italic } /* Comment.PreprocFile */ 16 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ 17 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ 18 | .highlight .gd { color: #A00000 } /* Generic.Deleted */ 19 | .highlight .ge { font-style: italic } /* Generic.Emph */ 20 | .highlight .gr { color: #FF0000 } /* Generic.Error */ 21 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 22 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 23 | .highlight .go { color: #333333 } /* Generic.Output */ 24 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ 25 | .highlight .gs { font-weight: bold } /* Generic.Strong */ 26 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 27 | .highlight .gt { color: #0044DD } /* Generic.Traceback */ 28 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ 29 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ 30 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ 31 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */ 32 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ 33 | .highlight .kt { color: #902000 } /* Keyword.Type */ 34 | .highlight .m { color: #208050 } /* Literal.Number */ 35 | .highlight .s { color: #4070a0 } /* Literal.String */ 36 | .highlight .na { color: #4070a0 } /* Name.Attribute */ 37 | .highlight .nb { color: #007020 } /* Name.Builtin */ 38 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ 39 | .highlight .no { color: #60add5 } /* Name.Constant */ 40 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ 41 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ 42 | .highlight .ne { color: #007020 } /* Name.Exception */ 43 | .highlight .nf { color: #06287e } /* Name.Function */ 44 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ 45 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ 46 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ 47 | .highlight .nv { color: #bb60d5 } /* Name.Variable */ 48 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ 49 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */ 50 | .highlight .mb { color: #208050 } /* Literal.Number.Bin */ 51 | .highlight .mf { color: #208050 } /* Literal.Number.Float */ 52 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */ 53 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */ 54 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */ 55 | .highlight .sa { color: #4070a0 } /* Literal.String.Affix */ 56 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ 57 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */ 58 | .highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */ 59 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ 60 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ 61 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ 62 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ 63 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ 64 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */ 65 | .highlight .sr { color: #235388 } /* Literal.String.Regex */ 66 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ 67 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */ 68 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ 69 | .highlight .fm { color: #06287e } /* Name.Function.Magic */ 70 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ 71 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ 72 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ 73 | .highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */ 74 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /docs/_static/searchtools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * searchtools.js 3 | * ~~~~~~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilities for the full-text search. 6 | * 7 | * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | if (!Scorer) { 13 | /** 14 | * Simple result scoring code. 15 | */ 16 | var Scorer = { 17 | // Implement the following function to further tweak the score for each result 18 | // The function takes a result array [filename, title, anchor, descr, score] 19 | // and returns the new score. 20 | /* 21 | score: function(result) { 22 | return result[4]; 23 | }, 24 | */ 25 | 26 | // query matches the full name of an object 27 | objNameMatch: 11, 28 | // or matches in the last dotted part of the object name 29 | objPartialMatch: 6, 30 | // Additive scores depending on the priority of the object 31 | objPrio: {0: 15, // used to be importantResults 32 | 1: 5, // used to be objectResults 33 | 2: -5}, // used to be unimportantResults 34 | // Used when the priority is not in the mapping. 35 | objPrioDefault: 0, 36 | 37 | // query found in title 38 | title: 15, 39 | partialTitle: 7, 40 | // query found in terms 41 | term: 5, 42 | partialTerm: 2 43 | }; 44 | } 45 | 46 | if (!splitQuery) { 47 | function splitQuery(query) { 48 | return query.split(/\s+/); 49 | } 50 | } 51 | 52 | /** 53 | * Search Module 54 | */ 55 | var Search = { 56 | 57 | _index : null, 58 | _queued_query : null, 59 | _pulse_status : -1, 60 | 61 | htmlToText : function(htmlString) { 62 | var virtualDocument = document.implementation.createHTMLDocument('virtual'); 63 | var htmlElement = $(htmlString, virtualDocument); 64 | htmlElement.find('.headerlink').remove(); 65 | docContent = htmlElement.find('[role=main]')[0]; 66 | if(docContent === undefined) { 67 | console.warn("Content block not found. Sphinx search tries to obtain it " + 68 | "via '[role=main]'. Could you check your theme or template."); 69 | return ""; 70 | } 71 | return docContent.textContent || docContent.innerText; 72 | }, 73 | 74 | init : function() { 75 | var params = $.getQueryParameters(); 76 | if (params.q) { 77 | var query = params.q[0]; 78 | $('input[name="q"]')[0].value = query; 79 | this.performSearch(query); 80 | } 81 | }, 82 | 83 | loadIndex : function(url) { 84 | $.ajax({type: "GET", url: url, data: null, 85 | dataType: "script", cache: true, 86 | complete: function(jqxhr, textstatus) { 87 | if (textstatus != "success") { 88 | document.getElementById("searchindexloader").src = url; 89 | } 90 | }}); 91 | }, 92 | 93 | setIndex : function(index) { 94 | var q; 95 | this._index = index; 96 | if ((q = this._queued_query) !== null) { 97 | this._queued_query = null; 98 | Search.query(q); 99 | } 100 | }, 101 | 102 | hasIndex : function() { 103 | return this._index !== null; 104 | }, 105 | 106 | deferQuery : function(query) { 107 | this._queued_query = query; 108 | }, 109 | 110 | stopPulse : function() { 111 | this._pulse_status = 0; 112 | }, 113 | 114 | startPulse : function() { 115 | if (this._pulse_status >= 0) 116 | return; 117 | function pulse() { 118 | var i; 119 | Search._pulse_status = (Search._pulse_status + 1) % 4; 120 | var dotString = ''; 121 | for (i = 0; i < Search._pulse_status; i++) 122 | dotString += '.'; 123 | Search.dots.text(dotString); 124 | if (Search._pulse_status > -1) 125 | window.setTimeout(pulse, 500); 126 | } 127 | pulse(); 128 | }, 129 | 130 | /** 131 | * perform a search for something (or wait until index is loaded) 132 | */ 133 | performSearch : function(query) { 134 | // create the required interface elements 135 | this.out = $('#search-results'); 136 | this.title = $('

' + _('Searching') + '

').appendTo(this.out); 137 | this.dots = $('').appendTo(this.title); 138 | this.status = $('

 

').appendTo(this.out); 139 | this.output = $('
    ').appendTo(this.out); 140 | 141 | $('#search-progress').text(_('Preparing search...')); 142 | this.startPulse(); 143 | 144 | // index already loaded, the browser was quick! 145 | if (this.hasIndex()) 146 | this.query(query); 147 | else 148 | this.deferQuery(query); 149 | }, 150 | 151 | /** 152 | * execute search (requires search index to be loaded) 153 | */ 154 | query : function(query) { 155 | var i; 156 | 157 | // stem the searchterms and add them to the correct list 158 | var stemmer = new Stemmer(); 159 | var searchterms = []; 160 | var excluded = []; 161 | var hlterms = []; 162 | var tmp = splitQuery(query); 163 | var objectterms = []; 164 | for (i = 0; i < tmp.length; i++) { 165 | if (tmp[i] !== "") { 166 | objectterms.push(tmp[i].toLowerCase()); 167 | } 168 | 169 | if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") { 170 | // skip this "word" 171 | continue; 172 | } 173 | // stem the word 174 | var word = stemmer.stemWord(tmp[i].toLowerCase()); 175 | // prevent stemmer from cutting word smaller than two chars 176 | if(word.length < 3 && tmp[i].length >= 3) { 177 | word = tmp[i]; 178 | } 179 | var toAppend; 180 | // select the correct list 181 | if (word[0] == '-') { 182 | toAppend = excluded; 183 | word = word.substr(1); 184 | } 185 | else { 186 | toAppend = searchterms; 187 | hlterms.push(tmp[i].toLowerCase()); 188 | } 189 | // only add if not already in the list 190 | if (!$u.contains(toAppend, word)) 191 | toAppend.push(word); 192 | } 193 | var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); 194 | 195 | // console.debug('SEARCH: searching for:'); 196 | // console.info('required: ', searchterms); 197 | // console.info('excluded: ', excluded); 198 | 199 | // prepare search 200 | var terms = this._index.terms; 201 | var titleterms = this._index.titleterms; 202 | 203 | // array of [filename, title, anchor, descr, score] 204 | var results = []; 205 | $('#search-progress').empty(); 206 | 207 | // lookup as object 208 | for (i = 0; i < objectterms.length; i++) { 209 | var others = [].concat(objectterms.slice(0, i), 210 | objectterms.slice(i+1, objectterms.length)); 211 | results = results.concat(this.performObjectSearch(objectterms[i], others)); 212 | } 213 | 214 | // lookup as search terms in fulltext 215 | results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms)); 216 | 217 | // let the scorer override scores with a custom scoring function 218 | if (Scorer.score) { 219 | for (i = 0; i < results.length; i++) 220 | results[i][4] = Scorer.score(results[i]); 221 | } 222 | 223 | // now sort the results by score (in opposite order of appearance, since the 224 | // display function below uses pop() to retrieve items) and then 225 | // alphabetically 226 | results.sort(function(a, b) { 227 | var left = a[4]; 228 | var right = b[4]; 229 | if (left > right) { 230 | return 1; 231 | } else if (left < right) { 232 | return -1; 233 | } else { 234 | // same score: sort alphabetically 235 | left = a[1].toLowerCase(); 236 | right = b[1].toLowerCase(); 237 | return (left > right) ? -1 : ((left < right) ? 1 : 0); 238 | } 239 | }); 240 | 241 | // for debugging 242 | //Search.lastresults = results.slice(); // a copy 243 | //console.info('search results:', Search.lastresults); 244 | 245 | // print the results 246 | var resultCount = results.length; 247 | function displayNextItem() { 248 | // results left, load the summary and display it 249 | if (results.length) { 250 | var item = results.pop(); 251 | var listItem = $('
  • '); 252 | var requestUrl = ""; 253 | var linkUrl = ""; 254 | if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') { 255 | // dirhtml builder 256 | var dirname = item[0] + '/'; 257 | if (dirname.match(/\/index\/$/)) { 258 | dirname = dirname.substring(0, dirname.length-6); 259 | } else if (dirname == 'index/') { 260 | dirname = ''; 261 | } 262 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname; 263 | linkUrl = requestUrl; 264 | 265 | } else { 266 | // normal html builders 267 | requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX; 268 | linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX; 269 | } 270 | listItem.append($('').attr('href', 271 | linkUrl + 272 | highlightstring + item[2]).html(item[1])); 273 | if (item[3]) { 274 | listItem.append($(' (' + item[3] + ')')); 275 | Search.output.append(listItem); 276 | listItem.slideDown(5, function() { 277 | displayNextItem(); 278 | }); 279 | } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { 280 | $.ajax({url: requestUrl, 281 | dataType: "text", 282 | complete: function(jqxhr, textstatus) { 283 | var data = jqxhr.responseText; 284 | if (data !== '' && data !== undefined) { 285 | listItem.append(Search.makeSearchSummary(data, searchterms, hlterms)); 286 | } 287 | Search.output.append(listItem); 288 | listItem.slideDown(5, function() { 289 | displayNextItem(); 290 | }); 291 | }}); 292 | } else { 293 | // no source available, just display title 294 | Search.output.append(listItem); 295 | listItem.slideDown(5, function() { 296 | displayNextItem(); 297 | }); 298 | } 299 | } 300 | // search finished, update title and status message 301 | else { 302 | Search.stopPulse(); 303 | Search.title.text(_('Search Results')); 304 | if (!resultCount) 305 | Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); 306 | else 307 | Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); 308 | Search.status.fadeIn(500); 309 | } 310 | } 311 | displayNextItem(); 312 | }, 313 | 314 | /** 315 | * search for object names 316 | */ 317 | performObjectSearch : function(object, otherterms) { 318 | var filenames = this._index.filenames; 319 | var docnames = this._index.docnames; 320 | var objects = this._index.objects; 321 | var objnames = this._index.objnames; 322 | var titles = this._index.titles; 323 | 324 | var i; 325 | var results = []; 326 | 327 | for (var prefix in objects) { 328 | for (var name in objects[prefix]) { 329 | var fullname = (prefix ? prefix + '.' : '') + name; 330 | var fullnameLower = fullname.toLowerCase() 331 | if (fullnameLower.indexOf(object) > -1) { 332 | var score = 0; 333 | var parts = fullnameLower.split('.'); 334 | // check for different match types: exact matches of full name or 335 | // "last name" (i.e. last dotted part) 336 | if (fullnameLower == object || parts[parts.length - 1] == object) { 337 | score += Scorer.objNameMatch; 338 | // matches in last name 339 | } else if (parts[parts.length - 1].indexOf(object) > -1) { 340 | score += Scorer.objPartialMatch; 341 | } 342 | var match = objects[prefix][name]; 343 | var objname = objnames[match[1]][2]; 344 | var title = titles[match[0]]; 345 | // If more than one term searched for, we require other words to be 346 | // found in the name/title/description 347 | if (otherterms.length > 0) { 348 | var haystack = (prefix + ' ' + name + ' ' + 349 | objname + ' ' + title).toLowerCase(); 350 | var allfound = true; 351 | for (i = 0; i < otherterms.length; i++) { 352 | if (haystack.indexOf(otherterms[i]) == -1) { 353 | allfound = false; 354 | break; 355 | } 356 | } 357 | if (!allfound) { 358 | continue; 359 | } 360 | } 361 | var descr = objname + _(', in ') + title; 362 | 363 | var anchor = match[3]; 364 | if (anchor === '') 365 | anchor = fullname; 366 | else if (anchor == '-') 367 | anchor = objnames[match[1]][1] + '-' + fullname; 368 | // add custom score for some objects according to scorer 369 | if (Scorer.objPrio.hasOwnProperty(match[2])) { 370 | score += Scorer.objPrio[match[2]]; 371 | } else { 372 | score += Scorer.objPrioDefault; 373 | } 374 | results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]); 375 | } 376 | } 377 | } 378 | 379 | return results; 380 | }, 381 | 382 | /** 383 | * search for full-text terms in the index 384 | */ 385 | performTermsSearch : function(searchterms, excluded, terms, titleterms) { 386 | var docnames = this._index.docnames; 387 | var filenames = this._index.filenames; 388 | var titles = this._index.titles; 389 | 390 | var i, j, file; 391 | var fileMap = {}; 392 | var scoreMap = {}; 393 | var results = []; 394 | 395 | // perform the search on the required terms 396 | for (i = 0; i < searchterms.length; i++) { 397 | var word = searchterms[i]; 398 | var files = []; 399 | var _o = [ 400 | {files: terms[word], score: Scorer.term}, 401 | {files: titleterms[word], score: Scorer.title} 402 | ]; 403 | // add support for partial matches 404 | if (word.length > 2) { 405 | for (var w in terms) { 406 | if (w.match(word) && !terms[word]) { 407 | _o.push({files: terms[w], score: Scorer.partialTerm}) 408 | } 409 | } 410 | for (var w in titleterms) { 411 | if (w.match(word) && !titleterms[word]) { 412 | _o.push({files: titleterms[w], score: Scorer.partialTitle}) 413 | } 414 | } 415 | } 416 | 417 | // no match but word was a required one 418 | if ($u.every(_o, function(o){return o.files === undefined;})) { 419 | break; 420 | } 421 | // found search word in contents 422 | $u.each(_o, function(o) { 423 | var _files = o.files; 424 | if (_files === undefined) 425 | return 426 | 427 | if (_files.length === undefined) 428 | _files = [_files]; 429 | files = files.concat(_files); 430 | 431 | // set score for the word in each file to Scorer.term 432 | for (j = 0; j < _files.length; j++) { 433 | file = _files[j]; 434 | if (!(file in scoreMap)) 435 | scoreMap[file] = {}; 436 | scoreMap[file][word] = o.score; 437 | } 438 | }); 439 | 440 | // create the mapping 441 | for (j = 0; j < files.length; j++) { 442 | file = files[j]; 443 | if (file in fileMap && fileMap[file].indexOf(word) === -1) 444 | fileMap[file].push(word); 445 | else 446 | fileMap[file] = [word]; 447 | } 448 | } 449 | 450 | // now check if the files don't contain excluded terms 451 | for (file in fileMap) { 452 | var valid = true; 453 | 454 | // check if all requirements are matched 455 | var filteredTermCount = // as search terms with length < 3 are discarded: ignore 456 | searchterms.filter(function(term){return term.length > 2}).length 457 | if ( 458 | fileMap[file].length != searchterms.length && 459 | fileMap[file].length != filteredTermCount 460 | ) continue; 461 | 462 | // ensure that none of the excluded terms is in the search result 463 | for (i = 0; i < excluded.length; i++) { 464 | if (terms[excluded[i]] == file || 465 | titleterms[excluded[i]] == file || 466 | $u.contains(terms[excluded[i]] || [], file) || 467 | $u.contains(titleterms[excluded[i]] || [], file)) { 468 | valid = false; 469 | break; 470 | } 471 | } 472 | 473 | // if we have still a valid result we can add it to the result list 474 | if (valid) { 475 | // select one (max) score for the file. 476 | // for better ranking, we should calculate ranking by using words statistics like basic tf-idf... 477 | var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]})); 478 | results.push([docnames[file], titles[file], '', null, score, filenames[file]]); 479 | } 480 | } 481 | return results; 482 | }, 483 | 484 | /** 485 | * helper function to return a node containing the 486 | * search summary for a given text. keywords is a list 487 | * of stemmed words, hlwords is the list of normal, unstemmed 488 | * words. the first one is used to find the occurrence, the 489 | * latter for highlighting it. 490 | */ 491 | makeSearchSummary : function(htmlText, keywords, hlwords) { 492 | var text = Search.htmlToText(htmlText); 493 | var textLower = text.toLowerCase(); 494 | var start = 0; 495 | $.each(keywords, function() { 496 | var i = textLower.indexOf(this.toLowerCase()); 497 | if (i > -1) 498 | start = i; 499 | }); 500 | start = Math.max(start - 120, 0); 501 | var excerpt = ((start > 0) ? '...' : '') + 502 | $.trim(text.substr(start, 240)) + 503 | ((start + 240 - text.length) ? '...' : ''); 504 | var rv = $('
    ').text(excerpt); 505 | $.each(hlwords, function() { 506 | rv = rv.highlightText(this, 'highlighted'); 507 | }); 508 | return rv; 509 | } 510 | }; 511 | 512 | $(document).ready(function() { 513 | Search.init(); 514 | }); 515 | -------------------------------------------------------------------------------- /docs/_static/underscore.js: -------------------------------------------------------------------------------- 1 | // Underscore.js 1.3.1 2 | // (c) 2009-2012 Jeremy Ashkenas, DocumentCloud Inc. 3 | // Underscore is freely distributable under the MIT license. 4 | // Portions of Underscore are inspired or borrowed from Prototype, 5 | // Oliver Steele's Functional, and John Resig's Micro-Templating. 6 | // For all details and documentation: 7 | // http://documentcloud.github.com/underscore 8 | (function(){function q(a,c,d){if(a===c)return a!==0||1/a==1/c;if(a==null||c==null)return a===c;if(a._chain)a=a._wrapped;if(c._chain)c=c._wrapped;if(a.isEqual&&b.isFunction(a.isEqual))return a.isEqual(c);if(c.isEqual&&b.isFunction(c.isEqual))return c.isEqual(a);var e=l.call(a);if(e!=l.call(c))return false;switch(e){case "[object String]":return a==String(c);case "[object Number]":return a!=+a?c!=+c:a==0?1/a==1/c:a==+c;case "[object Date]":case "[object Boolean]":return+a==+c;case "[object RegExp]":return a.source== 9 | c.source&&a.global==c.global&&a.multiline==c.multiline&&a.ignoreCase==c.ignoreCase}if(typeof a!="object"||typeof c!="object")return false;for(var f=d.length;f--;)if(d[f]==a)return true;d.push(a);var f=0,g=true;if(e=="[object Array]"){if(f=a.length,g=f==c.length)for(;f--;)if(!(g=f in a==f in c&&q(a[f],c[f],d)))break}else{if("constructor"in a!="constructor"in c||a.constructor!=c.constructor)return false;for(var h in a)if(b.has(a,h)&&(f++,!(g=b.has(c,h)&&q(a[h],c[h],d))))break;if(g){for(h in c)if(b.has(c, 10 | h)&&!f--)break;g=!f}}d.pop();return g}var r=this,G=r._,n={},k=Array.prototype,o=Object.prototype,i=k.slice,H=k.unshift,l=o.toString,I=o.hasOwnProperty,w=k.forEach,x=k.map,y=k.reduce,z=k.reduceRight,A=k.filter,B=k.every,C=k.some,p=k.indexOf,D=k.lastIndexOf,o=Array.isArray,J=Object.keys,s=Function.prototype.bind,b=function(a){return new m(a)};if(typeof exports!=="undefined"){if(typeof module!=="undefined"&&module.exports)exports=module.exports=b;exports._=b}else r._=b;b.VERSION="1.3.1";var j=b.each= 11 | b.forEach=function(a,c,d){if(a!=null)if(w&&a.forEach===w)a.forEach(c,d);else if(a.length===+a.length)for(var e=0,f=a.length;e2;a== 12 | null&&(a=[]);if(y&&a.reduce===y)return e&&(c=b.bind(c,e)),f?a.reduce(c,d):a.reduce(c);j(a,function(a,b,i){f?d=c.call(e,d,a,b,i):(d=a,f=true)});if(!f)throw new TypeError("Reduce of empty array with no initial value");return d};b.reduceRight=b.foldr=function(a,c,d,e){var f=arguments.length>2;a==null&&(a=[]);if(z&&a.reduceRight===z)return e&&(c=b.bind(c,e)),f?a.reduceRight(c,d):a.reduceRight(c);var g=b.toArray(a).reverse();e&&!f&&(c=b.bind(c,e));return f?b.reduce(g,c,d,e):b.reduce(g,c)};b.find=b.detect= 13 | function(a,c,b){var e;E(a,function(a,g,h){if(c.call(b,a,g,h))return e=a,true});return e};b.filter=b.select=function(a,c,b){var e=[];if(a==null)return e;if(A&&a.filter===A)return a.filter(c,b);j(a,function(a,g,h){c.call(b,a,g,h)&&(e[e.length]=a)});return e};b.reject=function(a,c,b){var e=[];if(a==null)return e;j(a,function(a,g,h){c.call(b,a,g,h)||(e[e.length]=a)});return e};b.every=b.all=function(a,c,b){var e=true;if(a==null)return e;if(B&&a.every===B)return a.every(c,b);j(a,function(a,g,h){if(!(e= 14 | e&&c.call(b,a,g,h)))return n});return e};var E=b.some=b.any=function(a,c,d){c||(c=b.identity);var e=false;if(a==null)return e;if(C&&a.some===C)return a.some(c,d);j(a,function(a,b,h){if(e||(e=c.call(d,a,b,h)))return n});return!!e};b.include=b.contains=function(a,c){var b=false;if(a==null)return b;return p&&a.indexOf===p?a.indexOf(c)!=-1:b=E(a,function(a){return a===c})};b.invoke=function(a,c){var d=i.call(arguments,2);return b.map(a,function(a){return(b.isFunction(c)?c||a:a[c]).apply(a,d)})};b.pluck= 15 | function(a,c){return b.map(a,function(a){return a[c]})};b.max=function(a,c,d){if(!c&&b.isArray(a))return Math.max.apply(Math,a);if(!c&&b.isEmpty(a))return-Infinity;var e={computed:-Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;b>=e.computed&&(e={value:a,computed:b})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);if(!c&&b.isEmpty(a))return Infinity;var e={computed:Infinity};j(a,function(a,b,h){b=c?c.call(d,a,b,h):a;bd?1:0}),"value")};b.groupBy=function(a,c){var d={},e=b.isFunction(c)?c:function(a){return a[c]};j(a,function(a,b){var c=e(a,b);(d[c]||(d[c]=[])).push(a)});return d};b.sortedIndex=function(a, 17 | c,d){d||(d=b.identity);for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.difference=function(a){var c=b.flatten(i.call(arguments,1));return b.filter(a,function(a){return!b.include(c,a)})};b.zip=function(){for(var a=i.call(arguments),c=b.max(b.pluck(a,"length")),d=Array(c),e=0;e=0;d--)b=[a[d].apply(this,b)];return b[0]}}; 24 | b.after=function(a,b){return a<=0?b():function(){if(--a<1)return b.apply(this,arguments)}};b.keys=J||function(a){if(a!==Object(a))throw new TypeError("Invalid object");var c=[],d;for(d in a)b.has(a,d)&&(c[c.length]=d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=b.methods=function(a){var c=[],d;for(d in a)b.isFunction(a[d])&&c.push(d);return c.sort()};b.extend=function(a){j(i.call(arguments,1),function(b){for(var d in b)a[d]=b[d]});return a};b.defaults=function(a){j(i.call(arguments, 25 | 1),function(b){for(var d in b)a[d]==null&&(a[d]=b[d])});return a};b.clone=function(a){return!b.isObject(a)?a:b.isArray(a)?a.slice():b.extend({},a)};b.tap=function(a,b){b(a);return a};b.isEqual=function(a,b){return q(a,b,[])};b.isEmpty=function(a){if(b.isArray(a)||b.isString(a))return a.length===0;for(var c in a)if(b.has(a,c))return false;return true};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=o||function(a){return l.call(a)=="[object Array]"};b.isObject=function(a){return a===Object(a)}; 26 | b.isArguments=function(a){return l.call(a)=="[object Arguments]"};if(!b.isArguments(arguments))b.isArguments=function(a){return!(!a||!b.has(a,"callee"))};b.isFunction=function(a){return l.call(a)=="[object Function]"};b.isString=function(a){return l.call(a)=="[object String]"};b.isNumber=function(a){return l.call(a)=="[object Number]"};b.isNaN=function(a){return a!==a};b.isBoolean=function(a){return a===true||a===false||l.call(a)=="[object Boolean]"};b.isDate=function(a){return l.call(a)=="[object Date]"}; 27 | b.isRegExp=function(a){return l.call(a)=="[object RegExp]"};b.isNull=function(a){return a===null};b.isUndefined=function(a){return a===void 0};b.has=function(a,b){return I.call(a,b)};b.noConflict=function(){r._=G;return this};b.identity=function(a){return a};b.times=function(a,b,d){for(var e=0;e/g,">").replace(/"/g,""").replace(/'/g,"'").replace(/\//g,"/")};b.mixin=function(a){j(b.functions(a), 28 | function(c){K(c,b[c]=a[c])})};var L=0;b.uniqueId=function(a){var b=L++;return a?a+b:b};b.templateSettings={evaluate:/<%([\s\S]+?)%>/g,interpolate:/<%=([\s\S]+?)%>/g,escape:/<%-([\s\S]+?)%>/g};var t=/.^/,u=function(a){return a.replace(/\\\\/g,"\\").replace(/\\'/g,"'")};b.template=function(a,c){var d=b.templateSettings,d="var __p=[],print=function(){__p.push.apply(__p,arguments);};with(obj||{}){__p.push('"+a.replace(/\\/g,"\\\\").replace(/'/g,"\\'").replace(d.escape||t,function(a,b){return"',_.escape("+ 29 | u(b)+"),'"}).replace(d.interpolate||t,function(a,b){return"',"+u(b)+",'"}).replace(d.evaluate||t,function(a,b){return"');"+u(b).replace(/[\r\n\t]/g," ")+";__p.push('"}).replace(/\r/g,"\\r").replace(/\n/g,"\\n").replace(/\t/g,"\\t")+"');}return __p.join('');",e=new Function("obj","_",d);return c?e(c,b):function(a){return e.call(this,a,b)}};b.chain=function(a){return b(a).chain()};var m=function(a){this._wrapped=a};b.prototype=m.prototype;var v=function(a,c){return c?b(a).chain():a},K=function(a,c){m.prototype[a]= 30 | function(){var a=i.call(arguments);H.call(a,this._wrapped);return v(c.apply(b,a),this._chain)}};b.mixin(b);j("pop,push,reverse,shift,sort,splice,unshift".split(","),function(a){var b=k[a];m.prototype[a]=function(){var d=this._wrapped;b.apply(d,arguments);var e=d.length;(a=="shift"||a=="splice")&&e===0&&delete d[0];return v(d,this._chain)}});j(["concat","join","slice"],function(a){var b=k[a];m.prototype[a]=function(){return v(b.apply(this._wrapped,arguments),this._chain)}});m.prototype.chain=function(){this._chain= 31 | true;return this};m.prototype.value=function(){return this._wrapped}}).call(this); 32 | -------------------------------------------------------------------------------- /docs/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Index — microkanrenpy 1.0 documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
    29 |
    30 |
    31 | 32 | 33 |
    34 | 35 | 36 |

    Index

    37 | 38 |
    39 | _ 40 | | B 41 | | F 42 | | M 43 | | R 44 | | S 45 | | U 46 | 47 |
    48 |

    _

    49 | 50 | 54 | 60 |
    61 | 62 |

    B

    63 | 64 | 68 |
    69 | 70 |

    F

    71 | 72 | 76 | 80 |
    81 | 82 |

    M

    83 | 84 | 93 | 104 |
      85 |
    • 86 | module 87 | 88 |
      • 92 |
    105 | 106 |

    R

    107 | 108 | 112 |
    113 | 114 |

    S

    115 | 116 | 120 |
    121 | 122 |

    U

    123 | 124 | 128 |
    129 | 130 | 131 | 132 |
    133 | 134 |
    135 |
    136 | 183 |
    184 |
    185 |
    186 | ©2017, Massimo Nocentini. 187 | 188 | | 189 | Powered by Sphinx 3.3.1 190 | & Alabaster 0.7.12 191 | 192 |
    193 | 194 | 195 | 196 | 197 | 198 | -------------------------------------------------------------------------------- /docs/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | μkanrenpy — microkanrenpy 1.0 documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
    30 |
    31 |
    32 | 33 | 34 |
    35 | 36 |
    37 |

    μkanrenpy

    38 |
    39 |

    Introduction

    40 |

    Welcome to documentation of μkanrenpy, a pythonic implementation of a 41 | relational interpreter and an effort to port the original code written in 42 | Scheme by Jason Hemann and Daniel P. Friedman. We report 43 | their words to describe what this work is about:

    44 |
    45 |

    This paper presents μKanren, a minimalist language in the miniKanren family of 46 | relational (logic) programming languages. Its implementation comprises fewer 47 | than 40 lines of Scheme. We motivate the need for a minimalist miniKanren 48 | language, and iteratively develop a complete search strategy. Finally, we 49 | demonstrate that through sufficient user-level features one regains much of the 50 | expressiveness of other miniKanren languages. In our opinion its brevity and 51 | simple semantics make μKanren uniquely elegant.

    52 |
    53 |
    54 |
    55 |

    Contents

    56 |

    We organize our thoughts according to the following outline:

    57 |
    58 | 111 |
    112 |

    This documentation is automatically generated using Sphinx, which 113 | provides content search facilities, so a dedicated page is provided 114 | for free for open searches.

    115 |
    116 |
    117 |

    About

    118 |
    119 |
    My name is Massimo Nocentini, I’m:
    123 |
    124 |
    125 |
    126 |
    127 | 128 | 129 |
    130 | 131 |
    132 |
    133 | 181 |
    182 |
    183 |
    184 | ©2017, Massimo Nocentini. 185 | 186 | | 187 | Powered by Sphinx 3.3.1 188 | & Alabaster 0.7.12 189 | 190 | | 191 | Page source 193 |
    194 | 195 | 196 | 197 | 198 | 199 | -------------------------------------------------------------------------------- /docs/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/docs/objects.inv -------------------------------------------------------------------------------- /docs/py-modindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Python Module Index — microkanrenpy 1.0 documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 |
    32 |
    33 |
    34 | 35 | 36 |
    37 | 38 | 39 |

    Python Module Index

    40 | 41 |
    42 | m 43 |
    44 | 45 | 46 | 47 | 49 | 50 | 52 | 55 | 56 | 57 | 60 |
     
    48 | m
    53 | muk 54 |
        58 | muk.core 59 |
    61 | 62 | 63 |
    64 | 65 |
    66 |
    67 | 114 |
    115 |
    116 |
    117 | ©2017, Massimo Nocentini. 118 | 119 | | 120 | Powered by Sphinx 3.3.1 121 | & Alabaster 0.7.12 122 | 123 |
    124 | 125 | 126 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /docs/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | Search — microkanrenpy 1.0 documentation 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 |
    34 |
    35 |
    36 | 37 | 38 |
    39 | 40 |

    Search

    41 |
    42 | 43 |

    44 | Please activate JavaScript to enable the search 45 | functionality. 46 |

    47 |
    48 |

    49 | Searching for multiple words only shows matches that contain 50 | all words. 51 |

    52 |
    53 | 54 | 55 | 56 |
    57 | 58 |
    59 | 60 |
    61 | 62 |
    63 | 64 |
    65 |
    66 | 103 |
    104 |
    105 |
    106 | ©2017, Massimo Nocentini. 107 | 108 | | 109 | Powered by Sphinx 3.3.1 110 | & Alabaster 0.7.12 111 | 112 |
    113 | 114 | 115 | 116 | 117 | 118 | -------------------------------------------------------------------------------- /docs/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({docnames:["index","mclock","primer","reasoned_schemer","under_the_hood","write_the_doc"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.viewcode":1,sphinx:56},filenames:["index.rst","mclock.rst","primer.rst","reasoned_schemer.rst","under_the_hood.rst","write_the_doc.rst"],objects:{"muk.core":{_conj:[4,1,1,""],_disj:[4,1,1,""],_unify:[4,1,1,""],bind:[4,2,1,""],fail:[4,3,1,""],fresh:[4,1,1,""],mplus:[4,2,1,""],run:[4,2,1,""],succeed:[4,3,1,""],unification:[4,2,1,""]},muk:{core:[4,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","function","Python function"],"3":["py","attribute","Python attribute"]},objtypes:{"0":"py:module","1":"py:class","2":"py:function","3":"py:attribute"},terms:{"0i_":4,"100":5,"1982":5,"1\u2081\u2080":2,"1\u2081\u2082":2,"1\u2081\u2083":2,"1\u2081\u2084":2,"1\u2081\u2086":2,"1\u2081\u2087":2,"1\u2081\u2088":2,"1i_":4,"1st":5,"2005":5,"2006":5,"2008":5,"2009":5,"2013":5,"2015":5,"2017":5,"2\u2081\u2082":2,"2\u2081\u2083":2,"2\u2081\u2086":2,"2\u2081\u2087":2,"350":5,"3\u2081\u2080":2,"3\u2081\u2081":2,"3\u2081\u2084":2,"3\u2081\u2085":2,"3\u2081\u2088":2,"3\u2081\u2089":2,"4\u2081\u2080":2,"4\u2081\u2081":2,"4\u2081\u2083":2,"4\u2081\u2084":2,"4\u2081\u2085":2,"4\u2081\u2087":2,"4\u2081\u2088":2,"4\u2081\u2089":2,"5\u2081\u2081":2,"5\u2081\u2083":2,"819k":5,"\u03b1":[1,2,3,4],"\u03b1\u03b2":[2,3],"\u03b1\u03b3":1,"\u03b2":[1,2,3,4],"\u03b3":[1,2,3,4],"\u03b32\u03b3":1,"\u03b3\u03b3":1,"\u03b4":[1,3],"\u03b42\u03b4":1,"\u03b4\u03b4":1,"\u03b4_revers":1,"\u03b5":3,"\u03b7":[0,1,3,4],"\u03b7_invers":4,"\u03bckanren":[0,2,5],"\u03c7":1,"\u03c9":1,"\u2080":2,"\u2081":2,"\u2082":2,"_2\u03b4":1,"abstract":[2,5],"boolean":4,"break":[1,4,5],"case":[2,4,5],"catch":5,"class":[2,4,5],"default":2,"final":[0,2,5],"function":[1,2,4,5],"hello\u2080":2,"import":[1,2,3,4,5],"m2\u03c7":1,"m_of_\u03c7":1,"m_of_m\u03b3":1,"new":[2,4,5],"paperone\u2085":2,"pluto\u2081":2,"public":5,"return":[1,2,3,4],"short":2,"stuhlm\u00fcller":5,"true":[1,2,4],"try":[4,5],"var":[2,4,5],"while":[1,2,4,5],AND:5,BUT:5,CCS:5,FOR:5,For:4,Its:0,NOT:5,One:2,Such:4,THE:5,The:[0,1,2,4,5],Then:5,There:5,USE:5,WITH:5,Will:5,__add__:5,__and__:5,__or__:5,__radd__:5,_addereo:3,_addero:3,_conj:4,_disj:4,_length_leqo:3,_machin:1,_unifi:[3,4],_unify_occur_check:3,about:[2,5],abov:5,absenc:2,acc:1,accept:5,accord:[0,2,4,5],achiev:5,action:5,actual:[2,5],adapt_iterables_to_cons:3,add:[3,4,5],addereo:3,addero:3,address:5,adjac:4,adjust:2,adopt:5,advic:5,afraid:5,after:[4,5],again:[2,5],against:5,ago:5,aim:[2,5],aka:0,alexandria:5,algebra:5,alia:3,aliv:5,all:[2,4,5],all_argu:3,allevi:5,allow:[2,5],along:5,alpha:4,alpha_:4,also:5,although:[2,3,4,5],alwai:[3,5],alwayso:3,ambigu:5,ani:[2,3,5],answer:[3,4,5],anyo:3,appeal:5,appear:[2,3,5],append:[1,5],appendo:[1,2,3],appendso:3,appetit:5,appli:4,applic:[4,5],arbitrari:[2,5],archiv:5,aren:5,arg:[3,4],argument:[1,2,4],aris:5,ariti:[3,4],arrai:4,articl:5,ask:2,assert:5,associ:[2,4,5],associateo:1,assum:4,attempt:[2,4],augment:4,author:5,autom:5,automat:0,auxiliari:5,avail:5,b_2:3,back:0,bad:5,balanc:2,bang:5,base:[3,5],basic:[2,5],beat:5,beauti:5,becaus:[1,2,3,5],been:5,befor:2,begin:4,behavior:2,behaviour:2,being:5,believ:5,belong:4,bernoulli:1,best:5,beta:4,better:0,binari:2,bind:4,binomi:1,birthdat:2,bit:5,bit_ando:3,bit_xoro:3,biter:1,block:2,blog:5,bloomington:5,bodi:2,boilerpl:5,book:5,bool:4,born:5,both:[2,4,5],bound:3,bq1:3,bqd:3,bql:3,breadth:4,breviti:[0,5],brian:2,british:5,bswappendso:3,build:[2,3,4,5],built:4,bumpo:3,bw1:3,bwq1:3,byrd:5,cake:2,calculu:5,call:[2,5],callabl:4,cambridg:5,cameron:5,can:[2,3,4,5],canon:5,capabl:5,car:1,carlo:[0,5],caro:3,ccccc:4,cdr:1,cdro:3,cell:5,cf15:5,chain:4,character:5,charg:5,charm:5,check:5,chunk:5,circular:5,claim:5,clarifi:5,clariti:4,classic:2,claus:5,clean:5,clear:5,client:5,clojur:5,clone:5,close:5,closer:5,coauthor:5,code:0,coin:1,collect:2,columbia:5,column:4,com:5,combin:[2,4,5],combinator:0,come:5,command:0,comment:5,commit:4,commonlisp:5,compact:5,complement:1,complet:[0,4,5],complex:5,complic:5,compos:5,composit:5,compris:[0,5],comput:1,con:[3,5],concept:2,concern:5,concis:5,cond:[0,1,3,4],conda:3,condi:[1,2,3],condit:5,condo:3,condu:3,conf:5,configur:5,congrat:5,conj:[0,3,5],conji:[1,3],connect:5,consequ:[2,5],consid:2,consist:5,conso:3,consol:5,constant:1,constraint:5,construct:5,constructor:2,consum:[2,4],content:5,context:[4,5],continu:[2,4,5],contract:5,contrari:2,contribut:0,copi:5,copyright:5,core:[0,1,2,3,5],correspond:5,could:[2,4],count:5,countabl:[2,4,5],counter:2,cours:[2,5],cover:5,craig_lawo:1,craig_second_lawo:1,credit:5,ctor:[0,3],current:5,curri:2,damag:5,daniel:[0,5],date:5,david:5,ddd:3,deal:5,decentr:5,declar:2,dedic:[0,5],def:[1,2,3,4,5],defaultdict:2,defin:[2,4,5],definit:[2,4,5],delet:3,delimit:3,demonstr:0,denot:[1,2],dens:5,depend:5,depth:[2,4],describ:[0,5],design:5,detail:5,detect:5,develop:[0,5],diagon:4,dict:2,differ:[0,4,5],dimens:4,dippl:5,discov:5,discret:5,discuss:5,disj:[0,1,5],disjunct:2,dispatch:5,distribut:5,divmod_proo:3,divmodo:3,doc:0,docstr:5,doctest:5,document:[0,2,5],doe:5,doesn:[2,5],doing:5,domain:5,don:5,done:5,doubl:5,dovetail:[1,2,4],down:5,drawback:5,drop:5,dsl:5,due:[4,5],dutch:5,dyck:2,dycko:2,each:[2,4,5],easi:5,edit:5,edu:5,educ:5,effort:0,either:[2,4],electron:5,eleg:[0,5],els:[1,4,5],else_claus:[1,2,3],email:5,embed:5,end:4,enhanc:5,enough:5,enumer:[0,2,5],enumerateo:3,equal:2,equalo:3,equat:1,equival:[2,4],eric:5,error:5,essenti:5,evalu:2,even:5,event:5,eventu:4,ever:3,everi:[4,5],exampl:[2,5],exce:5,exceed:2,except:[2,4],excit:5,execut:5,exist:5,exp:1,expect:5,experienc:5,explain:5,explicit:5,explicitli:5,explor:[2,5],expo:3,exposit:5,express:[0,2,5],ext:[1,2,3,4],ext_:4,extend:5,extens:5,extra:4,eyer:5,face:5,facil:[0,5],fact:0,factori:1,fail:[0,3,4,5],fair:[2,4,5],fall:5,fals:[2,3,4],falsehood:2,famili:[0,5],father:2,favor:4,favorit:5,fear:5,featur:0,feel:5,fewer:0,fibo:2,fibonacci:2,field:5,figur:5,file:5,find:5,finit:[4,5],first:[0,1,2,3,4],first_valu:3,fit:5,flat:5,flatteno:3,flattenrevo:3,flaw:5,flip:1,floor:1,florenc:0,follow:[0,1,2,4,5],fond:5,foot:5,forebod:5,forev:4,formal:[2,4],former:2,found:4,four:2,framework:5,frank:5,free:[0,5],fresh:[0,1,3,4,5],friedman:[0,5],from:[1,2,3,4,5],full_addero:3,fun:[2,5],functool:2,fundament:5,furnish:5,futur:0,gain:5,gen_add:3,gener:[0,2,5],gentesto:3,geometr:1,get:[0,2,4],gist:5,git:5,github:[0,5],given:4,goal:[0,5],god:5,going:5,good:5,goodman:5,got:4,grand_fath:2,grandfath:2,grant:5,grasp:5,great:[2,5],greater_than_oneo:3,group:5,groups_with_positions_not:2,gs17:5,guess:5,guid:[2,5],had:5,hakaru:5,half_addero:3,hand:2,handl:5,hangout:5,happen:5,hard:5,has:[4,5],haskel:[1,5],have:[4,5],head:[1,5],healthi:5,hello:2,help:[0,2,4],helper:2,hemann:[0,5],henc:[2,4],henri:2,here:[2,5],herebi:5,hf13:5,hf15:5,hhhh:2,hhhhhh:2,hhhhhhhh:2,hhhhhhhhhh:2,hhhhhhhhv:2,hhhhhhhhvv:2,hhhhhhv:2,hhhhhhvhh:2,hhhhhhvv:2,hhhhhhvvv:2,hhhhv:2,hhhhvhh:2,hhhhvhhhh:2,hhhhvhhv:2,hhhhvhhvv:2,hhhhvv:2,hhhhvvhh:2,hhhhvvv:2,hhhhvvvv:2,hhv:2,hhvhh:2,hhvhhhh:2,hhvhhhhhh:2,hhvhhhhv:2,hhvhhhhvv:2,hhvhhv:2,hhvhhvhh:2,hhvhhvv:2,hhvhhvvv:2,hhvv:2,hhvvhh:2,hhvvhhhh:2,hhvvhhv:2,hhvvhhvv:2,hhvvv:2,hhvvvhh:2,hhvvvv:2,hhvvvvv:2,higher:4,his:5,hit:5,hold:[2,4],holder:5,honest:5,honk:5,hope:5,how:[0,2],howev:[2,5],http:5,humbl:5,ice:2,idea:5,idiomat:5,immedi:5,impl:5,implement:[0,1,2,4],impli:5,implicit:5,impos:5,improv:5,includ:5,independ:5,indexedbas:2,indiana:5,indistinguish:5,infer:5,infinit:[2,4,5],info:5,inform:0,initi:2,inner:2,insid:2,inspit:5,instal:5,instanc:2,instead:5,integ:2,integr:5,interest:[2,5],interfac:[0,2],interleav:[0,4,5],interpret:[0,5],intro:0,introduc:[2,4,5],invers:[0,3,4],invoc:[2,4],isn:5,issu:5,itemgett:1,iter:[0,1,4,5],itertool:4,its:[0,1,4,5],itself:5,jason:[0,2,5],john:2,join:2,just:[2,5],keep:[2,5],kei:5,keyword:2,kind:5,kiselyov:5,knopf:5,know:5,known:5,l_hat:3,ladi:5,lambda:[1,2,3,4,5],languag:0,last:[2,5],later:2,latex:2,latter:2,law:0,ldot:4,ldots_:4,learn:2,leav:2,lectur:5,left:[2,4],len:[2,3],length_equalo:3,length_lto:3,lengthe_leqo:3,lengthi_leqo:3,lengtho:1,leq:3,leqo:1,less:5,let:[2,4,5],level:0,liabil:5,liabl:5,licens:0,lies:2,like:5,limit:[4,5],line:[0,2,3,4,5],linear:[1,4],linear_reverseo:1,link:1,list:[1,2,4,5],listo:3,listofo:3,liter:5,littl:5,load:5,locat:5,lock:[0,5],log:1,logarithm:5,logic:[0,2,4,5],logo:3,logpi:5,lolo:3,look:[0,2,4],lose:5,lot:5,loto:3,love:5,lru_cach:2,lto:3,lvar:3,lying:4,machin:[1,5],made:5,magic:5,mai:5,main:[4,5],mainli:5,maintain:5,make:[0,2,4],mani:[2,5],manipul:5,mantra:5,map:[1,2,4],mapsto:4,massimo:[0,5],master:5,math:1,matrix:4,matur:5,maximum:2,mcculloch:5,mcculloch___o:1,mcculloch__o:1,mcculloch_fifth_ruleo:1,mcculloch_first_ruleo:1,mcculloch_fourth_ruleo:1,mcculloch_lawo:1,mcculloch_o:1,mcculloch_second_ruleo:1,mcculloch_sixth_ruleo:1,mcculloch_third_ruleo:1,mccullocho:1,mean:5,meanwhil:5,meet:2,membero:3,memberrevo:3,memo:3,merchant:5,merg:5,mess:5,messag:5,method:5,methodolog:5,michael:5,microkanren:5,microkanrenpi:5,milner:5,mind:2,minikanran:5,minikanren:[0,5],minim:5,minimalist:0,minuso:3,misteri:5,mit:5,mitpress:5,mix:[2,5],model:5,modifi:5,modul:[0,5],mont:[0,5],month:0,more:[2,4,5],moreov:[2,4,5],most:[2,4,5],mostli:5,motiv:0,mplu:[4,5],much:[0,5],muk:[0,1,2,3,5],multipl:2,multiply_boundo:3,multiply_oddo:3,multiply_repeatedo:3,multiplyo:3,n_h:3,n_hat:3,n_l:3,name:[0,2,3,4,5],namespac:5,nativ:5,natur:2,necessari:5,need:[0,2,4,5],nest:[2,5],never:[4,5],nevero:3,next:[1,4],nice:5,nocentini:[0,5],nolen:5,non:5,none:4,noninfring:5,not_thingo:3,notic:5,notimpl:3,notion:2,noun:2,now:[2,5],nq1:3,nullo:[1,2,3],num:3,number:[2,3,5],nw1:3,obj:4,object:[2,4,5],obs:1,obtain:5,obviou:5,occur:5,occur_check:3,off:5,often:5,oleg:5,onc:3,onceo:3,one:[0,2,5],oneo:3,ones:2,onli:[2,3,4,5],open:[0,5],oper:[1,2],operationo:1,opinion:[0,5],opnumbero:1,order:[2,4,5],org:5,organ:0,origin:[0,2,5],other:[0,2,3,4],otherwis:[4,5],our:[0,2,5],out:[0,1,2,3],out_a:3,out_d:3,outlin:0,output:[2,5],outstand:5,over:[4,5],overrid:5,page:[0,5],pairo:3,paper:[0,5],paperon:2,paradigm:5,paragraph:5,parallel:[4,5],paramet:4,pars:5,particular:[2,4,5],pascal:2,pascalo:2,pass:5,past:0,path:2,paul:2,pdf:1,peopl:0,perform:[4,5],permiss:5,permit:5,person:5,peter:[2,5],pfen:5,phd:[0,5],piec:5,plai:5,plain:5,platform:5,pleas:5,plug:[2,5],plugin:2,pluseo:3,pluso:3,pluto:2,pmembero:3,pmemberso:3,point:[2,5],poisson:1,port:[0,5],portion:5,poso:3,possibl:[2,4,5],post:[4,5],power:5,powo:3,practic:5,predic:2,predo:3,preevent:5,prefer:5,presenc:5,present:[0,2,5],preserv:5,press:5,pretend:4,previou:[2,5],primer:[0,5],primit:[0,5],princip:5,principl:5,probabilist:5,problem:[2,5],proce:[2,4],proceed:5,process:5,produc:[4,5],prof:5,program:[0,5],progress:2,project:[0,1],prolog:[2,5],propos:5,proud:5,proven:5,provid:[0,2,4,5],publish:5,pull:5,pure:5,puriti:5,purpos:5,push:5,put:5,puzzl:[0,5],pykanren:5,pytholog:5,python3:5,python:[0,2,4],q_1:3,q_h:3,q_l:3,qdh:3,ql1:3,qlm:3,qlmr:3,queri:2,question:[3,4,5],quot:5,r7r:5,r_h:3,r_hat:3,rabbit:2,rabbitso:2,raccomand:5,racket:5,rais:[2,3,4],random:1,rang:[2,3],rate:1,raymond:5,reach:[4,5],read:5,readabl:5,readm:0,readthedoc:5,real:5,realiti:5,reason:[0,2,4,5],receiv:[2,4],recent:[2,5],record:[2,5],recur:2,recuro:2,recurs:[0,4,5],recursionerror:[2,4],redund:5,refactor:5,refer:[2,5],referenc:5,refresh:[2,4],refus:5,regain:0,reifi:2,reific:5,rel:2,relat:[0,4,5],releas:5,remain:[2,5],rembero:3,rememb:5,remembr:5,repeat:[2,5],repeato:1,replac:4,repo:5,report:0,repositori:5,repres:[2,4,5],reproduc:5,request:[2,5],requir:[2,5],res:[1,2,3],resembl:[1,2],resourc:5,respect:[1,2,3,4,5],rest:2,restrict:5,result:[2,4],retriev:5,rev:1,revers:1,reverse_list:3,reverseo:1,review:5,rewrit:5,right:[2,4,5],rightmost_repres:3,rkanren:5,root:5,row:4,rs05:5,rs82:5,rubi:5,rule:[1,2,4,5],run:[2,3,4,5],rvar:2,said:2,sake:4,same:[2,4,5],satisfi:[2,4,5],satur:4,scari:5,schedul:4,scheme:[0,5],schemer:[0,4,5],scientif:5,search:[0,2,5],second:[2,3,4,5],section:5,see:2,seem:5,seen:5,select:2,selector:4,selfish:5,sell:5,semant:[0,2],send:5,sens:[2,4,5],seri:5,servic:5,set:[2,4,5],sexp:[3,5],shall:5,share:[2,5],should:5,show:2,shown:2,sidebar:5,silenc:5,silent:5,simpl:[0,2,5],simplic:5,sinc:[2,4],size:1,smachin:1,small:5,smalltalk:5,smcculloch___o:1,smullyan:5,sneak:5,snippet:5,softwar:5,solid:5,solut:[2,5],solv:5,solver:0,some:[2,4,5],someon:5,someth:5,sourc:[4,5],space:[2,4,5],spars:5,special:5,specif:5,sphinx:[0,5],spite:5,split:5,splito:3,src:5,sreverseo:1,stack:4,stackrel:4,stai:2,standard:5,start:[2,3,5],state:[0,2],step:2,stick:5,stochastic_rank:1,stopiter:4,store:5,straighforward:4,strategi:[0,2,4,5],stream:[0,2,5],strip:2,strong:5,structur:[0,5],stuart:5,student:0,studi:2,stuff:5,style:5,sub:4,subfold:5,subject:5,sublicens:5,substanti:5,substitut:[2,4,5],succe:[0,1,3,4],succeed_at_least:3,success:4,suffici:0,sugar:5,suit:5,sullivan:5,sum:[1,2],summar:5,suppli:[2,5],support:0,surpriseo:3,swappendso:3,sword:5,symbol:[2,5],symmetrico:1,sympi:2,syntact:5,system:[2,5],tail:2,take:[2,4],talk:5,target:5,taugh:5,taught:5,tautolog:2,taylor:5,techniqu:5,technolog:0,temptat:5,tenet:5,terror:5,test:5,than:[0,5],thank:5,thei:[2,5],them:5,therefor:[1,2,4,5],thesi:5,thi:[0,2,4],thing:2,think:5,those:5,thought:[0,5],three:2,threeo:3,through:[0,2],thunk:[2,4],tiger:5,tim:5,time:[1,2,3],togeth:5,toi:2,tom:[2,5],too:5,tool:5,top:5,topic:5,topolino:2,tort:5,toward:2,traceback:2,track:[2,5],transform:4,transit:5,travi:5,tree:5,tremend:5,triangl:[2,4],trick:2,trivial:5,truth:2,tutori:5,twinso:3,two:[2,5],twoo:3,type:5,ugli:5,unbalanc:4,uncertainti:5,uncours:5,under:2,underli:[2,5],understand:[4,5],unfold:2,unif:[2,4,5],unifi:[0,1,3,4,5],unify_occur_check:3,uniqu:0,unit:5,univers:[0,5],unless:5,unnest:4,until:4,unwrapo:3,unwrapso:3,upon:5,usag:4,use:[0,2,4],used:[2,5],useless:2,user:[0,5],uses:[2,5],using:[0,2,4],usual:2,util:2,valu:[2,4,5],vancouv:5,vanilla:[4,5],var_selector:[2,4],variabl:[2,4,5],varieti:5,veri:[2,4,5],version:5,vhh:2,vhhhh:2,vhhhhhh:2,vhhhhhhhh:2,vhhhhhhv:2,vhhhhhhvv:2,vhhhhv:2,vhhhhvhh:2,vhhhhvv:2,vhhhhvvv:2,vhhv:2,vhhvhh:2,vhhvhhhh:2,vhhvhhv:2,vhhvhhvv:2,vhhvv:2,vhhvvhh:2,vhhvvv:2,vhhvvvv:2,video:5,view:5,vital:5,vvhh:2,vvhhhh:2,vvhhhhhh:2,vvhhhhv:2,vvhhhhvv:2,vvhhv:2,vvhhvhh:2,vvhhvv:2,vvhhvvv:2,vvv:2,vvvhh:2,vvvhhhh:2,vvvhhv:2,vvvhhvv:2,vvvv:2,vvvvhh:2,vvvvhhv:2,vvvvv:2,vvvvvv:2,wai:[2,5],want:[0,2,4],warranti:5,wb09:5,welcom:0,were:2,what:[0,3],when:[2,4,5],where:[1,2,3,4,5],wherea:3,whet:5,whether:5,which:[0,2,4,5],who:0,whole:[2,4,5],whom:5,whose:4,why:[0,2],william:5,wise:5,within:[2,3],without:[2,5],won:5,word:[0,3,4,5],work:[0,2,5],workflow:5,workshop:5,world:5,would:5,wrap:2,write:[0,2],writer:0,written:[0,4,5],wrote:5,yet:[2,5],yield:[1,2,4],you:0,your:0,zen:5,zeroo:3,zip:3},titles:["\u03bckanrenpy","Monte Carlo Lock puzzle","A Primer","The Reasoned Schemer","muk.core module","Intro"],titleterms:{"\u03b7":2,"\u03bckanrenpi":0,The:3,about:0,aka:5,append:2,back:5,better:5,carlo:1,code:5,combinator:2,command:4,cond:2,conj:2,content:0,contribut:5,core:4,ctor:[2,4],differ:2,disj:2,doc:5,enumer:4,fact:2,fail:2,first:5,five:2,fresh:2,futur:5,get:5,goal:[2,4],help:5,how:5,implement:5,inform:5,interfac:4,interleav:2,intro:5,introduct:0,invers:2,languag:5,law:4,licens:5,link:5,lisp:5,lock:1,look:5,make:5,modul:4,mont:1,month:5,muk:4,nat:2,other:5,out:5,past:5,peopl:5,primer:2,primit:[2,4],project:5,puzzl:1,python:5,readm:5,reason:3,recurs:2,relat:2,schemer:3,solver:4,state:4,stream:4,structur:2,succe:2,support:5,technolog:5,thi:5,unifi:2,use:5,using:5,want:5,what:5,who:5,why:5,write:5,writer:5,you:5,your:5}}) -------------------------------------------------------------------------------- /documentation/.gitignore: -------------------------------------------------------------------------------- 1 | 2 | build/ 3 | -------------------------------------------------------------------------------- /documentation/Makefile: -------------------------------------------------------------------------------- 1 | # Minimal makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | SPHINXPROJ = microkanrenpy 8 | SOURCEDIR = source 9 | BUILDDIR = build 10 | 11 | 12 | .PHONY: help Makefile 13 | 14 | # Catch-all target: route all unknown targets to Sphinx using the new 15 | # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). 16 | html: Makefile 17 | rm -rf build 18 | @$(SPHINXBUILD) -M doctest "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 19 | #@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 20 | @$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 21 | 22 | # Put it first so that "make" without argument is like "make help". 23 | help: 24 | @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) 25 | 26 | deploy: 27 | rm -rf ../docs 28 | cp -r build/html ../docs 29 | -------------------------------------------------------------------------------- /documentation/source/_static/.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/documentation/source/_static/.gitignore -------------------------------------------------------------------------------- /documentation/source/_templates/.gitignore: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/documentation/source/_templates/.gitignore -------------------------------------------------------------------------------- /documentation/source/conf.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python3 2 | # -*- coding: utf-8 -*- 3 | # 4 | # microkanrenpy documentation build configuration file, created by 5 | # sphinx-quickstart on Wed Apr 19 15:20:56 2017. 6 | # 7 | # This file is execfile()d with the current directory set to its 8 | # containing dir. 9 | # 10 | # Note that not all possible configuration values are present in this 11 | # autogenerated file. 12 | # 13 | # All configuration values have a default; values that are commented out 14 | # serve to show the default. 15 | 16 | # If extensions (or modules to document with autodoc) are in another directory, 17 | # add these directories to sys.path here. If the directory is relative to the 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. 19 | # 20 | import os, sys 21 | 22 | sys.path.append(os.path.abspath('../../src/')) 23 | 24 | 25 | # -- General configuration ------------------------------------------------ 26 | 27 | # If your documentation needs a minimal Sphinx version, state it here. 28 | # 29 | # needs_sphinx = '1.0' 30 | 31 | # Add any Sphinx extension module names here, as strings. They can be 32 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 33 | # ones. 34 | extensions = ['sphinx.ext.autodoc', 35 | 'sphinx.ext.doctest', 36 | 'sphinx.ext.mathjax', 37 | 'sphinx.ext.viewcode', 38 | 'sphinx.ext.githubpages'] 39 | 40 | # Add any paths that contain templates here, relative to this directory. 41 | templates_path = ['_templates'] 42 | 43 | # The suffix(es) of source filenames. 44 | # You can specify multiple suffix as a list of string: 45 | # 46 | # source_suffix = ['.rst', '.md'] 47 | source_suffix = '.rst' 48 | 49 | # The master toctree document. 50 | master_doc = 'index' 51 | 52 | # General information about the project. 53 | project = 'microkanrenpy' 54 | copyright = '2017, Massimo Nocentini' 55 | author = 'Massimo Nocentini' 56 | 57 | # The version info for the project you're documenting, acts as replacement for 58 | # |version| and |release|, also used in various other places throughout the 59 | # built documents. 60 | # 61 | # The short X.Y version. 62 | version = '1.0' 63 | # The full version, including alpha/beta/rc tags. 64 | release = '1.0' 65 | 66 | # The language for content autogenerated by Sphinx. Refer to documentation 67 | # for a list of supported languages. 68 | # 69 | # This is also used if you do content translation via gettext catalogs. 70 | # Usually you set "language" from the command line for these cases. 71 | language = None 72 | 73 | # List of patterns, relative to source directory, that match files and 74 | # directories to ignore when looking for source files. 75 | # This patterns also effect to html_static_path and html_extra_path 76 | exclude_patterns = [] 77 | 78 | # The name of the Pygments (syntax highlighting) style to use. 79 | pygments_style = 'sphinx' 80 | 81 | # If true, `todo` and `todoList` produce output, else they produce nothing. 82 | todo_include_todos = False 83 | 84 | 85 | # -- Options for HTML output ---------------------------------------------- 86 | 87 | # The theme to use for HTML and HTML Help pages. See the documentation for 88 | # a list of builtin themes. 89 | # 90 | html_theme = 'alabaster' 91 | 92 | # Theme options are theme-specific and customize the look and feel of a theme 93 | # further. For a list of options available for each theme, see the 94 | # documentation. 95 | # 96 | # html_theme_options = {} 97 | 98 | # Add any paths that contain custom static files (such as style sheets) here, 99 | # relative to this directory. They are copied after the builtin static files, 100 | # so a file named "default.css" will overwrite the builtin "default.css". 101 | html_static_path = ['_static'] 102 | 103 | 104 | # -- Options for HTMLHelp output ------------------------------------------ 105 | 106 | # Output file base name for HTML help builder. 107 | htmlhelp_basename = 'microkanrenpydoc' 108 | 109 | 110 | # -- Options for LaTeX output --------------------------------------------- 111 | 112 | latex_elements = { 113 | # The paper size ('letterpaper' or 'a4paper'). 114 | # 115 | # 'papersize': 'letterpaper', 116 | 117 | # The font size ('10pt', '11pt' or '12pt'). 118 | # 119 | # 'pointsize': '10pt', 120 | 121 | # Additional stuff for the LaTeX preamble. 122 | # 123 | # 'preamble': '', 124 | 125 | # Latex figure (float) alignment 126 | # 127 | # 'figure_align': 'htbp', 128 | } 129 | 130 | # Grouping the document tree into LaTeX files. List of tuples 131 | # (source start file, target name, title, 132 | # author, documentclass [howto, manual, or own class]). 133 | latex_documents = [ 134 | (master_doc, 'microkanrenpy.tex', 'microkanrenpy Documentation', 135 | 'Massimo Nocentini', 'manual'), 136 | ] 137 | 138 | 139 | # -- Options for manual page output --------------------------------------- 140 | 141 | # One entry per manual page. List of tuples 142 | # (source start file, name, description, authors, manual section). 143 | man_pages = [ 144 | (master_doc, 'microkanrenpy', 'microkanrenpy Documentation', 145 | [author], 1) 146 | ] 147 | 148 | 149 | # -- Options for Texinfo output ------------------------------------------- 150 | 151 | # Grouping the document tree into Texinfo files. List of tuples 152 | # (source start file, target name, title, author, 153 | # dir menu entry, description, category) 154 | texinfo_documents = [ 155 | (master_doc, 'microkanrenpy', 'microkanrenpy Documentation', 156 | author, 'microkanrenpy', 'One line description of project.', 157 | 'Miscellaneous'), 158 | ] 159 | 160 | 161 | 162 | -------------------------------------------------------------------------------- /documentation/source/index.rst: -------------------------------------------------------------------------------- 1 | .. microkanrenpy documentation master file, created by 2 | sphinx-quickstart on Wed Apr 19 15:20:56 2017. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | ========= 7 | μkanrenpy 8 | ========= 9 | 10 | Introduction 11 | ------------ 12 | 13 | Welcome to documentation of *μkanrenpy*, a *pythonic* implementation of a 14 | *relational interpreter* and an effort to port the `original code written in 15 | Scheme `_ by Jason Hemann and Daniel P. Friedman. We report 16 | their words to describe what this work is about: 17 | 18 | This paper presents μKanren, a minimalist language in the miniKanren family of 19 | relational (logic) programming languages. Its implementation comprises fewer 20 | than 40 lines of Scheme. We motivate the need for a minimalist miniKanren 21 | language, and iteratively develop a complete search strategy. Finally, we 22 | demonstrate that through sufficient user-level features one regains much of the 23 | expressiveness of other miniKanren languages. In our opinion its brevity and 24 | simple semantics make μKanren uniquely elegant. 25 | 26 | Contents 27 | -------- 28 | We organize our thoughts according to the following outline: 29 | 30 | 31 | .. toctree:: 32 | :maxdepth: 3 33 | 34 | write_the_doc 35 | primer 36 | reasoned_schemer 37 | mclock 38 | under_the_hood 39 | 40 | This documentation is automatically generated using `Sphinx `_, which 41 | provides content search facilities, so a `dedicated page `_ is provided 42 | for free for open searches. 43 | 44 | About 45 | ----- 46 | My name is Massimo Nocentini, I'm: 47 | * a PhD student @ `University of Florence `_ 48 | * coding @ `GitHub `_ 49 | 50 | .. * :ref:`modindex` 51 | * :ref:`genindex` 52 | * :ref:`search` 53 | 54 | .. REFERENCES {{{ 55 | 56 | 57 | .. _microkanren_scheme: https://github.com/jasonhemann/microKanren 58 | .. _sphinx: http://www.sphinx-doc.org/en/stable/ 59 | .. _unifi: http://www.unifi.it/ 60 | 61 | .. }}} 62 | -------------------------------------------------------------------------------- /documentation/source/mclock.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _montecarlo_lock: 3 | 4 | *********************** 5 | Monte Carlo Lock puzzle 6 | *********************** 7 | 8 | .. literalinclude:: ../../src/mclock.py 9 | -------------------------------------------------------------------------------- /documentation/source/reasoned_schemer.rst: -------------------------------------------------------------------------------- 1 | 2 | .. _reasoned_schemer: 3 | 4 | ******************** 5 | The Reasoned Schemer 6 | ******************** 7 | 8 | .. literalinclude:: ../../src/reasonedschemer.py 9 | -------------------------------------------------------------------------------- /documentation/source/under_the_hood.rst: -------------------------------------------------------------------------------- 1 | 2 | 3 | ``muk.core`` module 4 | =================== 5 | .. automodule:: muk.core 6 | 7 | Primitive goals and ctors 8 | ~~~~~~~~~~~~~~~~~~~~~~~~~ 9 | .. autoclass:: muk.core.succeed 10 | .. autoclass:: muk.core.fail 11 | .. autoclass:: muk.core._disj 12 | .. autoclass:: muk.core._conj 13 | .. autoclass:: muk.core.fresh 14 | .. autoclass:: muk.core._unify 15 | .. autofunction:: muk.core.unification 16 | 17 | States streams and enumerations 18 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 19 | .. autofunction:: muk.core.mplus 20 | .. autofunction:: muk.core.bind 21 | 22 | Solver and interface 23 | ~~~~~~~~~~~~~~~~~~~~ 24 | .. autofunction:: muk.core.run 25 | -------------------------------------------------------------------------------- /src/Makefile: -------------------------------------------------------------------------------- 1 | 2 | PYTHON = python3.6 3 | 4 | 5 | difference_structures: 6 | $(PYTHON) -m unittest -v difference_structures_test.py 7 | 8 | mclock: 9 | $(PYTHON) -m unittest -v mclock_test.py 10 | 11 | muk: 12 | $(PYTHON) -m unittest -v microkanren_test.py 13 | 14 | sexp: 15 | $(PYTHON) -m unittest -v sexp_test.py 16 | 17 | reasoned_schemer: 18 | $(PYTHON) -m unittest -v reasonedschemer_test.py 19 | 20 | suite: sexp muk reasoned_schemer mclock difference_structures 21 | -------------------------------------------------------------------------------- /src/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/src/__init__.py -------------------------------------------------------------------------------- /src/difference_structures_test.py: -------------------------------------------------------------------------------- 1 | 2 | import unittest 3 | 4 | from muk.core import * 5 | from muk.ext import * 6 | 7 | class difference_structures_test(unittest.TestCase): 8 | 9 | def test_extend_list(self): 10 | self.assertEqual(run(fresh(lambda α: unify([]+α, []))), [[]]) 11 | self.assertEqual(run(fresh(lambda β, α: unify([]+α, β))), [[]+rvar(0)]) 12 | self.assertEqual(run(fresh(lambda α: unify([1, 2, 3]+α, [1,2]))), []) 13 | self.assertEqual(run(fresh(lambda α: unify([1, 2, 3]+α, [1,2,3]))), [[]]) 14 | self.assertEqual(run(fresh(lambda α: unify([1, 2, 3]+α, [1,2,3,4,5,6,7]))), [[4,5,6,7]]) 15 | self.assertEqual(run(fresh(lambda α, β: unify([1, 2, 3]+α, [1,2,3,4,5]+β))), [[4,5]+rvar(0)]) 16 | self.assertEqual(run(fresh(lambda out, α, β: unify([1, 2, 3]+α, [1,2,3,4,5]+β) & unify([α, β], out))), [[[4,5]+rvar(0), rvar(0)]]) 17 | self.assertEqual(run(fresh(lambda out, α, β: unify([1, 2, 3]+α, [1,2,3,4,5]+β) & 18 | unify(β, [6,7,8]) & 19 | unify([α, β], out))), [[[4,5,6,7,8], [6,7,8]]]) 20 | self.assertEqual(run(fresh(lambda X, Y, α, β, : 21 | unify([1,2,3]+α, X) & 22 | unify([4,5,6]+β, Y) & 23 | unify(α, Y))), [[1,2,3,4,5,6]+rvar(0)]) 24 | 25 | def test_difference_list(self): 26 | self.assertEqual(run(fresh(lambda out, α: unify(α - α, out))), [ [] ]) # the null difference list 27 | self.assertEqual(run(fresh(lambda out, α: unify(([]+α) - α, out))), [ ([]+rvar(0))-rvar(0) ]) # the null difference list 28 | self.assertEqual(run(fresh(lambda β, α: unify(([1,2,3]+α)-α, β))), [([1,2,3]+rvar(0))-rvar(0)]) 29 | self.assertEqual(run(fresh(lambda β, α: rectify(([1,2,3]+α)-α, β))), [ [1,2,3] ]) 30 | self.assertEqual(run(fresh(lambda α: unify(([1,2,3]+α)-α, [1,2,3]))), [rvar(0)]) 31 | self.assertEqual(run(fresh(lambda α: unify(([1,2,3]+α)-α, [1,2]))), []) 32 | self.assertEqual(run(fresh(lambda α: unify(([1,2,3]+α)-α, [1,2,3,4]))), []) 33 | self.assertEqual(run(fresh(lambda β, α: unify(([1,2,3]+α)-α, [1,2,3]+β))), [[]]) 34 | self.assertEqual(run(fresh(lambda α, β: unify(([1,2,3]+α)-α, [1,2,3]+β))), [rvar(0)]) 35 | self.assertEqual(run(fresh(lambda β, α: unify(([1,2,3]+α)-α, [1,2,3,4]+β))), []) 36 | self.assertEqual(run(fresh(lambda β, α: unify(([1,2,3]+α)-α, [1,2]+β))), [[3]]) 37 | self.assertEqual(run(fresh(lambda α, β: unify(([1,2,3]+α)-α, [1,2]+β))), [rvar(0)]) 38 | self.assertEqual(run(fresh(lambda out, X, Y, x, y, α, β, : 39 | unify([1,2,3]+α, x) & unify(x-α, X) & 40 | unify([4,5,6]+β, y) & unify(y-β, Y) & 41 | unify(x-β, out))), [([1,2,3]+rvar(0))-rvar(1)]) 42 | self.assertEqual(run(fresh(lambda out, X, Y, x, y, α, β, : 43 | unify([1,2,3]+α, x) & unify(x-α, X) & 44 | unify([4,5,6]+β, y) & unify(y-β, Y) & 45 | unify(α, y) & 46 | unify(x-β, out))), [([1,2,3,4,5,6]+rvar(0))-rvar(0)]) 47 | self.assertEqual(run(fresh(lambda out, X, Y, x, y, α, β, : 48 | unify([1,2,3]+α, x) & unify(x-α, X) & 49 | unify([4,5,6]+β, y) & unify(α-β, Y) & 50 | unify(x-β, out))), [([1,2,3]+rvar(0))-rvar(1)]) 51 | self.assertEqual(run(fresh(lambda out, X, Y, x, α, β, : 52 | unify([1,2,3]+α, x) & unify(x-α, X) & 53 | unify([4,5,6]+β, α) & unify(α-β, Y) & 54 | unify(x-β, out))), [([1,2,3,4,5,6]+rvar(0))-rvar(0)]) 55 | 56 | 57 | def test_appendo(self): 58 | 59 | def appendo(X, Y, XY): 60 | return fresh(lambda α, β, γ: unify(X, α-β) & unify(Y, β-γ) & unify(XY, α-γ)) 61 | 62 | self.assertEqual(run(fresh(lambda αβ, α, β: appendo(([1,2,3]+α)-α, ([4,5,6]+β)-β, αβ))), 63 | [([1,2,3,4,5,6]+rvar(0))-rvar(0)]) 64 | self.assertEqual(run(fresh(lambda out, X, Y, α, β: appendo(([1,2,3]+α)-α, ([4,5,6]+β)-β, X-Y) & 65 | unify([X, Y], out))), 66 | [[[1, 2, 3, 4, 5, 6] + rvar(0), rvar(0)]]) 67 | 68 | 69 | 70 | 71 | -------------------------------------------------------------------------------- /src/mclock.py: -------------------------------------------------------------------------------- 1 | 2 | from muk.core import * 3 | from muk.ext import * 4 | import random, math 5 | 6 | def machine(*, rules): 7 | def M(α, β): 8 | return condi(*[[r(α, β, machine=M), succeed] for r in rules], dovetail=True) 9 | return M 10 | 11 | def _machine(*, rules): 12 | def M(α, β): 13 | return disj(*[r(α, β, machine=M) for r in rules], dovetail=True) 14 | return M 15 | 16 | def smachine(*, rules): 17 | def M(α, β): 18 | return conds(*[[rv, r(α, β, machine=M), succeed] for rv, r in rules], dovetail=True) 19 | return M 20 | 21 | def nullo(l): 22 | return unify([], l) 23 | 24 | def appendo(r, s, out): 25 | 26 | def A(r, out): 27 | return conde([nullo(r), unify(s, out)], 28 | else_clause=fresh(lambda a, d, res: 29 | unify([a]+d, r) & 30 | unify([a]+res, out) & 31 | fresh(lambda: A(d, res)))) 32 | return A(r, out) 33 | 34 | def reverseo(a, l): 35 | ''' 36 | The following implementation resembles the following Haskell equations: 37 | 38 | reverse :: [a] -> [a] 39 | reverse [] = [] 40 | reverse (x:xs) = reverse xs ++ [x] 41 | 42 | where `++` denotes the `append` function, therefore it computes in $O(n^{2})$ 43 | because `++` computes in linear time respect to the size of its first list argument. 44 | ''' 45 | return conde([nullo(a), nullo(l)], 46 | else_clause=fresh(lambda car, cdr, res: 47 | unify([car]+cdr, a) & 48 | appendo(res, [car], l) & 49 | fresh(lambda: reverseo(cdr, res)))) 50 | 51 | def linear_reverseo(a, l): 52 | ''' 53 | The following implementation resembles the following Haskell equations: 54 | 55 | reverse :: [a] -> [a] 56 | reverse xs = rev xs [] 57 | where rev [] ys = ys 58 | rev (x:xs) ys = rev xs (x:ys) 59 | ''' 60 | def ro(xs, ys): 61 | return condi([nullo(xs), unify(ys, l)], 62 | else_clause=fresh(lambda car, cdr: 63 | unify([car]+cdr, xs) @ fresh(lambda: ro(cdr, [car]+ys)))) 64 | return fresh(lambda ys: nullo(ys) & ro(a, ys)) 65 | 66 | def sreverseo(a, l): 67 | return conde([nullo(a), nullo(l)], 68 | else_clause=fresh(lambda car, cdr, res: 69 | stochastic_rank([geometric(p=1/2), unify([car]+cdr, a)], 70 | [geometric(p=1/3), appendo(res, [car], l)], 71 | [geometric(p=1/10), fresh(lambda: sreverseo(cdr, res))], 72 | link=conji))) 73 | 74 | def associateo(γ, γ2γ): 75 | return appendo(γ, [2]+γ, γ2γ) 76 | 77 | def symmetrico(α, reverseo=reverseo): 78 | return reverseo(α, α) 79 | 80 | def repeato(γ, γγ): 81 | return appendo(γ, γ, γγ) 82 | 83 | def mcculloch_first_ruleo(α, β, *, machine): 84 | return unify([2]+β, α) 85 | 86 | def mcculloch_second_ruleo(α, δ2δ, *, machine): 87 | return fresh(lambda η, δ: unify([3]+η, α) & associateo(δ, δ2δ) & machine(η, δ)) 88 | 89 | def mcculloch_third_ruleo(α, δ_reversed, *, machine, reverseo=reverseo): 90 | return fresh(lambda η, δ: unify([4]+η, α) & reverseo(δ, δ_reversed) & machine(η, δ)) 91 | 92 | def mcculloch_fourth_ruleo(α, δδ, *, machine): 93 | return fresh(lambda η, δ: unify([5]+η, α) & repeato(δ, δδ) & machine(η, δ)) 94 | 95 | def mcculloch_fifth_ruleo(α, β, *, machine): 96 | return appendo([2]+β, [2], α) 97 | 98 | def mcculloch_sixth_ruleo(α, _2δ, *, machine): 99 | return fresh(lambda η, δ: unify([6]+η, α) @ unify([2]+δ, _2δ) @ machine(η, δ)) 100 | 101 | mccullocho = machine(rules=[ mcculloch_second_ruleo, mcculloch_first_ruleo, ]) 102 | 103 | def mcculloch_lawo(γ, αγ, *, machine=mccullocho): 104 | return fresh(lambda α: appendo([3, 2]+α, [3], γ) @ 105 | appendo(α, γ, αγ) @ 106 | complement(nullo(α)) @ 107 | complement(nullo(γ)) @ 108 | machine(γ, αγ)) 109 | 110 | def lengtho(α, l): 111 | 112 | def L(α, *, acc): 113 | return conde([nullo(α), unify(l, acc)], 114 | else_clause=fresh(lambda a, β: unify([a]+β, α) & fresh(lambda: L(β, acc=acc+1)))) 115 | 116 | return L(α, acc=0) 117 | 118 | def leqo(a, b): 119 | return project(a, b, into=lambda a, b: unify(True, a <= b)) 120 | 121 | 122 | mcculloch_o = machine(rules=[ mcculloch_second_ruleo, mcculloch_third_ruleo, mcculloch_first_ruleo, ]) 123 | mcculloch__o = machine(rules=[ mcculloch_second_ruleo, mcculloch_fourth_ruleo, 124 | mcculloch_third_ruleo, mcculloch_first_ruleo, ]) 125 | 126 | def opnumbero(α): 127 | return disj(nullo(α), fresh(lambda a, β: 128 | appendo(β, [a], α) @ 129 | condi([unify(a, 3), succeed], 130 | [unify(a, 4), succeed], 131 | [unify(a, 5), succeed]) @ 132 | fresh(lambda: opnumbero(β)))) 133 | 134 | 135 | def operationo(M, χ, M_of_χ, *, machine=mcculloch__o): 136 | return fresh(lambda M2χ: appendo(M, [2]+χ, M2χ) @ machine(M2χ, M_of_χ)) 137 | 138 | def craig_lawo(Mγ, M_of_Mγ, *, machine=mcculloch__o): 139 | return fresh(lambda γ: mcculloch_lawo(γ, Mγ) @ machine(Mγ, M_of_Mγ)) 140 | 141 | def craig_second_lawo(Mγ, M_of_Mγ, *, machine=mcculloch__o): 142 | return fresh(lambda γ, M, A: mcculloch_lawo(γ, Mγ) @ appendo(A, M, Mγ) @ machine(Mγ, M_of_Mγ)) 143 | 144 | mcculloch___o = machine(rules=[ mcculloch_fourth_ruleo, mcculloch_third_ruleo, 145 | mcculloch_sixth_ruleo, mcculloch_fifth_ruleo ]) 146 | 147 | def bernoulli(p): 148 | 149 | def pdf(k): 150 | return p**k * (1-p)**(1-k) 151 | 152 | while True: 153 | obs = 1 if random.random() <= p else 0 154 | yield obs, pdf(obs) 155 | 156 | def binomial(n, p): 157 | 158 | def B(n, p): 159 | return math.factorial(n)//(math.factorial(p)*math.factorial(n-p)) 160 | 161 | def pdf(k): 162 | return B(n, k) * p**k * (1-p)**(n-k) 163 | 164 | coins = [bernoulli(p)] * n 165 | while True: 166 | flips = map(operator.itemgetter(0), map(next, coins)) 167 | obs = sum(flips) 168 | yield obs, pdf(obs) 169 | 170 | def geometric(p): 171 | 172 | def pdf(k): 173 | return (1-p)**(k-1) * p 174 | 175 | Biter = iter(bernoulli(p)) 176 | def G(): 177 | i=0 178 | while True: 179 | i+=1 180 | head, p = next(Biter) 181 | if head: break 182 | return i 183 | 184 | while True: 185 | obs = G() 186 | yield obs, pdf(obs) 187 | 188 | def constant(v, p): 189 | 190 | def pdf(k): 191 | return p if k == v else 0 192 | 193 | while True: 194 | obs = v 195 | yield obs, pdf(obs) 196 | 197 | def poisson(rate): 198 | 199 | def pdf(k): 200 | return math.exp(-rate) * rate**k / math.factorial(k) 201 | 202 | while True: 203 | u = random.random() 204 | t = -math.log(1-u)/rate 205 | obs = math.floor(t) 206 | yield obs, pdf(obs) 207 | 208 | α = geometric(p=.5) 209 | β = geometric(p=.5) 210 | γ = geometric(p=.8) 211 | η = geometric(p=.1) 212 | ω = constant(v=2, p=.5) 213 | 214 | smcculloch___o = smachine(rules=[ [γ, mcculloch_fourth_ruleo], 215 | [α, mcculloch_third_ruleo], 216 | [β, mcculloch_sixth_ruleo], 217 | [η, mcculloch_fifth_ruleo] ]) 218 | 219 | -------------------------------------------------------------------------------- /src/mclock_test.py: -------------------------------------------------------------------------------- 1 | 2 | import unittest 3 | 4 | from functools import partial 5 | from contextlib import suppress 6 | 7 | from muk.core import * 8 | from muk.ext import * 9 | from muk.sexp import * 10 | from muk.utils import * 11 | 12 | from mclock import * 13 | 14 | 15 | class mcculloch_test(unittest.TestCase): 16 | 17 | def setUp(self): 18 | self.maxDiff = None 19 | 20 | def test_appendo(self): 21 | self.assertEqual(run(fresh(lambda α: appendo([1,2,3], [4, 5,6], α))), [[1,2,3,4,5,6]]) 22 | 23 | def test_fst_rule(self): 24 | self.assertEqual(run(mccullocho([2,3,4,5], [3,4,5])), [Tautology()]) 25 | self.assertEqual(run(fresh(lambda α, β: mccullocho([4]+β, α))), []) 26 | self.assertEqual(run(fresh(lambda α: mccullocho([2,3,4,5], α))), [[3,4,5]]) 27 | self.assertEqual(run(fresh(lambda α: mccullocho(α, [3,4,5]))), [[2,3,4,5]]) 28 | 29 | 30 | def test_snd_rule(self): 31 | self.assertEqual(run(mccullocho([3,2,5], [5,2,5])), [Tautology()]) 32 | self.assertEqual(run(fresh(lambda α: mccullocho([3,3,2,5], α)), n=1), [[5,2,5,2,5,2,5]]) 33 | self.assertEqual(run(fresh(lambda β: mccullocho(β, [5,2,5,2,5,2,5]))), 34 | [[3, 3, 2, 5], [2, 5, 2, 5, 2, 5, 2, 5], [3, 2, 5, 2, 5]]) 35 | 36 | def test_third_rule(self): 37 | self.assertEqual(run(fresh(lambda α: mcculloch_o([4,2,7,6,9,5], α)), n=1), [[5,9,6,7]]) 38 | 39 | def test_a_curious_number_machine_chapter(self): 40 | self.assertEqual(run(fresh(lambda α: mccullocho(α, α)), n=1), [[3,2,3]]) # 1 41 | self.assertEqual(run(fresh(lambda α, β: conj(associateo(α, β), mccullocho(α, β))), n=1), [[3, 3, 2, 3, 3]]) # 2 42 | with let([3, 3, 2, 3, 3]) as N: self.assertEqual(run(fresh(lambda α: mccullocho(N, α)), n=1), [N+[2]+N]) # 2.1 43 | self.assertEqual(run(fresh(lambda α: mccullocho(α, [7]+α)), n=1), [[3,2,7,3]]) # 5 44 | self.assertEqual(run(fresh(lambda α, β: conj(mccullocho([3]+α, β), associateo(α, β),)), n=1), [[3, 2, 3]]) # 6 45 | self.assertEqual(run(fresh(lambda α, β: conj(associateo([3]+α, β), mccullocho(α, β),)), n=1), [[3, 3, 2, 3, 3, 3]]) # 7 46 | self.assertEqual(run(fresh(lambda γ: mcculloch_lawo(γ, [7]+γ)), n=1), [[3, 2, 7, 3]]) # 8, generalizes 5 47 | self.assertEqual(run(fresh(lambda out, γ, αγ: conj(mcculloch_lawo(γ, αγ), 48 | unify([γ, αγ], out))), n=2), 49 | [[[3, 2, rvar(0), 3], [rvar(0), 3, 2, rvar(0), 3]], 50 | [[3, 2, rvar(0), rvar(1), 3], [rvar(0), rvar(1), 3, 2, rvar(0), rvar(1), 3]]]) # proof of 8 51 | with let([5,6]) as A: 52 | self.assertEqual(run(fresh(lambda γ, Aγ, Aγ2Aγ: conji(appendo(A, γ, Aγ), 53 | associateo(Aγ, Aγ2Aγ), 54 | mccullocho(γ, Aγ2Aγ))), n=1), [[3, 3, 2, 5, 6, 3, 3]]) # 9 55 | self.assertEqual(run(fresh(lambda out, α, γ, αγ, αγ2αγ: conji(appendo([3, 3, 2]+α, [3, 3], γ), 56 | appendo(α, γ, αγ), 57 | associateo(αγ, αγ2αγ), 58 | mccullocho(γ, αγ2αγ), 59 | unify([α, γ], out))), n=4), 60 | [[[], [3, 3, 2, 3, 3]], 61 | [[rvar(0)], [3, 3, 2, rvar(0), 3, 3]], 62 | [[rvar(0), rvar(1)], [3, 3, 2, rvar(0), rvar(1), 3, 3]], 63 | [[rvar(0), rvar(1), rvar(2)], [3, 3, 2, rvar(0), rvar(1), rvar(2), 3, 3]]]) # proof of 9 64 | self.assertEqual(run(fresh(lambda ν, ν2ν, ν2ν2ν2ν: conji(associateo(ν, ν2ν), 65 | associateo(ν2ν, ν2ν2ν2ν), 66 | mccullocho(ν, ν2ν2ν2ν))), n=1), [[3, 3, 3, 2, 3, 3, 3]]) # 10 67 | self.assertEqual(run(fresh(lambda α: mccullocho([3]+α, [3]+α)), n=1), [[2,3]]) # 12, a particular case of 1 68 | self.assertEqual(run(fresh(lambda α: mccullocho([3]+α, [2]+α)), n=1), [[2,2]]) # 13 69 | self.assertEqual(run(fresh(lambda α: mccullocho([3]+α, [3, 2]+α)), n=1), [[2,3,2]]) # 13 70 | self.assertEqual(run(fresh(lambda α, αα, ααα, ααα2, _3α2, β: 71 | conji(appendo(α, α, αα), appendo(α, αα, ααα), appendo(ααα, [2], ααα2), 72 | appendo([3]+α, [2], _3α2), 73 | mccullocho(ααα2, β), 74 | mccullocho(_3α2, β),)), n=1), [[2]]) # 15 75 | self.assertEqual(run(fresh(lambda γ, γ2γ, γγ: conji(associateo(γ, γ2γ), 76 | appendo(γ, γ, γγ), 77 | mccullocho(γ2γ, γγ))), n=10), 78 | [[], 79 | [2]*1, 80 | [2]*2, 81 | [2]*3, 82 | [2]*4, 83 | [2]*5, 84 | [2]*6, 85 | [2]*7, 86 | [2]*8, 87 | [2]*9, 88 | ]) # 16 89 | self.assertEqual(run(fresh(lambda γ, γ2γ, γγ: conji(associateo(γ, γ2γ), 90 | appendo(γ, γ, γγ), 91 | mccullocho(γγ, γ2γ))), n=1), # just as the previous one with swapped args 92 | [[3,2]]) # 17 93 | self.assertEqual(run(fresh(lambda ν, ν2ν, ν2ν2ν2ν: conji(associateo(ν, ν2ν), 94 | associateo(ν2ν, ν2ν2ν2ν), 95 | mccullocho(ν2ν, ν2ν2ν2ν))), n=1), [[3,3]]) # 18 96 | self.assertEqual(run(fresh(lambda α, α23: conji(appendo(α, [2,3], α23), mccullocho(α, α23))), n=1), [[3,2,3,2,3]]) # 19 97 | 98 | 99 | @unittest.skip('Unsatisfiable goals but running forever') 100 | def test_hopeless(self): 101 | 102 | # TODO: fix the following when we'll have the constraint system 103 | self.assertEqual(run(fresh(lambda α, α2, α2α, α2_l, α2α_l: 104 | conji(mccullocho(α, α2α), lengtho(α2α, α2α_l), 105 | appendo(α, [2], α2), lengtho(α2, α2_l), 106 | leqo(α2α_l, α2_l), # having constraints could be helpful 107 | mccullocho(α, α2))), n=1), []) # 20 108 | 109 | def test_lengtho(self): 110 | self.assertEqual(run(fresh(lambda l: lengtho([3,2,8,7], l))), [4]) 111 | with self.assertRaises(RecursionError): 112 | self.assertEqual(run(fresh(lambda l, α: lengtho([3,2,8,7]+α, l))), [5]) 113 | 114 | @unittest.skip("They takes too long for Travis CI: it reports a failure because no output appears when running them") 115 | def test_longrunning(self): 116 | 117 | with let([7,8]) as A: 118 | self.assertEqual(run(fresh(lambda γ, Aγ, Aγ2Aγ, Aγ2Aγ2Aγ2Aγ: 119 | conji(appendo(A, γ, Aγ), 120 | associateo(Aγ, Aγ2Aγ), 121 | associateo(Aγ2Aγ, Aγ2Aγ2Aγ2Aγ), 122 | mccullocho(γ, Aγ2Aγ2Aγ2Aγ))), n=1), [[3, 3, 3, 2, 7, 8, 3, 3, 3]]) # 11 123 | 124 | self.assertEqual(run(fresh(lambda out, α, γ, αγ, αγ2αγ, αγ2αγ2αγ2αγ: 125 | conji(appendo([3, 3, 3, 2]+α, [3, 3, 3], γ), 126 | mccullocho(γ, αγ2αγ2αγ2αγ), 127 | appendo(α, γ, αγ), 128 | associateo(αγ, αγ2αγ), 129 | associateo(αγ2αγ, αγ2αγ2αγ2αγ), 130 | unify([α, γ], out))), n=4), 131 | [[[], [3, 3, 3, 2, 3, 3, 3]], 132 | [[rvar(0)], [3, 3, 3, 2, rvar(0), 3, 3, 3]], 133 | [[rvar(0), rvar(1)], [3, 3, 3, 2, rvar(0), rvar(1), 3, 3, 3]], 134 | [[rvar(0), rvar(1), rvar(2)], [3, 3, 3, 2, rvar(0), rvar(1), rvar(2), 3, 3, 3]]]) # proof of 11 135 | 136 | 137 | def test_craigs_law_chapter(self): 138 | self.assertEqual(run(fresh(lambda α: mcculloch_o(α, α)), n=3), 139 | [[3, 2, 3], [4, 3, 4, 2, 4, 3, 4], [3, 4, 4, 2, 3, 4, 4]]) # 1 140 | self.assertEqual(run(fresh(lambda α, α_reversed: conji(reverseo(α, α_reversed), 141 | mcculloch_o(α, α_reversed), 142 | complement(symmetrico(α)))), n=6), 143 | [[3, 4, 2, 3, 4], 144 | [4, 3, 2, 4, 3], 145 | [3, 4, 4, 4, 2, 3, 4, 4, 4], 146 | [4, 3, 4, 4, 2, 4, 3, 4, 4], 147 | [4, 4, 3, 4, 2, 4, 4, 3, 4], 148 | [4, 4, 4, 3, 2, 4, 4, 4, 3]]) # 2 149 | self.assertEqual(run(fresh(lambda α, α_reversed, α_reversed2α_reversed: 150 | conj(reverseo(α, α_reversed), 151 | associateo(α_reversed, α_reversed2α_reversed), 152 | mcculloch_o(α, α_reversed2α_reversed),)), n=5), 153 | [[3, 3, 2, 3, 3], 154 | [3, 3, 4, 2, 3, 3, 4], 155 | [4, 3, 3, 2, 4, 3, 3], 156 | [3, 4, 3, 2, 3, 4, 3], 157 | [3, 4, 4, 3, 2, 3, 4, 4, 3], 158 | ]) # 3.e 159 | self.assertEqual(run(fresh(lambda α, α_reversed, α_reversed2α_reversed: 160 | conji(reverseo(α, α_reversed), 161 | associateo(α_reversed, α_reversed2α_reversed), 162 | mcculloch_o(α, α_reversed2α_reversed),)), n=5), 163 | [[3, 3, 2, 3, 3], 164 | [3, 3, 4, 2, 3, 3, 4], 165 | [4, 3, 3, 2, 4, 3, 3], 166 | [3, 4, 4, 3, 2, 3, 4, 4, 3], 167 | [3, 4, 3, 2, 3, 4, 3], 168 | ]) # 3.i 169 | self.assertEqual(run(fresh(lambda α, αα: conji(repeato(α, αα), mcculloch__o(α, αα))), n=2), 170 | [[5, 3, 2, 5, 3], [5, 5, 2, 5, 5, 2]]) # 4 171 | self.assertEqual(run(fresh(lambda α, αα, αα_reversed: 172 | conji(reverseo(αα, αα_reversed), 173 | repeato(α, αα), 174 | mcculloch__o(α, αα_reversed),)), n=2), 175 | [[5, 3, 4, 2, 5, 3, 4], [4,5,3,2,4,5,3]]) # 5 176 | self.assertEqual(run(fresh(lambda α, αα: conji(repeato(α, αα), mcculloch__o([5]+α, αα))), n=3), 177 | [[3, 2, 3], [5, 2, 5, 2], [3, 4, 4, 2, 3, 4, 4]]) # 7 178 | self.assertEqual(run(fresh(lambda α, α2α, α2αα2α: 179 | conji(associateo(α, α2α), 180 | repeato(α2α, α2αα2α), 181 | mcculloch__o(α, α2αα2α),)), n=1), 182 | [[5, 3, 3, 2, 5, 3, 3]]) # 8 183 | self.assertEqual(run(fresh(lambda α, αα, αα2αα: 184 | conji(repeato(α, αα), 185 | associateo(αα, αα2αα), 186 | mcculloch__o(α, αα2αα),)), n=2), 187 | [[3, 5, 3, 2, 3, 5, 3], 188 | [3, 5, 5, 2, 3, 5, 5, 2]]) # 9 189 | 190 | def test_operation_numbers(self): 191 | self.assertEqual(run(fresh(opnumbero), n=19), 192 | [[], 193 | [3], 194 | [3, 3], 195 | [4], 196 | [4, 3], 197 | [3, 3, 3], 198 | [5, 3], 199 | [3, 4], 200 | [3, 4, 3], 201 | [5], 202 | [4, 4], 203 | [4, 3, 3], 204 | [3, 3, 3, 3], 205 | [5, 4], 206 | [3, 5, 3], 207 | [3, 3, 4], 208 | [3, 3, 4, 3], 209 | [4, 4, 3], 210 | [3, 5]]) 211 | 212 | self.assertEqual(run(fresh(lambda α, β: operationo([3,3], β, α)), n=3), 213 | [[2,2,2], 214 | [rvar(0), 2, rvar(0), 2, rvar(0), 2, rvar(0)], 215 | [rvar(0), rvar(1), 2, rvar(0), rvar(1), 2, rvar(0), rvar(1), 2, rvar(0), rvar(1)]]) 216 | self.assertEqual(run(fresh(lambda α, β: operationo([5, 4, 3], [8,7], α)), n=1), [[7, 8, 2, 7, 8, 7, 8, 2, 7, 8]]) 217 | self.assertEqual(run(fresh(lambda out, M, χ, M_of_χ, Mχ: 218 | conji( 219 | appendo(M, χ, Mχ), 220 | complement(nullo(M)), 221 | operationo(M, χ, M_of_χ), 222 | unify(Mχ, M_of_χ), 223 | unify([M, χ], out))), n=1), [[[5], [5]]]) 224 | self.assertEqual(run(fresh(lambda out, χ, M_of_χ, γ: 225 | conj(unify([3,5,4]+γ, χ), 226 | craig_lawo(χ, M_of_χ), 227 | unify([χ, M_of_χ], out))), n=1), 228 | [[[3, 5, 4, 3, 2, 3, 5, 4, 3], [3, 4, 5, 3, 2, 3, 4, 5, 3, 3, 4, 5, 3, 2, 3, 4, 5, 3, 2, 3, 4, 5, 3, 2, 3, 4, 5, 3, 3, 4, 5, 3, 2, 3, 4, 5, 3]]]) # 20 229 | self.assertEqual(run(fresh(lambda χ, _7χ7χ: conj(repeato([7]+χ, _7χ7χ), mcculloch__o(χ,_7χ7χ))), n=2), 230 | [[5, 3, 2, 7, 5, 3], [5, 5, 2, 7, 5, 5, 2]]) # 21 231 | self.assertEqual(run(fresh(lambda χ, _9χ_reversed: conj(reverseo([9]+χ, _9χ_reversed), mcculloch__o(χ,_9χ_reversed))), n=2), 232 | [[3, 4, 2, 9, 3, 4], [4, 3, 2, 9, 4, 3]]) # 22 233 | self.assertEqual(run(fresh(lambda χ, _89χ289χ: conj(associateo([8,9]+χ, _89χ289χ), mcculloch__o(χ,_89χ289χ))), n=2), 234 | [[3, 3, 2, 8, 9, 3, 3], [3, 5, 2, 8, 9, 3, 5, 2]]) # 23 235 | # we do not solve problem 24, 25, 26 since I'm not able to imagine a decent solution for them. 236 | self.assertEqual(run(fresh(lambda out, χ, M_of_χ, γ: 237 | conj(unify([3,3,3]+γ, χ), 238 | craig_lawo(χ, M_of_χ, machine=mccullocho), 239 | unify([χ, M_of_χ], out))), n=1), 240 | [[[3, 3, 3, 2, 3, 3, 3], [3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3, 2, 3, 3, 3]]]) # discussion after question 26 241 | 242 | 243 | def test_fergusson_law_chapter(self): 244 | self.assertEqual(run(fresh(lambda out, χ, ψ: conj(mccullocho(χ, ψ), mccullocho(ψ, χ), unify([χ, ψ], out))), n=1), 245 | [[[2, 3, 2, 2, 3], [3, 2, 2, 3]]]) # 2 246 | self.assertEqual(run(fresh(lambda out, χ, ψ, α, αχ: conji(appendo(α, χ, αχ), 247 | mccullocho(ψ, αχ), 248 | mccullocho(χ, ψ), 249 | unify([χ, ψ], out))), n=2), 250 | [[[3, 2, 2, 3], [2, 3, 2, 2, 3]], [[3, 2, 2, rvar(0), 3], [2, rvar(0), 3, 2, 2, rvar(0), 3]]]) # 3 251 | self.assertEqual(run(fresh(lambda out, χ, ψ, α, αχ: conji(appendo(α, χ, αχ), 252 | mccullocho(χ, ψ), 253 | mccullocho(ψ, αχ), 254 | unify([χ, ψ], out))), n=2), 255 | [[[2, 3, 2, 2, 3], [3, 2, 2, 3]], [[2, 3, 2, rvar(0), 2, 3], [3, 2, rvar(0), 2, 3]]]) # 4 256 | self.assertEqual(run(fresh(lambda out, χ, ψ, α, αχ, β, βψ: conji(appendo(α, χ, αχ), 257 | appendo(β, ψ, βψ), 258 | mccullocho(ψ, αχ), 259 | mccullocho(χ, βψ), 260 | unify([χ, ψ], out))), n=4), 261 | [[[3, 2, 2, 3], [2, 3, 2, 2, 3]], 262 | [[3, 2, 2, rvar(0), 3], [2, rvar(0), 3, 2, 2, rvar(0), 3]], 263 | [[3, 2, rvar(0), 2, 3], [2, 3, 2, rvar(0), 2, 3]], 264 | [[3, 2, 2, rvar(0), rvar(1), 3], [2, rvar(0), rvar(1), 3, 2, 2, rvar(0), rvar(1), 3]]]) # 5.1 265 | self.assertEqual(run(fresh(lambda out, χ, ψ, α, αχ, β, βψ: conji(appendo(α, χ, αχ), 266 | appendo(β, ψ, βψ), 267 | mccullocho(χ, βψ), 268 | mccullocho(ψ, αχ), 269 | unify([χ, ψ], out))), n=4), 270 | [[[2, 3, 2, 2, 3], [3, 2, 2, 3]], 271 | [[2, 3, 2, rvar(0), 2, 3], [3, 2, rvar(0), 2, 3]], 272 | [[2, rvar(0), 3, 2, 2, rvar(0), 3], [3, 2, 2, rvar(0), 3]], 273 | [[2, 3, 2, rvar(0), rvar(1), 2, 3], [3, 2, rvar(0), rvar(1), 2, 3]]]) # 5.2 274 | 275 | return 276 | self.assertEqual(run(fresh(lambda out, χ, ψ, χ2χ, ψ_reversed: 277 | conj( 278 | reverseo(ψ, ψ_reversed), 279 | mcculloch__o(ψ, χ2χ), 280 | associateo(χ, χ2χ), 281 | mcculloch__o(χ, ψ_reversed), 282 | #operationo([4], ψ, ψ_reversed), 283 | #operationo([3], χ, χ2χ), 284 | unify([χ, ψ], out))), n=1), []) # 6 285 | 286 | def test_the_key_chapter(self): 287 | 288 | #with suppress(RecursionError): 289 | #self.assertEqual(run(fresh(lambda l: reverseo(list(range(100)), l))), [list(reversed(range(100)))]) 290 | 291 | with recursion_limit(100000): 292 | self.assertEqual(run(fresh(lambda l: linear_reverseo(list(range(1000)), l))), [list(reversed(range(1000)))]) 293 | 294 | self.assertEqual(run(fresh(lambda α: mcculloch___o(α, α)), n=5), 295 | [[5, 4, 6, 4, 2, 5, 4, 6, 4, 2], 296 | [4, 5, 6, 4, 2, 4, 5, 6, 4, 2], 297 | [5, 4, 4, 4, 6, 4, 2, 5, 4, 4, 4, 6, 4, 2], 298 | [4, 6, 5, 4, 2, 4, 6, 5, 4, 2, 2], 299 | [5, 4, 6, 4, 4, 4, 2, 5, 4, 6, 4, 4, 4, 2]]) # the keys!!! 300 | 301 | @unittest.skip('Stochastic keys generation') 302 | def test_stochastic_keys(self): 303 | with recursion_limit(10000): 304 | 305 | def P(α, β, a, b, c, d, e, f, g, h, j, k): 306 | prefix = [a, b, c, d, e, f, g, h, j, k] 307 | return smcculloch___o(prefix+β, prefix+β) @ unify(prefix+β, α) 308 | 309 | self.assertEqual(run(fresh(P), n=10), []) # the keys!!! 310 | 311 | ''' 312 | [[5, 4, 6, 4, 2, 5, 4, 6, 4, 2], 313 | [5, 4, 4, 4, 6, 4, 2, 5, 4, 4, 4, 6, 4, 2], 314 | [5, 4, 6, 4, 4, 4, 2, 5, 4, 6, 4, 4, 4, 2], 315 | [5, 4, 6, 4, 4, 4, 4, 4, 2, 5, 4, 6, 4, 4, 4, 4, 4, 2], 316 | [5, 4, 4, 4, 4, 4, 6, 4, 2, 5, 4, 4, 4, 4, 4, 6, 4, 2], 317 | [5, 4, 4, 4, 6, 4, 4, 4, 2, 5, 4, 4, 4, 6, 4, 4, 4, 2], 318 | [5, 4, 4, 4, 4, 4, 6, 4, 4, 4, 2, 5, 4, 4, 4, 4, 4, 6, 4, 4, 4, 2], 319 | [5, 4, 4, 4, 4, 4, 4, 4, 6, 4, 2, 5, 4, 4, 4, 4, 4, 4, 4, 6, 4, 2], 320 | [5, 4, 4, 4, 6, 4, 4, 4, 4, 4, 2, 5, 4, 4, 4, 6, 4, 4, 4, 4, 4, 2], 321 | [5, 4, 6, 4, 4, 4, 4, 4, 4, 4, 2, 5, 4, 6, 4, 4, 4, 4, 4, 4, 4, 2]] 322 | 323 | [[4, 5, 6, 4, 2, 4, 5, 6, 4, 2], 324 | [4, 6, 5, 4, 2, 4, 6, 5, 4, 2, 2], 325 | [4, 6, 4, 5, 2, 4, 6, 4, 5, 2, 2], 326 | [4, 5, 4, 4, 6, 4, 2, 4, 5, 4, 4, 6, 4, 2], 327 | [4, 5, 6, 4, 4, 4, 2, 4, 5, 6, 4, 4, 4, 2], 328 | [4, 4, 5, 4, 6, 4, 2, 4, 4, 5, 4, 6, 4, 2], 329 | [4, 4, 4, 5, 6, 4, 2, 4, 4, 4, 5, 6, 4, 2], 330 | [4, 4, 4, 6, 5, 4, 2, 4, 4, 4, 6, 5, 4, 2, 2], 331 | [4, 4, 4, 6, 4, 5, 2, 4, 4, 4, 6, 4, 5, 2, 2], 332 | [4, 6, 5, 4, 4, 4, 2, 4, 6, 5, 4, 4, 4, 2, 2]] 333 | 334 | ''' 335 | 336 | 337 | 338 | 339 | 340 | -------------------------------------------------------------------------------- /src/microkanren_test.py: -------------------------------------------------------------------------------- 1 | 2 | import unittest 3 | 4 | from muk.core import * 5 | from muk.ext import * 6 | from muk.sexp import * 7 | 8 | class microkanren_tests(unittest.TestCase): 9 | 10 | def test_infinte_recursion_not_guarded(self): 11 | 12 | def fives(x): 13 | return disj(unify(x, 5), fives(x)) 14 | 15 | with self.assertRaises(RecursionError): 16 | with states_stream(fresh(fives)) as α: 17 | next(α) 18 | 19 | def test_infinte_recursion_guarded_refreshing(self): 20 | 21 | def fives(x): 22 | return disj(unify(x, 5), fresh(fives)) 23 | 24 | with states_stream(fresh(fives)) as α: 25 | self.assertEqual([state(sub={var(i, 'x'): 5}, next_index=i+1) for i in range(10)], 26 | [next(α) for _ in range(10)]) 27 | 28 | def test_infinte_recursion_guarded_ηinverse(self): 29 | 30 | def fives(x): 31 | return disj(unify(x, 5), fresh(lambda: fives(x))) 32 | 33 | with states_stream(fresh(fives)) as α: 34 | self.assertEqual( [state(sub={var(0, 'x'): 5}, next_index=1)]*10, 35 | [next(α) for _ in range(10)]) 36 | 37 | 38 | 39 | def test_interleaving_of_5s_and_6s(self): 40 | 41 | def ns(x, n): 42 | return disj(unify(x, n), fresh(lambda: ns(x, n))) 43 | 44 | with states_stream(fresh(lambda x: disj(ns(x, 5), ns(x, 6)))) as α: 45 | numbers = [state(sub={var(0, 'x'): 5}, next_index=1), 46 | state(sub={var(0, 'x'): 6}, next_index=1)] 47 | self.assertEqual(numbers * 5, [next(α) for _ in range(10)]) 48 | 49 | 50 | def test_nats(self): 51 | 52 | def ns(x, n): 53 | return disj(unify(x, n), fresh(lambda: ns(x, n+1))) 54 | 55 | with states_stream(fresh(lambda x: ns(x, 0))) as α: 56 | nats = [state(sub={var(0, 'x'): i}, next_index=1) for i in range(10)] 57 | self.assertEqual(nats, [next(α) for _ in range(10)]) 58 | 59 | def test_nats_by_evens_and_odds(self): 60 | 61 | def ns(x, n): 62 | return disj(unify(x, n), fresh(lambda: ns(x, n+2))) 63 | 64 | with states_stream(fresh(lambda x: disj(ns(x, 0), ns(x, 1)))) as α: 65 | nats = [state(sub={var(0, 'x'): i}, next_index=1) for i in range(10)] 66 | self.assertEqual(nats, [next(α) for _ in range(10)]) 67 | 68 | def test_fail_goal(self): 69 | 70 | def ns(x, n): 71 | return disj(unify(x, n), fresh(lambda: ns(x, n))) 72 | 73 | self.assertEqual(run(fresh(lambda x: conj(fail, ns(x, 5)))), []) 74 | 75 | def test_divergent_goal_despite_fail_in_conj(self): 76 | 77 | def ns(x, n): 78 | return disj(unify(x, n), fresh(lambda: ns(x, n))) 79 | 80 | with self.assertRaises(RecursionError): 81 | run(fresh(lambda x: conj(ns(x, 5), fail))) 82 | 83 | def test_simple_list_unification(self): 84 | 85 | def gbody(r): 86 | return fresh(lambda x, y: unify([y, 4, x], r)) 87 | 88 | results = run(fresh(gbody)) 89 | self.assertEqual(results, [[rvar(0), 4, rvar(1)]]) 90 | 91 | 92 | def test_unify(self): 93 | 94 | self.assertEqual( 95 | run(fresh(lambda w, x, y, z: 96 | conj(unify([3,[4,5],6], [3, [x, y], z]), 97 | unify([x, y, z], w)))), [[4,5,6]]) 98 | 99 | self.assertEqual( 100 | run(fresh(lambda w, x, y, z: 101 | conj(unify([3,[4,5],6], (3, [x, y], z)), 102 | unify([x, y, z], w)))), [[4,5,[6]]]) 103 | 104 | self.assertEqual( 105 | run(fresh(lambda w, x, y, z: 106 | conj(unify([3,[4,5],6], [3, [x, y]] + z), 107 | unify([x, y, z], w)))), [[4,5,[6]]]) 108 | 109 | self.assertEqual( 110 | run(fresh(lambda w, x, y, z: 111 | conj(unify((3,[4,5],6), [3, [x, y]] + z), 112 | unify([x, y, z], w)))), [[4,5,6]]) 113 | 114 | with self.assertRaises(TypeError): 115 | self.assertEqual( 116 | run(fresh(lambda w, x, y, z: 117 | conj(unify([3,[4,5],6], x + ([4, y], z)), 118 | unify([x, y, z], w)))), [[3,5,[6]]]) 119 | 120 | def test_bounded(self): 121 | 122 | def questiono(d): 123 | with delimiter(d) as D: 124 | def Q(q): 125 | return conde([unify('a', q), succeed], 126 | [unify('b', q), succeed], 127 | [unify('c', q), succeed], 128 | else_clause=fresh(lambda: Q(q))) < D 129 | return Q 130 | 131 | self.assertEqual(run(fresh(questiono(d=1))), ['a', 'b', 'c']) 132 | self.assertEqual(run(fresh(questiono(d=2))), ['a', 'b', 'c', 'a', 'b', 'c']) 133 | self.assertEqual(run(fresh(questiono(d=3))), ['a', 'b', 'c', 'a', 'b', 'c', 'a', 'b', 'c']) 134 | self.assertEqual(run(fresh(questiono(d=10)), n=4), ['a', 'b', 'c', 'a']) 135 | 136 | 137 | 138 | -------------------------------------------------------------------------------- /src/muk/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/massimo-nocentini/microkanrenpy/62c71ae015c0ecc0330d70a2eeb6084430a5bb47/src/muk/__init__.py -------------------------------------------------------------------------------- /src/muk/ext.py: -------------------------------------------------------------------------------- 1 | 2 | import collections, operator 3 | from functools import wraps, partial, reduce 4 | from contextlib import contextmanager 5 | from itertools import chain, repeat 6 | 7 | from muk.core import * 8 | from muk.core import _conj, _disj, _unify 9 | from muk.utils import * 10 | 11 | 12 | # DISJ, CONJ, CONJI {{{ 13 | 14 | class disj(goal): 15 | 16 | def __init__(self, *goals, interleaving=True, dovetail=True): 17 | self.goals = goals 18 | self.interleaving = interleaving 19 | self.dovetail = dovetail 20 | 21 | def __call__(self, s : state): 22 | if self.dovetail: # dovetail entails interleaving 23 | yield from mplus((α for g in self.goals for α in [g(s)]), interleaving=True) 24 | else: 25 | D = partial(_disj, interleaving=self.interleaving) 26 | g = foldr(D, self.goals, initialize=fail) 27 | α = g(s) 28 | yield from α 29 | 30 | def conj(*goals, interleaving=False): 31 | C = partial(_conj, interleaving=interleaving) 32 | return foldr(C, goals, initialize=succeed) 33 | 34 | conji = partial(conj, interleaving=True) 35 | 36 | # }}} 37 | 38 | # UNIFY, UNIFY_OCCUR_CHECK {{{ 39 | 40 | class unify(_unify): 41 | 42 | def __init__(self, u, v, occur_check=False): 43 | super(unify, self).__init__(u, v, partial(ext_s, occur_check=occur_check)) 44 | 45 | class unify_occur_check(unify): 46 | 47 | def __init__(self, u, v): 48 | super(unify_occur_check, self).__init__(u, v, occur_check=True) 49 | 50 | def __call__(self, s : state): 51 | try: 52 | yield from super(unify_occur_check, self).__call__(s) 53 | except OccurCheck: 54 | yield from fail(s) 55 | 56 | equalo = unify 57 | 58 | # }}} 59 | 60 | # COND {{{ 61 | 62 | def λ_deterministic(clause): 63 | question, answer = clause 64 | return {'goal': question & answer} 65 | 66 | def λ_stochastic(clause): 67 | rv, question, answer = clause 68 | obs, p = next(rv) 69 | return {'weight': obs*p, 'goal': question & answer} 70 | 71 | def _cond(*clauses, 72 | else_clause=fail, 73 | interleaving=None, 74 | dovetail=True, 75 | λ=λ_deterministic, 76 | rank=identity): 77 | body = clauses + ( ([succeed, else_clause], ) if else_clause else () ) 78 | D = partial(disj, 79 | interleaving=interleaving, 80 | dovetail=dovetail if interleaving else False) 81 | return D(*map(operator.itemgetter('goal'), rank(map(λ, body)))) 82 | 83 | rank = partial(sorted, key=operator.itemgetter('weight'), reverse=True) 84 | 85 | def conds(*clauses, **kwds): 86 | kwds['else_clause'] = None 87 | kwds['λ'] = λ_stochastic 88 | kwds['rank'] = rank 89 | C = partial(_cond, **kwds) 90 | return C(*clauses) 91 | 92 | def stochastic_rank(*clauses, link): 93 | def λ(clause): 94 | rv, g = clause 95 | obs, p = next(rv) 96 | return {'weight': obs*p, 'goal': g} 97 | return link(*map(operator.itemgetter('goal'), rank(map(λ, clauses)))) 98 | 99 | def cond(*clauses, else_clause=fail, λ_if): 100 | 101 | def λ(clause, otherwise): 102 | question, answer = clause 103 | return λ_if(question, answer, otherwise) 104 | 105 | return foldr(λ, clauses, initialize=else_clause) 106 | 107 | class if_pure(goal): 108 | 109 | def __init__(self, question, answer, otherwise, *, interleaving): 110 | self.question = question 111 | self.answer = answer 112 | self.otherwise = otherwise 113 | self.interleaving = interleaving 114 | 115 | def __call__(self, s : state): 116 | C = self.question & self.answer 117 | α, β = C(s), self.otherwise(s) 118 | yield from mplus(iter([α, β]), self.interleaving) 119 | 120 | ife = partial(if_pure, interleaving=False) 121 | ifi = partial(if_pure, interleaving=True) 122 | 123 | class if_softcut(goal): 124 | 125 | def __init__(self, question, answer, otherwise, *, doer): 126 | self.question = question 127 | self.answer = answer 128 | self.otherwise = otherwise 129 | self.doer = doer 130 | 131 | def __call__(self, s : state): 132 | α = self.question(s) 133 | try: 134 | r = next(α) # r : state 135 | except StopIteration: 136 | β = self.otherwise(s) 137 | yield from β 138 | else: 139 | γ = self.doer(r, α, self.answer) 140 | yield from γ 141 | 142 | ifa = partial(if_softcut, doer=lambda r, α, answer: 143 | bind(chain([r], α), repeat(answer), mplus=partial(mplus, interleaving=False))) 144 | ifu = partial(if_softcut, doer=lambda r, α, answer: answer(r)) 145 | 146 | conde = partial(_cond, interleaving=False) 147 | condi = partial(_cond, interleaving=True) 148 | conde_unfair = partial(cond, λ_if=ife) 149 | condi_unfair = partial(cond, λ_if=ifi) 150 | conda = partial(cond, λ_if=ifa) 151 | condu = partial(cond, λ_if=ifu) 152 | 153 | # }}} 154 | 155 | # DELIMITED {{{ 156 | 157 | @contextmanager 158 | def delimiter(d): 159 | 160 | key = object() 161 | 162 | class D: 163 | def __gt__(self, g): 164 | return delimited(key, d, g) 165 | 166 | yield D() 167 | 168 | class delimited(goal): 169 | 170 | def __init__(self, key, upper, g): 171 | self.key = key 172 | self.upper = upper 173 | self.g = g 174 | 175 | def __call__(self, s : state): 176 | v = s.sub.get(self.key, 0) 177 | if v < self.upper: 178 | s.sub[self.key] = v + 1 179 | α = self.g(s) 180 | yield from α 181 | else: 182 | yield from fail(s) 183 | 184 | # }}} 185 | 186 | # PROJECT, REL {{{ 187 | 188 | class project(goal): 189 | 190 | def __init__(self, *logic_vars, into): 191 | self.logic_vars = logic_vars 192 | self.into = into 193 | 194 | def __call__(self, s : state): 195 | walked_vars = [walk_star(v, s.sub) for v in self.logic_vars] 196 | g = self.into(*walked_vars) 197 | α = g(s) 198 | yield from α 199 | 200 | 201 | class sub(goal): 202 | 203 | def __init__(self, *logic_vars, of): 204 | self.logic_vars = logic_vars 205 | self.of = of 206 | 207 | def λ(self, s : state): 208 | lvars = set(self.logic_vars) if self.logic_vars else s.sub.keys() 209 | return state({v:{v:s.sub[v]} for v in lvars if v in s.sub}, s.next_index) 210 | 211 | def __call__(self, s : state): 212 | α = self.of(s) 213 | yield from map(self.λ, α) 214 | 215 | class rel(goal): 216 | 217 | def __init__(self, r, res, unify=unify): 218 | self.r = r 219 | self.res = res 220 | self.unify = unify 221 | 222 | def __call__(self, s : state): 223 | 224 | def recv(*args): 225 | return self.r(*args) & self.unify(list(args), self.res) 226 | 227 | g = fresh(recv, arity=len(signature(self.r).parameters)) 228 | α = g(s) 229 | yield from α 230 | 231 | # }}} 232 | 233 | def lvars(vars_names, splitter=' '): 234 | return [var(b, n.strip()) for b, n in enumerate(vars_names.split(splitter))] 235 | 236 | def rectify(α_α, β): 237 | return unify(α_α, β-[]) 238 | 239 | 240 | 241 | -------------------------------------------------------------------------------- /src/muk/sexp.py: -------------------------------------------------------------------------------- 1 | 2 | from collections import namedtuple 3 | from contextlib import contextmanager 4 | from functools import wraps 5 | from inspect import signature 6 | 7 | from muk.utils import identity 8 | 9 | class cons(namedtuple('_cons', ['car', 'cdr'])): 10 | 11 | def walk_star(self, W): 12 | return cons(W(self.car), W(self.cdr)) 13 | 14 | def unification(self, other, sub, ext_s, U, E): 15 | try: UC = other._unification_cons 16 | except AttributeError: raise E 17 | else: return UC(self, sub, ext_s, U) 18 | 19 | def _unification_cons(self, other_cons, sub, ext_s, U): 20 | 21 | if other_cons.cdr == (): return U(other_cons.car, self, sub, ext_s) 22 | if self.cdr == (): return U(self.car, other_cons, sub, ext_s) 23 | 24 | cars_sub = U(other_cons.car, self.car, sub, ext_s) 25 | return U(other_cons.cdr, self.cdr, cars_sub, ext_s) 26 | 27 | def reify_s(self, sub, R): 28 | return R(self.cdr, R(self.car, sub)) 29 | 30 | def occur_check(self, u, O, E): 31 | return O(u, self.car) or O(u, self.cdr) 32 | 33 | def __radd__(self, other): 34 | 35 | if isinstance(other, list): 36 | return list_to_cons(other, post=lambda l: self if l == [] else l) 37 | 38 | raise NotImplemented 39 | 40 | class ImproperListError(ValueError): 41 | pass 42 | 43 | def list_to_cons(l, post=identity): 44 | 45 | if isinstance(l, (str, cons)): return l # we consider a `str` obj not an iterable obj but as an atom 46 | 47 | try: as_cons = l.as_cons 48 | except AttributeError: pass 49 | else: return as_cons(translate=list_to_cons) 50 | 51 | λ = type(l) 52 | try: 53 | car, cadr, *cddr = l 54 | except: 55 | try: 56 | car, *cdr = l 57 | except: 58 | return l 59 | else: 60 | cdr = λ(cdr) # again, restore correct type of the tail 61 | if cdr == (): raise ImproperListError # otherwise outer try couldn't fail 62 | cdr = post(cdr) 63 | return cons(car=list_to_cons(car), cdr=list_to_cons(cdr)) 64 | else: 65 | cddr = λ(cddr) # restore correct type of tail collecting obj 66 | if cddr == (): return cons(car=list_to_cons(car), cdr=list_to_cons(cadr)) 67 | cdr = λ([cadr]) + cddr # reconstruct `cdr` by adapt `[cadr]` to safely apply + 68 | return cons(car=list_to_cons(car), cdr=list_to_cons(cdr)) 69 | 70 | 71 | def cons_to_list(c, for_cdr=False): 72 | 73 | try: 74 | car, cdr = c 75 | except: 76 | if c == (): raise ImproperListError 77 | return (([], list) if c == [] else ((c,), tuple)) if for_cdr else c 78 | 79 | d, λ = cons_to_list(cdr, for_cdr=True) 80 | r = λ([cons_to_list(car, for_cdr=False)]) + d 81 | return (r, λ) if for_cdr else r 82 | 83 | 84 | def adapt_iterables_to_conses(selector, ctor=list_to_cons): 85 | def decorator(f): 86 | f_sig = signature(f) 87 | formal_args = [v.name for k, v in f_sig.parameters.items()] 88 | selection = selector(*formal_args) 89 | if isinstance(selection, set): 90 | selection = {s:ctor for s in selection} 91 | 92 | @wraps(f) 93 | def D(*args, bypass_cons_adapter=False, **kwds): 94 | new_args = args if bypass_cons_adapter else [c(a) for f, a in zip(formal_args, args) 95 | for c in [selection.get(f, identity)]] 96 | return f(*new_args, **kwds) 97 | return D 98 | return decorator 99 | 100 | 101 | all_arguments = lambda *args: set(args) 102 | 103 | def int_to_list(i): 104 | return list(map(int, reversed(bin(i)[2:]))) if i else [] 105 | 106 | class num(cons): 107 | 108 | @classmethod 109 | def build(cls, obj): 110 | if isinstance(obj, int): obj = int_to_list(obj) 111 | c = list_to_cons(obj) 112 | return num(c.car, c.cdr) if isinstance(c, cons) else c 113 | 114 | def __int__(self): 115 | def I(c, e): 116 | return 0 if c == [] else c.car * 2**e + I(c.cdr, e+1) 117 | return I(self, e=0) 118 | 119 | 120 | 121 | 122 | -------------------------------------------------------------------------------- /src/muk/utils.py: -------------------------------------------------------------------------------- 1 | 2 | import sys 3 | 4 | from itertools import tee 5 | from contextlib import contextmanager 6 | from collections import OrderedDict 7 | 8 | numerical_subscripts = {'0':'₀', '1':'₁','2':'₂','3':'₃','4':'₄','5':'₅','6':'₆','7':'₇','8':'₈','9':'₉'} 9 | 10 | def identity(a): 11 | return a 12 | 13 | def pairwise(iterable): 14 | "s -> (s0,s1), (s1,s2), (s2, s3), ..." 15 | a, b = tee(iterable) 16 | next(b, None) 17 | return zip(a, b) 18 | 19 | def iterwrap(obj, classes=(tuple,)): 20 | return obj if isinstance(obj, classes) else [obj] 21 | 22 | def foldr(λ, lst, initialize): 23 | 24 | def F(lst): 25 | if lst: 26 | car, *cdr = lst 27 | return λ(car, F(cdr)) 28 | else: 29 | return initialize 30 | 31 | return F(lst) 32 | 33 | def empty_iterable(α): 34 | α0, α = tee(α) 35 | try: next(α0) 36 | except StopIteration: return True 37 | else: return False 38 | 39 | @contextmanager 40 | def recursion_limit(n): 41 | previous = sys.getrecursionlimit() 42 | sys.setrecursionlimit(n) 43 | yield 44 | sys.setrecursionlimit(previous) 45 | 46 | @contextmanager 47 | def let(*args): 48 | yield (args[0] if len(args) == 1 else args) 49 | 50 | def subscript_notation(obj, subscript): 51 | return '{}{}'.format(str(obj), ''.join(numerical_subscripts[c] for c in str(subscript))) 52 | 53 | class groups_with_positions_notation: 54 | 55 | def __init__(self, iterable): 56 | M = OrderedDict() 57 | for i, o in enumerate(iterable): 58 | if o not in M: M[o] = [] 59 | M[o].append(subscript_notation(o, i)) 60 | 61 | self.M = M 62 | self.representation = '\n'.join([', '.join(v) for k, v in M.items()]) 63 | 64 | def __repr__(self): 65 | return self.representation 66 | -------------------------------------------------------------------------------- /src/sexp_test.py: -------------------------------------------------------------------------------- 1 | 2 | import unittest 3 | from functools import partialmethod 4 | 5 | from muk.sexp import * 6 | 7 | class sexp_tests(unittest.TestCase): 8 | 9 | def test_null_list(self): 10 | self.isomorphism(l=[], c=[]) 11 | 12 | def test_singleton_proper_list_to_cons(self): 13 | self.isomorphism(l=[1], c=cons(1, [])) 14 | 15 | def test_plain_proper_list_to_cons(self): 16 | self.isomorphism(l=[1,2,3], c=cons(1, cons(2, cons(3, [])))) 17 | 18 | def test_plain_improper_list_to_cons(self): 19 | self.isomorphism(l=(1,2,3), c=cons(1, cons(2, 3))) 20 | 21 | def test_nested_improper_list_to_cons(self): 22 | self.isomorphism(l=(1,[2,3], 4), c=cons(1, cons(cons(2, cons(3, [])), 4))) 23 | 24 | def test_more_nested_improper_list_to_cons(self): 25 | self.isomorphism(l=([3],(4,5), 6), c=cons(cons(3, []), cons(cons(4, 5), 6))) 26 | 27 | def test_shadow_proper_list_using_improper_list_notation(self): 28 | # pay attention, this is not an isomorphism, the next test shows the 29 | # natural way of writing, without shadowing. The broken direction is 30 | # represented by function `cons_to_list` which doesn't shadow objs it 31 | # produces. 32 | self.assertEqual(list_to_cons(([3],(4,5), [6])), cons(cons(3, []), cons(cons(4, 5), cons(6, [])))) 33 | 34 | def test_more_nested_improper_lists_into_proper_list_to_cons(self): 35 | self.isomorphism(l=[[3],(4,5), 6], c=cons(cons(3, []), cons(cons(4, 5), cons(6, [])))) 36 | 37 | def test_invalid_improper_list(self): 38 | with self.assertRaises(ImproperListError): 39 | list_to_cons(l=(3,)) 40 | 41 | def test_invalid_improper_cons(self): 42 | with self.assertRaises(ImproperListError): 43 | cons_to_list(c=cons(3, ())) 44 | 45 | def isomorphism(self, l, c): 46 | self.assertEqual(c, list_to_cons(l)) 47 | self.assertEqual(l, cons_to_list(c)) 48 | 49 | def test_tuple_wrapping_and_ctor_call(self): 50 | 51 | class A(tuple): 52 | __int__ = partialmethod(sum) 53 | 54 | a = (1,2,3,4) # vanilla tuple obj 55 | self.assertEqual(tuple, type(a)) 56 | self.assertEqual(A, type(A(a))) 57 | self.assertEqual(10, int(A(a))) 58 | 59 | 60 | 61 | 62 | --------------------------------------------------------------------------------