Hyperiso 1.0.3
Modular flavour-physics calculations, Wilson coefficients and statistical inference
Loading...
Searching...
No Matches
MCResult.MCConfig Class Reference

Public Member Functions

"MCConfig" from_cpp (cls, cpp_obj)
 
 to_cpp (self)
 

Static Public Attributes

int draws = 10000
 
float skew_abs_threshold = 0.2
 
float covariance_ridge_rel = 1e-8
 
float covariance_ridge_abs = 1e-12
 
bool retry_failed_predictions = True
 
int max_prediction_failures = 20000
 

Detailed Description

Options controlling Monte-Carlo uncertainty propagation.

Attributes:
    draws: Number of accepted Monte-Carlo predictions to generate.
    skew_abs_threshold: Absolute skewness threshold below which an
        observable distribution is treated as symmetric.
    covariance_ridge_rel: Relative diagonal ridge added before covariance
        inversion.
    covariance_ridge_abs: Absolute minimum diagonal ridge.
    retry_failed_predictions: Whether failed model predictions should be
        skipped and retried.
    max_prediction_failures: Maximum number of rejected predictions before
        the backend propagates the failure.

Definition at line 72 of file MCResult.py.

Member Function Documentation

◆ from_cpp()

"MCConfig" MCResult.MCConfig.from_cpp (   cls,
  cpp_obj 
)
Create Python options from a bound C++ ``MCConfig``.

Definition at line 96 of file MCResult.py.

◆ to_cpp()

MCResult.MCConfig.to_cpp (   self)
Convert this config to a bound C++ ``MCConfig`` object.

Definition at line 107 of file MCResult.py.

Member Data Documentation

◆ covariance_ridge_abs

float MCResult.MCConfig.covariance_ridge_abs = 1e-12
static

Definition at line 91 of file MCResult.py.

◆ covariance_ridge_rel

float MCResult.MCConfig.covariance_ridge_rel = 1e-8
static

Definition at line 90 of file MCResult.py.

◆ draws

int MCResult.MCConfig.draws = 10000
static

Definition at line 88 of file MCResult.py.

◆ max_prediction_failures

int MCResult.MCConfig.max_prediction_failures = 20000
static

Definition at line 93 of file MCResult.py.

◆ retry_failed_predictions

bool MCResult.MCConfig.retry_failed_predictions = True
static

Definition at line 92 of file MCResult.py.

◆ skew_abs_threshold

float MCResult.MCConfig.skew_abs_threshold = 0.2
static

Definition at line 89 of file MCResult.py.


The documentation for this class was generated from the following file: