spey.hypothesis_testing.upper_limits.find_root_limits

spey.hypothesis_testing.upper_limits.find_root_limits#

spey.hypothesis_testing.upper_limits.find_root_limits(computer: Callable[[float], float], loc: float = 0.0, low_ini: float = 1.0, hig_ini: float = 1.0, low_bound: float = 1e-10, hig_bound: float = 100000.0) → Tuple[ComputerWrapper, ComputerWrapper][source]#

Find upper and lower bracket limits for the root finding algorithm

Parameters:

  • computer (Callable[[float], float]) – Function that we want to find the root

  • loc (float, default 0.0) – location of the root e.g. 0.95 for \(1-CL_s\) value

  • low_ini (float, default 1.0) – Initial value for low bracket

  • hig_ini (float, default 1.0) – initial value for high bracket

  • low_bound (float, default 1e-10) – Stop the execution below this value

  • hig_bound (float, default 1e5) – Stop the execution above this value

Returns:

Returns lower and upper limits for the bracketing within a computer wrapper object.

Return type:

Tuple[ComputerWrapper, ComputerWrapper]

Contents