From 52d3aa659dfa727d41d2a57212f406cbcb98b69f Mon Sep 17 00:00:00 2001 From: Mukundan Senthil Date: Tue, 16 Jun 2020 11:54:57 +0530 Subject: [PATCH] Update docs --- docs/API/algebra.rst | 6 -- docs/API/combinatorics.rst | 6 -- docs/API/data_structures.rst | 6 -- docs/API/geometry.rst | 6 -- docs/API/graphs.rst | 6 -- docs/API/index.rst | 7 -- docs/API/linear_algebra.rst | 6 -- docs/API/misc.rst | 6 -- docs/API/numerical.rst | 6 -- docs/API/pyrival.algebra.rst | 106 +++++++++++++++++++ docs/API/pyrival.combinatorics.rst | 26 +++++ docs/API/pyrival.data_structures.rst | 146 +++++++++++++++++++++++++++ docs/API/pyrival.geometry.rst | 34 +++++++ docs/API/pyrival.graphs.rst | 146 +++++++++++++++++++++++++++ docs/API/pyrival.linear_algebra.rst | 26 +++++ docs/API/pyrival.misc.rst | 130 ++++++++++++++++++++++++ docs/API/pyrival.numerical.rst | 58 +++++++++++ docs/API/pyrival.rst | 16 +++ docs/API/pyrival.strings.rst | 58 +++++++++++ docs/API/pyrival.tools.rst | 18 ++++ docs/API/strings.rst | 6 -- docs/index.rst | 2 +- 22 files changed, 765 insertions(+), 62 deletions(-) delete mode 100644 docs/API/algebra.rst delete mode 100644 docs/API/combinatorics.rst delete mode 100644 docs/API/data_structures.rst delete mode 100644 docs/API/geometry.rst delete mode 100644 docs/API/graphs.rst delete mode 100644 docs/API/index.rst delete mode 100644 docs/API/linear_algebra.rst delete mode 100644 docs/API/misc.rst delete mode 100644 docs/API/numerical.rst create mode 100644 docs/API/pyrival.algebra.rst create mode 100644 docs/API/pyrival.combinatorics.rst create mode 100644 docs/API/pyrival.data_structures.rst create mode 100644 docs/API/pyrival.geometry.rst create mode 100644 docs/API/pyrival.graphs.rst create mode 100644 docs/API/pyrival.linear_algebra.rst create mode 100644 docs/API/pyrival.misc.rst create mode 100644 docs/API/pyrival.numerical.rst create mode 100644 docs/API/pyrival.rst create mode 100644 docs/API/pyrival.strings.rst create mode 100644 docs/API/pyrival.tools.rst delete mode 100644 docs/API/strings.rst diff --git a/docs/API/algebra.rst b/docs/API/algebra.rst deleted file mode 100644 index 1033ba0..0000000 --- a/docs/API/algebra.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.algebra -*************** - -.. automodule:: pyrival.algebra - :members: - :undoc-members: diff --git a/docs/API/combinatorics.rst b/docs/API/combinatorics.rst deleted file mode 100644 index 206f4c2..0000000 --- a/docs/API/combinatorics.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.combinatorics -********************* - -.. automodule:: pyrival.combinatorics - :members: - :undoc-members: diff --git a/docs/API/data_structures.rst b/docs/API/data_structures.rst deleted file mode 100644 index 565f9b6..0000000 --- a/docs/API/data_structures.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.data_structures -*********************** - -.. automodule:: pyrival.data_structures - :members: - :undoc-members: diff --git a/docs/API/geometry.rst b/docs/API/geometry.rst deleted file mode 100644 index 0dc07ef..0000000 --- a/docs/API/geometry.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.geometry -**************** - -.. automodule:: pyrival.geometry - :members: - :undoc-members: diff --git a/docs/API/graphs.rst b/docs/API/graphs.rst deleted file mode 100644 index 005e92a..0000000 --- a/docs/API/graphs.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.graphs -************** - -.. automodule:: pyrival.graphs - :members: - :undoc-members: diff --git a/docs/API/index.rst b/docs/API/index.rst deleted file mode 100644 index 6018347..0000000 --- a/docs/API/index.rst +++ /dev/null @@ -1,7 +0,0 @@ -API Reference -************* - -.. toctree:: - :glob: - - * diff --git a/docs/API/linear_algebra.rst b/docs/API/linear_algebra.rst deleted file mode 100644 index 3065a6d..0000000 --- a/docs/API/linear_algebra.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.linear_algebra -********************** - -.. automodule:: pyrival.linear_algebra - :members: - :undoc-members: diff --git a/docs/API/misc.rst b/docs/API/misc.rst deleted file mode 100644 index 1d5b55b..0000000 --- a/docs/API/misc.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.misc -************ - -.. automodule:: pyrival.misc - :members: - :undoc-members: diff --git a/docs/API/numerical.rst b/docs/API/numerical.rst deleted file mode 100644 index f38263b..0000000 --- a/docs/API/numerical.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.numerical -***************** - -.. automodule:: pyrival.numerical - :members: - :undoc-members: diff --git a/docs/API/pyrival.algebra.rst b/docs/API/pyrival.algebra.rst new file mode 100644 index 0000000..1247ec8 --- /dev/null +++ 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 new file mode 100644 index 0000000..be637da --- /dev/null +++ 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 new file mode 100644 index 0000000..bf18fd7 --- /dev/null +++ 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 new file mode 100644 index 0000000..765569b --- /dev/null +++ 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: diff --git a/docs/API/pyrival.graphs.rst b/docs/API/pyrival.graphs.rst new file mode 100644 index 0000000..5f3b257 --- /dev/null +++ b/docs/API/pyrival.graphs.rst @@ -0,0 +1,146 @@ +pyrival.graphs +============== + +pyrival.graphs.bellman\_ford +---------------------------- + +.. automodule:: pyrival.graphs.bellman_ford + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.bfs +------------------ + +.. automodule:: pyrival.graphs.bfs + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.components +------------------------- + +.. automodule:: pyrival.graphs.components + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.cycle\_finding +----------------------------- + +.. automodule:: pyrival.graphs.cycle_finding + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.dfs +------------------ + +.. automodule:: pyrival.graphs.dfs + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.dijkstra +----------------------- + +.. automodule:: pyrival.graphs.dijkstra + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.dinic +-------------------- + +.. automodule:: pyrival.graphs.dinic + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.euler\_walk +-------------------------- + +.. automodule:: pyrival.graphs.euler_walk + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.find\_path +------------------------- + +.. automodule:: pyrival.graphs.find_path + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.floyd\_warshall +------------------------------ + +.. automodule:: pyrival.graphs.floyd_warshall + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.hopcroft\_karp +----------------------------- + +.. automodule:: pyrival.graphs.hopcroft_karp + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.is\_bipartite +---------------------------- + +.. automodule:: pyrival.graphs.is_bipartite + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.kruskal +---------------------- + +.. automodule:: pyrival.graphs.kruskal + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.lca +------------------ + +.. automodule:: pyrival.graphs.lca + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.maximum\_matching +-------------------------------- + +.. automodule:: pyrival.graphs.maximum_matching + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.prim +------------------- + +.. automodule:: pyrival.graphs.prim + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.scc +------------------ + +.. automodule:: pyrival.graphs.scc + :members: + :undoc-members: + :show-inheritance: + +pyrival.graphs.toposort +----------------------- + +.. automodule:: pyrival.graphs.toposort + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/pyrival.linear_algebra.rst b/docs/API/pyrival.linear_algebra.rst new file mode 100644 index 0000000..0844b95 --- /dev/null +++ b/docs/API/pyrival.linear_algebra.rst @@ -0,0 +1,26 @@ +pyrival.linear\_algebra +======================= + +pyrival.linear\_algebra.matrix +------------------------------ + +.. automodule:: pyrival.linear_algebra.matrix + :members: + :undoc-members: + :show-inheritance: + +pyrival.linear\_algebra.max\_xor +-------------------------------- + +.. automodule:: pyrival.linear_algebra.max_xor + :members: + :undoc-members: + :show-inheritance: + +pyrival.linear\_algebra.multivariable\_crt +------------------------------------------ + +.. automodule:: pyrival.linear_algebra.multivariable_crt + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/pyrival.misc.rst b/docs/API/pyrival.misc.rst new file mode 100644 index 0000000..900d5d8 --- /dev/null +++ b/docs/API/pyrival.misc.rst @@ -0,0 +1,130 @@ +pyrival.misc +============ + +pyrival.misc.FastIO +------------------- + +.. automodule:: pyrival.misc.FastIO + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.Random +------------------- + +.. automodule:: pyrival.misc.Random + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.alphabeta +---------------------- + +.. automodule:: pyrival.misc.alphabeta + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.as\_integer\_ratio +------------------------------- + +.. automodule:: pyrival.misc.as_integer_ratio + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.bit\_hacks +----------------------- + +.. automodule:: pyrival.misc.bit_hacks + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.bootstrap +---------------------- + +.. automodule:: pyrival.misc.bootstrap + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.cumsum2d +--------------------- + +.. automodule:: pyrival.misc.cumsum2d + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.lis +---------------- + +.. automodule:: pyrival.misc.lis + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.memoize +-------------------- + +.. automodule:: pyrival.misc.memoize + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.mod +---------------- + +.. automodule:: pyrival.misc.mod + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.order\_statistic +----------------------------- + +.. automodule:: pyrival.misc.order_statistic + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.ordersort +---------------------- + +.. automodule:: pyrival.misc.ordersort + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.ostream +-------------------- + +.. automodule:: pyrival.misc.ostream + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.py3k +----------------- + +.. automodule:: pyrival.misc.py3k + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.readnumbers +------------------------ + +.. automodule:: pyrival.misc.readnumbers + :members: + :undoc-members: + :show-inheritance: + +pyrival.misc.split +------------------ + +.. automodule:: pyrival.misc.split + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/pyrival.numerical.rst b/docs/API/pyrival.numerical.rst new file mode 100644 index 0000000..ebee1fd --- /dev/null +++ b/docs/API/pyrival.numerical.rst @@ -0,0 +1,58 @@ +pyrival.numerical +================= + +pyrival.numerical.berlekamp\_massey +----------------------------------- + +.. automodule:: pyrival.numerical.berlekamp_massey + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.hill\_climbing +-------------------------------- + +.. automodule:: pyrival.numerical.hill_climbing + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.integrate +--------------------------- + +.. automodule:: pyrival.numerical.integrate + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.interpolate +----------------------------- + +.. automodule:: pyrival.numerical.interpolate + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.iroot +----------------------- + +.. automodule:: pyrival.numerical.iroot + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.polynomial +---------------------------- + +.. automodule:: pyrival.numerical.polynomial + :members: + :undoc-members: + :show-inheritance: + +pyrival.numerical.search +------------------------ + +.. automodule:: pyrival.numerical.search + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/pyrival.rst b/docs/API/pyrival.rst new file mode 100644 index 0000000..f4656e1 --- /dev/null +++ b/docs/API/pyrival.rst @@ -0,0 +1,16 @@ +API Reference +============= + +.. toctree:: + :maxdepth: 4 + + pyrival.algebra + pyrival.combinatorics + pyrival.data_structures + pyrival.geometry + pyrival.graphs + pyrival.linear_algebra + pyrival.misc + pyrival.numerical + pyrival.strings + pyrival.tools diff --git a/docs/API/pyrival.strings.rst b/docs/API/pyrival.strings.rst new file mode 100644 index 0000000..92207c9 --- /dev/null +++ b/docs/API/pyrival.strings.rst @@ -0,0 +1,58 @@ +pyrival.strings +=============== + +pyrival.strings.LCSubstr +------------------------ + +.. automodule:: pyrival.strings.LCSubstr + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.LPSubstr +------------------------ + +.. automodule:: pyrival.strings.LPSubstr + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.hashing +----------------------- + +.. automodule:: pyrival.strings.hashing + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.kmp +------------------- + +.. automodule:: pyrival.strings.kmp + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.lcs +------------------- + +.. automodule:: pyrival.strings.lcs + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.min\_rotation +----------------------------- + +.. automodule:: pyrival.strings.min_rotation + :members: + :undoc-members: + :show-inheritance: + +pyrival.strings.suffix\_array +----------------------------- + +.. automodule:: pyrival.strings.suffix_array + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/pyrival.tools.rst b/docs/API/pyrival.tools.rst new file mode 100644 index 0000000..abccc1e --- /dev/null +++ b/docs/API/pyrival.tools.rst @@ -0,0 +1,18 @@ +pyrival.tools +============= + +pyrival.tools.interactive\_runner +--------------------------------- + +.. automodule:: pyrival.tools.interactive_runner + :members: + :undoc-members: + :show-inheritance: + +pyrival.tools.stress\_tester +---------------------------- + +.. automodule:: pyrival.tools.stress_tester + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/API/strings.rst b/docs/API/strings.rst deleted file mode 100644 index 9f6523e..0000000 --- a/docs/API/strings.rst +++ /dev/null @@ -1,6 +0,0 @@ -pyrival.strings -*************** - -.. automodule:: pyrival.strings - :members: - :undoc-members: diff --git a/docs/index.rst b/docs/index.rst index 7936619..1d67712 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,7 +11,7 @@ Welcome to PyRival's documentation! :caption: Contents: bootstrap - API/index + API/pyrival