Package SloppyCell :: Module Residuals :: Class Residual
[hide private]

Class Residual

source code

Instance Methods [hide private]
 
__init__(self, key) source code
 
GetKey(self)
A unique (and hashable) identifier for this residual.
source code
 
GetValue(self, predictions, internalVars, params)
The value of the residual give a current set of parameters and resulting predictions.
source code
 
GetRequiredVarsByCalc(self)
The variables that need to be calculated to evaluate this residual.
source code
 
dp(self, predictions, internalVars, params)
Partial derivative of the residual with respect to any parameters.
source code
 
dy(self, predictions, internalVars, params)
Partial derivative of the residual with respect to any calculated variables.
source code
 
dintVars(self, predictions, internalVars, params)
Partial derivative of the residual with respect to any internal variables.
source code
 
Dp(self, predictions, senspredictions, internalVars, internalVarsDerivs, params)
Total derivatives with respect to all parameters of the residual.
source code
Method Details [hide private]

GetRequiredVarsByCalc(self)

source code 

The variables that need to be calculated to evaluate this residual.

Should return a nested dictionary of the form:
    {calc name: {dependent var name: [independent var values]}}

dp(self, predictions, internalVars, params)

source code 

Partial derivative of the residual with respect to any parameters.

Should return a dictionary of the form:
    {parameter name: derivative}

dy(self, predictions, internalVars, params)

source code 

Partial derivative of the residual with respect to any calculated 
variables.

Should return a dictionary of the form:
    {calculation name: {variable name: {x value: deriv}}}

dintVars(self, predictions, internalVars, params)

source code 

Partial derivative of the residual with respect to any internal
variables.

Should return a dictionary of the form:
    {type of internal var: {expt name: {variable name: derivative}}}

XXX: This form of nesting is only appropriate for scale factors.

Dp(self, predictions, senspredictions, internalVars, internalVarsDerivs, params)

source code 

Total derivatives with respect to all parameters of the residual.

Should return a list with the derivatives in the same order as params.

XXX: This only works with internvalVars that are indexed like scale
factors.