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

Class ShiftOperator

source code

              object --+    
                       |    
interface.LinearOperator --+
                           |
                          ShiftOperator


A LinearOperator corresponding to a shift matrix

Attributes
----------
shift: signed int
    Output vector elements are shifted according to the shift attribute.
    If positive, shift toward superdiagonals, and toward subdiagonal if negative.

References
----------
http://en.wikipedia.org/wiki/Shift_matrix

Instance Methods [hide private]
 
__init__(self, shape, shift, **kwargs)
x.__init__(...) initializes x; see help(type(x)) for signature
source code
 
__repr__(self)
repr(x)
source code

Inherited from interface.LinearOperator: __add__, __iadd__, __imul__, __isub__, __mul__, __neg__, __pow__, __radd__, __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, shift, **kwargs)
(Constructor)

source code 

x.__init__(...) initializes x; see help(type(x)) for signature

Overrides: object.__init__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)