Skip to content

Commit

Permalink
Updated docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
HERA-Observer committed Jan 9, 2025
1 parent 816699e commit a07cf19
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions src/linsolve/linsolve.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@
describing the equation (which is parsed according to python syntax) and each
value is the corresponding "measured" value of that equation. Variable names
in equations are checked against keyword arguments to the solver to determine
if they are provided constants or parameters to be solved for. Parameter anmes
if they are provided constants or parameters to be solved for. Parameter names
and solutions are return are returned as key:value pairs in ls.solve().
Parallel instances of equations can be evaluated by providing measured values
as numpy arrays. Constants can also be arrays that comply with standard numpy
broadcasting rules. Finally, weighting is implemented through an optional wgts
dictionary that parallels the construction of data.
LinearSolver solves linear equations of the form 'a*x + b*y + c*z'.
LinearSolver solves linear equations of the form 'a*x + b*y + c*z + d'.
LogProductSolver uses logrithms to linearize equations of the form 'x*y*z'.
LinProductSolver uses symbolic Taylor expansion to linearize equations of the
form 'x*y + y*z'.
Expand Down Expand Up @@ -308,7 +308,7 @@ def infer_dtype(values):

class LinearSolver:
def __init__(self, data, wgts={}, sparse=False, **kwargs):
"""Set up a linear system of equations of the form 1*a + 2*b + 3*c = 4.
"""Set up a linear system of equations of the form 1*a + 2*b + 3*c + 4 = 5.
Parameters
----------
Expand Down

0 comments on commit a07cf19

Please sign in to comment.