Update docs

cheran-senthil · Jun 16, 2020 · 52d3aa6 · 52d3aa6
1 parent a023219
commit 52d3aa6
Show file tree

Hide file tree

Showing 22 changed files with 765 additions and 62 deletions.
diff --git a/docs/API/algebra.rst b/docs/API/algebra.rst
diff --git a/docs/API/combinatorics.rst b/docs/API/combinatorics.rst
diff --git a/docs/API/data_structures.rst b/docs/API/data_structures.rst
diff --git a/docs/API/geometry.rst b/docs/API/geometry.rst
diff --git a/docs/API/graphs.rst b/docs/API/graphs.rst
diff --git a/docs/API/index.rst b/docs/API/index.rst
diff --git a/docs/API/linear_algebra.rst b/docs/API/linear_algebra.rst
diff --git a/docs/API/misc.rst b/docs/API/misc.rst
diff --git a/docs/API/numerical.rst b/docs/API/numerical.rst
diff --git a/docs/API/pyrival.algebra.rst b/docs/API/pyrival.algebra.rst
@@ -0,0 +1,106 @@
+pyrival.algebra
+===============
+
+pyrival.algebra.chinese\_remainder
+----------------------------------
+
+.. automodule:: pyrival.algebra.chinese_remainder
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.discrete\_log
+-----------------------------
+
+.. automodule:: pyrival.algebra.discrete_log
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.factors
+-----------------------
+
+.. automodule:: pyrival.algebra.factors
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.fft
+-------------------
+
+.. automodule:: pyrival.algebra.fft
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.fst
+-------------------
+
+.. automodule:: pyrival.algebra.fst
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.gcd
+-------------------
+
+.. automodule:: pyrival.algebra.gcd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.is\_prime
+-------------------------
+
+.. automodule:: pyrival.algebra.is_prime
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.mod\_sqrt
+-------------------------
+
+.. automodule:: pyrival.algebra.mod_sqrt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.modinv
+----------------------
+
+.. automodule:: pyrival.algebra.modinv
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.ntt
+-------------------
+
+.. automodule:: pyrival.algebra.ntt
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.phi
+-------------------
+
+.. automodule:: pyrival.algebra.phi
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.primitive\_root
+-------------------------------
+
+.. automodule:: pyrival.algebra.primitive_root
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.algebra.sieve
+---------------------
+
+.. automodule:: pyrival.algebra.sieve
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/API/pyrival.combinatorics.rst b/docs/API/pyrival.combinatorics.rst
@@ -0,0 +1,26 @@
+pyrival.combinatorics
+=====================
+
+pyrival.combinatorics.combinatorics
+-----------------------------------
+
+.. automodule:: pyrival.combinatorics.combinatorics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.combinatorics.nCr\_mod
+------------------------------
+
+.. automodule:: pyrival.combinatorics.nCr_mod
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.combinatorics.partitions
+--------------------------------
+
+.. automodule:: pyrival.combinatorics.partitions
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/API/pyrival.data_structures.rst b/docs/API/pyrival.data_structures.rst
@@ -0,0 +1,146 @@
+pyrival.data\_structures
+========================
+
+pyrival.data\_structures.BitArray
+---------------------------------
+
+.. automodule:: pyrival.data_structures.BitArray
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.CFraction
+----------------------------------
+
+.. automodule:: pyrival.data_structures.CFraction
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.DisjointSetUnion
+-----------------------------------------
+
+.. automodule:: pyrival.data_structures.DisjointSetUnion
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.FenwickTree
+------------------------------------
+
+.. automodule:: pyrival.data_structures.FenwickTree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.Fraction
+---------------------------------
+
+.. automodule:: pyrival.data_structures.Fraction
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.Heap
+-----------------------------
+
+.. automodule:: pyrival.data_structures.Heap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.LazySegmentTree
+----------------------------------------
+
+.. automodule:: pyrival.data_structures.LazySegmentTree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.LinkedList
+-----------------------------------
+
+.. automodule:: pyrival.data_structures.LinkedList
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.Node
+-----------------------------
+
+.. automodule:: pyrival.data_structures.Node
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.PersistentSegTree
+------------------------------------------
+
+.. automodule:: pyrival.data_structures.PersistentSegTree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.RangeQuery
+-----------------------------------
+
+.. automodule:: pyrival.data_structures.RangeQuery
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.SegmentTree
+------------------------------------
+
+.. automodule:: pyrival.data_structures.SegmentTree
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.SortedList
+-----------------------------------
+
+.. automodule:: pyrival.data_structures.SortedList
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.Treap
+------------------------------
+
+.. automodule:: pyrival.data_structures.Treap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.Trie
+-----------------------------
+
+.. automodule:: pyrival.data_structures.Trie
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.TwoSat
+-------------------------------
+
+.. automodule:: pyrival.data_structures.TwoSat
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.convex\_hull\_trick
+--------------------------------------------
+
+.. automodule:: pyrival.data_structures.convex_hull_trick
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.data\_structures.tree\_repr
+-----------------------------------
+
+.. automodule:: pyrival.data_structures.tree_repr
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/API/pyrival.geometry.rst b/docs/API/pyrival.geometry.rst
@@ -0,0 +1,34 @@
+pyrival.geometry
+================
+
+pyrival.geometry.convex\_hull
+-----------------------------
+
+.. automodule:: pyrival.geometry.convex_hull
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.geometry.lines
+----------------------
+
+.. automodule:: pyrival.geometry.lines
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.geometry.polygons
+-------------------------
+
+.. automodule:: pyrival.geometry.polygons
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+pyrival.geometry.vectors
+------------------------
+
+.. automodule:: pyrival.geometry.vectors
+   :members:
+   :undoc-members:
+   :show-inheritance: