Interfaces for mCIT Components

class ITestMarkedCI

Interface specifying how to expose (custom) implementations of marked conditional independence tests.

class Result

Structured output of mCIT.

__init__(result_string: _three_way_result_t)

Initialize from completed query’s result.

Parameters:

result_string (Literal["dependent", "independent", "regime", "weak or regime"]) – The concluded categorization of data.

result_string: _three_way_result_t

is_regime() → bool

Inspect the result to check if a true regime was found.

Returns:

Truth-value about the presence of a true-regime.

Return type:

bool

is_globally_dependent() → bool

Inspect the result to check if any sort of dependence (global, weak-regime or true-regime) was found.

Returns:

Truth-value about the presence of dependence.

Return type:

bool

is_globally_independent() → bool

Inspect the result to check if no dependence was found.

Returns:

Truth-value about global independence.

Return type:

bool

marked_independence(data: CIT_DataPatterned) → Result

Test marked conditional independence on the supplied data.

Parameters:

data (CIT_DataPatterned) – The data associated to the test to perform.

Returns:

The structured mCIT output.

Return type:

ITestMarkedCI.Result

class ITestHomogeneity

Interface specifying how to expose (custom) implementations of homogeneity-tests.

is_homogeneous(data: CIT_DataPatterned) → bool

Test if the data supplied by the query is homogenous.

Parameters:

data (CIT_DataPatterned) – The data to inspect.

Returns:

The truth-value indicating if the data-set was accepted as homogenous.

Return type:

bool

class ITestWeakRegime

Interface specifying how to expose (custom) implementations of weak-regime tests.

has_true_regime(data: CIT_DataPatterned) → bool

Test if the non-homogenous data supplied by the query contains a true or just a weak regime.

Parameters:

data (CIT_DataPatterned) – The non-homogenous data to inspect.

Returns:

The truth-value indicating if the data-set is beliefed to feature a true regime.

Return type:

bool

class ITestIndicatorImplications

Interface specifying how to expose (custom) implementations of indicator-relation tests.

is_implied_regime(A_list: list[CIT_DataPatterned], B: CIT_DataPatterned) → bool

Test the indicator implication all test of lhs list are independent \(\Rightarrow\) the test on the rhs is independent.

Parameters:

• A_list (list[CIT_DataPatterned]) – the lhs list of tests

• B (CIT_DataPatterned) – the rhs test

Returns:

The truth-value of the given implication.

Return type:

bool