Package linear_operators :: Module operators :: Class SymmetricOperator

Class SymmetricOperator

              object --+    
                       |    
interface.LinearOperator --+
                           |
                          SymmetricOperator

Known Subclasses:

Subclass of LinearOperator for the definition of symmetric operators, i.e. operators such that : M^T == M. It only requires a shape and a matvec function, since the rmatvec should be the same function as matvec.

Instance Methods

[hide private]

__init__(self, shape, matvec, **kwargs)
Returns a SymmetricOperator of given shape and matvec function.

source code

Inherited from interface.LinearOperator: __add__, __iadd__, __imul__, __isub__, __mul__, __neg__, __pow__, __radd__, __repr__, __rmul__, __rsub__, __sub__, matmat, matvec, todense

Inherited from interface.LinearOperator (private): _matmat

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties

[hide private]

Inherited from interface.LinearOperator: T

Inherited from object: __class__

Method Details

[hide private]

init(self, shape, matvec, **kwargs)
(Constructor)

source code

Returns a SymmetricOperator of given shape and matvec
function.

Parameters
----------

shape : length 2 tuple
    The shape of the operator. Should be square.

matvec : function
    The matrix-vector operation.

Returns
-------
A SymmetricOperator instance.

Overrides: object.__init__

Class SymmetricOperator

__init__(self, shape, matvec, **kwargs) (Constructor)

init(self, shape, matvec, **kwargs)
(Constructor)