Package linear_operators :: Module interface

Module interface



Classes
-------

LinearOperator : Provides the LinearOperator class, which is the base
    class for all operators. This class is shamelessly taken from the
    scipy.sparse.linalg package.

Functions
---------

aslinearoperator : transforms a class with the matvec method into a
    LinearOperator

concatenate : Transform a list of LinearOperators into a
    LinearOperator by concatenation.

block_diagonal : Transform a list of LinearOperators into a
    block-diagonal LinearOperator with given LinearOperators on the
    diagonal.

Classes

[hide private]

LinearOperator
Common interface for performing matrix vector products

Functions

[hide private]

_mat_mul(matvec1, matvec2)
Functional composition of two matvec functions

source code

_mat_add(matvec1, matvec2)
Functional addition of two matvec functions

source code

_mat_scalar(matvec0, scalar)

source code

aslinearoperator(A)
Return A as a LinearOperator.

source code

concatenate(As, axis=0)
Concatenate LinearOperator in rows or in columns.

source code

block_diagonal(As)
Defines a block diagonal LinearOperator from a list of LinearOperators.

source code

Variables

[hide private]

__package__ = 'linear_operators'

Function Details

[hide private]

aslinearoperator(A)

source code

Return A as a LinearOperator.

'A' may be any of the following types:
 - ndarray
 - matrix
 - sparse matrix (e.g. csr_matrix, lil_matrix, etc.)
 - LinearOperator
 - An object with .shape and .matvec attributes

See the LinearOperator documentation for additonal information.

Examples
--------
>>> from scipy import matrix
>>> M = matrix( [[1,2,3],[4,5,6]], dtype='int32' )
>>> aslinearoperator( M )
<2x3 LinearOperator with dtype=int32>

concatenate(As, axis=0)

source code


Concatenate LinearOperator in rows or in columns.

Parameters
----------
As : list of LinearOperators
     The list of LinearOperators to concatenate.

axis : 0 or 1
       The axis along which to concatenate the LinearOperators.

Returns
-------
out: LinearOperator
  Output a LinearOperator which is the concatenation of a list of 
  LinearOpeartors.