From 91e88a5fe4c4c52f11d5f3b3b9d1dc9d9e389c27 Mon Sep 17 00:00:00 2001 From: "Leo C. Stein" Date: Sun, 10 Mar 2019 22:32:20 -0500 Subject: [PATCH] Bit more documentation --- qnm/spinsequence.py | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/qnm/spinsequence.py b/qnm/spinsequence.py index 65aa965..f287dd1 100644 --- a/qnm/spinsequence.py +++ b/qnm/spinsequence.py @@ -283,7 +283,10 @@ def do_find_sequence(self): self.build_interps() def build_interps(self): - """ TODO document """ + """Build interpolating functions for omega(a) and A(a). + + This is automatically called at the end of :meth:`do_find_sequence`. + """ # TODO do we want to allow extrapolation? @@ -311,7 +314,26 @@ def build_interps(self): k=k, ext=0) def __call__(self, a): - """ TODO document """ + """Solve for omega, A, and C[] at a given spin a. + + This uses the interpolants, based on the solved sequence, for + initial guesses of omega(a) and A(a). + + Parameters + ---------- + a: float + Value of spin, 0 <= a < 1. + + Returns + ------- + complex, complex, complex ndarray + The first element of the tuple is omega. The second element + of the tuple is A. The third element of the tuple is the + array of complex spherical-spheroidal decomposition + coefficients. + """ + + # TODO Make sure that interpolants have been built # TODO validate input, 0 <= a < 1. # TODO if a > a_max then extend