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

Class PermutationOperator

source code

              object --+    
                       |    
interface.LinearOperator --+
                           |
                          PermutationOperator


Perform permutations to the vector elements.

Attributes
----------
perm : list or tuple
    The permutation of coefficients.

Instance Methods [hide private]
 
__init__(self, perm, **kwargs)
Parameters ---------- perm : list or tuple The permutation of coefficients.
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, perm, **kwargs)
(Constructor)

source code 

Parameters
----------
perm : list or tuple
    The permutation of coefficients.

Returns
-------
A PermutationOperator instance.

Exemple
-------
>>> import numpy as np
>>> import linear_operators as lo
>>> P = lo.PermutationOperator([3, 1, 0, 2])
>>> P.todense()
array([[ 0.,  0.,  0.,  1.],
       [ 0.,  1.,  0.,  0.],
       [ 1.,  0.,  0.,  0.],
       [ 0.,  0.,  1.,  0.]])

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)