Skip to content

Commit

Permalink
Automated docs update.
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions Bot committed May 23, 2024
1 parent cb3f4c2 commit c61147f
Show file tree
Hide file tree
Showing 48 changed files with 6,327 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 66b37f8fc70062cd80f7cb01b503acef
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added docs/.nojekyll
Empty file.
75 changes: 75 additions & 0 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
.. seampy documentation master file, created by
sphinx-quickstart on Tue Sep 24 12:11:24 2019.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
pyAdic
===================================

.. toctree::
:maxdepth: 2
:caption: Contents:

The pyadic library is Python 3 package that provides number types for finite fields (ModP) and *p*-adic numbers (PAdic).
The goal is mimic the flexible behavior of built-in types, such as int, float and complex.
Thus, one can mix-and-match the different number types, as long as the operations are consistent.
In particular, ModP and PAdic are compatible with fractions.Fraction.


Installation
------------

Installation is easy with pip::

pip install pyadic

alternatively the package can be cloned from github at https://github.com/GDeLaurentis/pyadic.


Quick start
-----------

.. code-block:: python
:caption: Instantiating number pyadic types
:linenos:
from pyadic import PAdic, ModP
from fractions import Fraction as Q
# 7/13 as a 12-digit 2147483647-adic number
PAdic(Q(7, 13), 2147483647, 12)
> 1817101548 + 825955248*2147483647 + 1156337348*2147483647^2 + 330382099*2147483647^3 + 1321528398*2147483647^4 + 991146298*2147483647^5 + 1817101547*2147483647^6 + 825955248*2147483647^7 + 1156337348*2147483647^8 + 330382099*2147483647^9 + 1321528398*2147483647^10 + 991146298*2147483647^11 + O(2147483647^12)
# 7/13 in F_2147483647
ModP(Q(7, 13), 2147483647)
> 1817101548 % 2147483647
.. code-block:: python
:caption: Mapping back to rational numbers
:linenos:
:lineno-start: 12
from pyadic.finite_field import rationalise
rationalise(ModP(Q(7, 13), 2147483647))
> Fraction(7, 13)
rationalise(PAdic(Q(7, 13), 2147483647, 12))
> Fraction(7, 13)
Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`


.. Hidden TOCs
.. toctree::
:caption: Modules Documentation
:maxdepth: 2

modules
7 changes: 7 additions & 0 deletions docs/_sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
pyadic
=============

.. toctree::
:maxdepth: 4

pyadic
21 changes: 21 additions & 0 deletions docs/_sources/pyadic.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
pyadic.padic
--------------------

.. automodule:: pyadic.padic
:members:
:undoc-members:

pyadic.finite_field
---------------------

.. automodule:: pyadic.finite_field
:members:
:undoc-members:


Module contents
---------------

.. automodule:: pyadic
:members:
:undoc-members:
123 changes: 123 additions & 0 deletions docs/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};

/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;

/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};

/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};

/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();

var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];

return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
Loading

0 comments on commit c61147f

Please sign in to comment.