Package linear_operators :: Module operators :: Class IdentityOperator
[hide private]
[frames] | no frames]

Class IdentityOperator

source code

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

SymmetricOperator with identity matvec (lambda x: x).

Instance Methods [hide private]
 
__init__(self, shape, **kwargs)
Instantiate an IdentityOperator.
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, **kwargs)
(Constructor)

source code 
Instantiate an IdentityOperator.

Parameters
----------

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

Returns
-------
An IdentityOperator instance.

Exemple
-------
>>> import linear_operators as lo
>>> I = lo.IdentityOperator((3, 3))
>>> I.todense()
array([[ 1.,  0.,  0.],
       [ 0.,  1.,  0.],
       [ 0.,  0.,  1.]])

Overrides: object.__init__