Package PyDSTool :: Module common :: Class metric
[hide private]
[frames] | no frames]

Class metric

source code

object --+
         |
        metric
Known Subclasses:

Abstract metric class for quantitatively comparing scalar or vector quantities. Can include optional explicit Jacobian function.

Create concrete sub-classes for specific applications. Store the measured (*1D array only*) value in self.results for use as part of a parameter estimation residual value. Residual norm will be taken by optimizer routines.

Instance Methods [hide private]
 
__init__(self)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
 
__call__(self, x, y) source code
 
Jac(self, x, y) source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)