1 """
2 linear_operators is a package implementing estimation algorithms for
3 large scale linear problems. The workflow is as follows : generate a
4 linear model using LinearOperator instances as buildling blocks,
5 define a criterion to minimize using this model, and finally perform
6 minimization on the criterion using a given minimization algorithm.
7
8 Subpackages implements each part of this workflow. Here is a list of
9 the subpackages :
10
11 - interface : Taken from the scipy.sparse package. It implement the
12 LinearOperator class which replaces matrices and do not require to
13 store any matrix coefficient. It makes use of matrix-vector
14 operations instead.
15
16 - operators : A set of LinearOperator subclasses implementing various
17 linear operation on vectors and their transpose.
18
19 - ndoperators : A set of LinarOperator subclasses implementing
20 operations on multidimensional arrays.
21
22 - iterative : Contains the Criterion class which allows to define objective
23 function as well as minimizers such as the conjugate gradient algorithms
24 and wrappers to other minimizing algorithms.
25
26 - wrappers : define extra LinearOperator subclasses if optional
27 dependencies are available.
28
29 """
30
31 from interface import *
32 from iterative import *
33 from operators import *
34 from ndoperators import *
35 from wrappers import *
36