Specification

class IConstructStateSpace

Interface specifying how to expose (custom) implementations of state-space-construction for use with Controller.

construct_statespace(testing_backend: IProvideIndependenceAtoms, marked_tests: set[CI_Identifier], previous_graphs: dict[IRepresentState, graph_t]) IRepresentStateSpace

Construct state-space.

Parameters:
Returns:

state-space

Return type:

IRepresentStateSpace

class IRepresentStateSpace

Interface specifying how to expose (custom) implementations of state-space-representation during state-space construction for use with Controller. State-space construction will typically internally attach further information, this interface only specifies which aspects must be exposed for the Controller during HCCD.

states() list[IRepresentState]

States contained in this state-space.

Returns:

list of states

Return type:

list[IRepresentState]

finalize(graphs: dict[IRepresentState, graph_t]) IPresentResult

Translate to model-properties and transfer information between states into a result-summary.

Parameters:

graphs (dict[IRepresentState,graph_t]) – state-specific graph for each state

Returns:

the summarized result

Return type:

IPresentResult

class IRepresentState

Interface specifying how to expose (custom) implementations of state-representation during state-space construction for use with Controller. State-space construction will typically internally attach further information, this interface only specifies which aspects must be exposed for the Controller during HCCD.

state_space() IRepresentStateSpace

Get containing state-space.

Returns:

state-space

Return type:

IRepresentStateSpace

overwrites_ci(ci: CI_Identifier) bool

Is this conditional independence marked?

Parameters:

ci (CI_Identifier) – conditional independence

Returns:

truth-value of CI being marked

Return type:

bool

get_ci_pseudo_value(ci: CI_Identifier) bool

Get a (state-encoded) value for a marked conditional independence.

Parameters:

ci (CI_Identifier) – marked conditional independence

Returns:

state-specific dependence-value (true for dependent).

Return type:

bool

class IPresentResult

Interface specifying how to expose (custom) implementations of backend hccd-results.

See also

The frontend typically translates this into a more user-friendly frontend.Result.

union_graph() graph_t

Get the union-graph

Returns:

union-graph (tigramite encoded)

Return type:

graph_t

state_graphs() list[graph_t]

Get the state-specific graphs.

Returns:

list of state-specific graphs (tigramite encoded)

Return type:

list[graph_t]

model_indicators() list

Get the model-indicators. Translation is state-space-construction specific.

Returns:

model-indicators

Return type:

list