Skip to content

Commit 0dd7ccb

Browse files
fredrik-johanssonfredrik-johansson
committed
attempt to include documentation
1 parent 8c42c5a commit 0dd7ccb

31 files changed

+4328
-0
lines changed

‎doc/build/doctrees/environment.pickle‎

13.5 KB
Binary file not shown.

‎doc/build/doctrees/index.doctree‎

86.8 KB
Binary file not shown.

‎doc/build/html/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
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: b514d003e6274a2ea15305cbb779ea19
4+
tags: fbb0d17656682115ca4d033fb2f83ba1

‎doc/build/html/_modules/index.html‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
2+
3+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5+
6+
7+
<html xmlns="http://www.w3.org/1999/xhtml">
8+
<head>
9+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10+
11+
<title>Overview: module code &mdash; python-flint 0.1 documentation</title>
12+
13+
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
14+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15+
16+
<script type="text/javascript">
17+
var DOCUMENTATION_OPTIONS = {
18+
URL_ROOT: '../',
19+
VERSION: '0.1',
20+
COLLAPSE_INDEX: false,
21+
FILE_SUFFIX: '.html',
22+
HAS_SOURCE: true
23+
};
24+
</script>
25+
<script type="text/javascript" src="../_static/jquery.js"></script>
26+
<script type="text/javascript" src="../_static/underscore.js"></script>
27+
<script type="text/javascript" src="../_static/doctools.js"></script>
28+
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
29+
<link rel="top" title="python-flint 0.1 documentation" href="../index.html" />
30+
</head>
31+
<body>
32+
<div class="related">
33+
<h3>Navigation</h3>
34+
<ul>
35+
<li class="right" style="margin-right: 10px">
36+
<a href="../genindex.html" title="General Index"
37+
accesskey="I">index</a></li>
38+
<li><a href="../index.html">python-flint 0.1 documentation</a> &raquo;</li>
39+
</ul>
40+
</div>
41+
42+
<div class="document">
43+
<div class="documentwrapper">
44+
<div class="bodywrapper">
45+
<div class="body">
46+
47+
<h1>All modules for which code is available</h1>
48+
<ul><li><a href="flint.html">flint</a></li>
49+
</ul>
50+
51+
</div>
52+
</div>
53+
</div>
54+
<div class="sphinxsidebar">
55+
<div class="sphinxsidebarwrapper">
56+
<div id="searchbox" style="display: none">
57+
<h3>Quick search</h3>
58+
<form class="search" action="../search.html" method="get">
59+
<input type="text" name="q" />
60+
<input type="submit" value="Go" />
61+
<input type="hidden" name="check_keywords" value="yes" />
62+
<input type="hidden" name="area" value="default" />
63+
</form>
64+
<p class="searchtip" style="font-size: 90%">
65+
Enter search terms or a module, class or function name.
66+
</p>
67+
</div>
68+
<script type="text/javascript">$('#searchbox').show(0);</script>
69+
</div>
70+
</div>
71+
<div class="clearer"></div>
72+
</div>
73+
<div class="related">
74+
<h3>Navigation</h3>
75+
<ul>
76+
<li class="right" style="margin-right: 10px">
77+
<a href="../genindex.html" title="General Index"
78+
>index</a></li>
79+
<li><a href="../index.html">python-flint 0.1 documentation</a> &raquo;</li>
80+
</ul>
81+
</div>
82+
<div class="footer">
83+
&copy; Copyright 2012, Fredrik Johansson.
84+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
85+
</div>
86+
</body>
87+
</html>

‎doc/build/html/_sources/index.txt‎

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
.. python-flint documentation master file, created by
2+
sphinx-quickstart on Wed Jul 18 11:49:46 2012.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
Python bindings for FLINT
7+
==========================================================
8+
9+
Introduction
10+
::::::::::::
11+
12+
The python-flint Python extension module provides
13+
bindings to FLINT (http://flintlib.org/).
14+
FLINT (Fast Library for Number Theory) is a C library that implements
15+
highly optimised exact scalar, polynomial and matrix arithmetic as
16+
well as many number-theoretic special functions.
17+
18+
As of the current version, only a subset of the FLINT types
19+
are wrapped, and only a very limited selection of methods are provided.
20+
There are known and unknown bugs, and the interface is subject to
21+
change drastically in the future. Any feedback is welcome
22+
and can be sent to fredrik.johansson@gmail.com or flint-devel@googlegroups.com.
23+
Of particular note:
24+
25+
* Most functionality in FLINT is not yet wrapped!
26+
* Coercions are not supported in all directions.
27+
* Conversion between Python longs and fmpzs is not done efficiently.
28+
* Types don't yet provide hash methods.
29+
* Interaction with gmpy (http://gmpy.org/) types (and types from many other libraries) is not supported.
30+
31+
Setup
32+
::::::::::::
33+
34+
To build this module, you first need to install the latest
35+
version of FLINT (follow the instructions in the FLINT documentation). You
36+
also need to install Cython (http://cython.org/).
37+
38+
Next, extract the python-flint archive and run::
39+
40+
python ./setup.py build_ext
41+
sudo python ./setup.py install
42+
python ./test.py
43+
44+
Note: if FLINT is not installed globally, you can do something like the following (the second
45+
line is required for loading FLINT from Python)::
46+
47+
python ./setup.py build_ext --include-dirs=/home/fredrik/src/flint2 --library-dirs=/home/fredrik/src/flint2
48+
export LD_LIBRARY_PATH=/home/fredrik/src/flint2/:$LD_LIBRARY_PATH
49+
50+
If everything worked, you will be able to import the ``flint`` module
51+
in Python::
52+
53+
Python 2.7.3 (default, Apr 20 2012, 22:39:59)
54+
[GCC 4.6.3] on linux2
55+
Type "help", "copyright", "credits" or "license" for more information.
56+
>>> import flint
57+
>>> flint.fmpz(33) ** 33
58+
fmpz(129110040087761027839616029934664535539337183380513)
59+
60+
Reference
61+
::::::::::::
62+
63+
Scalar types
64+
............
65+
66+
fmpz
67+
------------------------------------------------------------
68+
69+
.. autoclass :: flint.fmpz
70+
:members:
71+
:undoc-members:
72+
73+
fmpq
74+
------------------------------------------------------------
75+
76+
.. autoclass :: flint.fmpq
77+
:members:
78+
:undoc-members:
79+
80+
nmod
81+
------------------------------------------------------------
82+
83+
.. autoclass :: flint.nmod
84+
:members:
85+
:undoc-members:
86+
87+
Polynomial types
88+
................
89+
90+
fmpz_poly
91+
------------------------------------------------------------
92+
93+
.. autoclass :: flint.fmpz_poly
94+
:members:
95+
:undoc-members:
96+
97+
fmpq_poly
98+
------------------------------------------------------------
99+
100+
.. autoclass :: flint.fmpq_poly
101+
:members:
102+
:undoc-members:
103+
104+
nmod_poly
105+
------------------------------------------------------------
106+
107+
.. autoclass :: flint.nmod_poly
108+
:members:
109+
:undoc-members:
110+
111+
Matrix types
112+
............
113+
114+
fmpz_mat
115+
------------------------------------------------------------
116+
117+
.. autoclass :: flint.fmpz_mat
118+
:members:
119+
:undoc-members:
120+
121+
fmpq_mat
122+
------------------------------------------------------------
123+
124+
.. autoclass :: flint.fmpq_mat
125+
:members:
126+
:undoc-members:
127+
128+
nmod_mat
129+
------------------------------------------------------------
130+
131+
.. autoclass :: flint.nmod_mat
132+
:members:
133+
:undoc-members:
134+
135+
Special functions
136+
.................
137+
138+
.. autofunction :: flint.number_of_partitions

‎doc/build/html/_static/ajax-loader.gif‎

673 Bytes
Loading

0 commit comments

Comments
 (0)