Refactor and document operators and periods in sage module (#21)

--------- Co-authored-by: Julian Piribauer <julian.piribauer@gmail.com> Reviewed-on: #21
2026-10-31 22:22:38 +01:00
parent 6600379681
commit d3412f1ff6
5 changed files with 92 additions and 120 deletions
@@ -1,3 +1,24 @@
+"""
+Picard-Fuchs operators and ideals in the logarithmic derivatives theta_i = z_i * d/dz_i.
+
+Contents
+--------
+PFOperator
+    __init__                      Construct from a string in z- and theta-variables
+    simplify                      Group by z-monomials and factorise theta-polynomials
+    change_coordinates            Rewrite the operator in new coordinates
+    _operator_from_string         Parse a string into the operator polynomial
+
+PFOperatorAnsatz(PFOperator)
+    __init__                      Ansatz of given theta- and z-multi-degrees
+
+PFIdeal
+    __init__                      Construct from a list of PFOperators
+    add_operator                  Append a PFOperator
+    remove_operator               Remove a PFOperator
+    change_coordinates            Rewrite all operators in new coordinates
+    find_power_series_solution    Power series solutions at given indicials/order
+"""
 import copy
 import logging
 from sage.all import sage_eval, PolynomialRing, QQ, SR, function, prod, solve, var