nlsq.diagnostics.AnalysisResult¶

class nlsq.diagnostics.AnalysisResult(available=True, error_message=None, computation_time_ms=0.0)[source]¶

Bases: object

Base class for analysis results.

Provides common attributes for tracking whether an analysis completed successfully, any error messages, and timing information.

available¶

Whether the analysis completed successfully.

Type:: bool

error_message¶

Error message if analysis failed.

Type:: str | None

computation_time_ms¶

Time taken to compute this analysis in milliseconds.

Type:: float

Examples

>>> result = AnalysisResult()
>>> result.available
True
>>> result = AnalysisResult(available=False, error_message="SVD failed")
>>> result.available
False
>>> result.error_message
'SVD failed'

available: bool¶

error_message: str | None¶

computation_time_ms: float¶

__init__(available=True, error_message=None, computation_time_ms=0.0)¶