Skip to content
voiage

voiage.experimental.study_design.calculate_coss

calculate_coss

Section titled “calculate_coss”
calculate_coss([keyword-only] context: StudyDesignContextV1 = None, [keyword-only] designs: Sequence[StudyDesignPointInputV1] = None, [keyword-only] declared_feasible_range: FeasibleDesignRangeV1 | tuple[int, int] | None = None, [keyword-only] tie_policy: TiePolicy = 'smallest_sample_size', [keyword-only] absolute_tolerance: float = _DEFAULT_ATOL, [keyword-only] relative_tolerance: float = _DEFAULT_RTOL, [keyword-only] selection_uncertainty: SelectionUncertaintyV1 | None = None, [keyword-only] enumeration_scope: EnumerationScope = 'evaluated_set_only', [keyword-only] no_study_enbs: float = 0.0, [keyword-only] joint_enbs_replicates: Sequence[Sequence[float]] | None = None, [keyword-only] joint_replicate_method: Literal['joint_bootstrap', 'joint_monte_carlo'] = 'joint_bootstrap', [keyword-only] replay_artifact: str | None = None) -> CossResultV1

Evaluate a finite COSS curve using the Rust signed-ENBS kernel.

Parameters:

  • context StudyDesignContextV1
  • designs Sequence[StudyDesignPointInputV1]
  • declared_feasible_range FeasibleDesignRangeV1 | tuple[int, int] | None (default: None)
  • tie_policy TiePolicy (default: 'smallest_sample_size')
  • absolute_tolerance float (default: _DEFAULT_ATOL)
  • relative_tolerance float (default: _DEFAULT_RTOL)
  • selection_uncertainty SelectionUncertaintyV1 | None (default: None)
  • enumeration_scope EnumerationScope (default: 'evaluated_set_only')
  • no_study_enbs float (default: 0.0)
  • joint_enbs_replicates Sequence[Sequence[float]] | None (default: None)
  • joint_replicate_method Literal['joint_bootstrap', 'joint_monte_carlo'] (default: 'joint_bootstrap')
  • replay_artifact str | None (default: None)

Returns: CossResultV1