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

Class HomotheticOperator

source code

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


Generate a SymmetricOperator performing an homothety, i.e. a
multiplication of the input vector by a scalar.

Arguments
----------
coef : int float
    Multiplication coefficient

Instance Methods [hide private]
 
__init__(self, shape, coef, **kwargs)
Parameters ---------- shape : length 2 tuple The shape of the operator.
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, coef, **kwargs)
(Constructor)

source code 

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

coef : int or float
    The multiplication coefficient.

Returns
-------
An HomotheticOperator instance.

Exemple
-------
>>> import linear_operators as lo
>>> H = lo.HomotheticOperator((3, 3), 2.)
>>> H.todense()
array([[ 2.,  0.,  0.],
       [ 0.,  2.,  0.],
       [ 0.,  0.,  2.]])

Overrides: object.__init__

__repr__(self)
(Representation operator)

source code 

repr(x)

Overrides: object.__repr__
(inherited documentation)