Package linear_operators :: Package iterative :: Module norms :: Class Norm2
[hide private]
[frames] | no frames]

Class Norm2

source code

object --+    
         |    
      Norm --+
             |
            Norm2


A norm-2 class. Optionally accepts a covariance matrix C.
If C is given, the norm would be : np.dot(x.T, C * x).
Otherwise, it would be norm2(x).

Parameters
----------

C : LinearOperator (None)
    The covariance matrix of the norm.

Returns
-------
Returns a Norm2 instance with a __call__ and a diff method.

Instance Methods [hide private]
 
__init__(self, C=None)
x.__init__(...) initializes x; see help(type(x)) for signature
source code

Inherited from Norm: __call__, diff

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, C=None)
(Constructor)

source code 

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

Overrides: object.__init__
(inherited documentation)