Skip to main content
Back to Docs

All Functions

Browse all 103 available functions in the library.

Showing 103 of 103 functions
add_init_exit_events_to_ocelin utils::init_exit_events

Add artificial init/exit events to an OCEL

align_empty_tracein case_centric::alignments

Align the empty trace to the given model

align_tracein case_centric::alignments

Compute alignment for a single trace (given as activity sequence).

align_variantsin case_centric::alignments

Compute alignments for all variants from a pre-computed activity projection.

compute_fitnessin case_centric::alignments

Compute fitness stats from alignment results

discover_alpha+++in alphappp::full

Discover a [`PetriNet`] using the Alpha+++ Process Discovery algorithm

discover_dfgin case_centric::dfg

Discover [`DirectlyFollowsGraph`] with default classifier

discover_dfg_from_ocelin ocdfg::object_centric_dfg_struct

Construct an [`OCDirectlyFollowsGraph`] from an OCEL

discover_oc_declarein object_centric::oc_declare

Discover behavioral OC-DECLARE constraints from the given OCEL

dummy_bumpin bindings::tests

Bump a stored handle's counter in place.

dummy_clear_allin bindings::tests

Drop every item in the registry: the `#[bind(state_mut)]` escape hatch, for a binding

dummy_forkin bindings::tests

Bump a stored handle and hand back a copy of it: a handle result stored through the write

dummy_labelin bindings::tests

The label of a stored handle, taken by shared reference.

dummy_log_ofin bindings::tests

A big-type result stored through the write guard, the last of the four insert sites.

dummy_newin bindings::tests

Build a new handle and hand back its registry id.

export_dfg_image_pngin dfg::image_export

Export the image of a [`DirectlyFollowsGraph`] as a PNG file

export_dfg_image_svgin dfg::image_export

Export the image of a [`DirectlyFollowsGraph`] as a SVG file

export_dfg_pngin image_export::private
export_ocel_duckdb_to_pathin duckdb::duckdb_ocel_export
export_petri_net_image_pngin petri_net::image_export

Export the image of a [`PetriNet`] as a PNG file

export_petri_net_image_svgin petri_net::image_export

Export the image of a [`PetriNet`] as a SVG file

export_process_tree_image_pngin process_tree::image_export

Export the image of a [`ProcessTree`] as a PNG file

export_process_tree_image_svgin process_tree::image_export

Export the image of a [`ProcessTree`] as a SVG file

flatten_ocel_onin utils::flatten

Flatten an OCEL on a specific object type, resulting in a case-centric Event Log

get_dfg_of_object_typein bindings::slim_ocel_bindings

Get the directly-follows graph (DFG) for objects of the given object type.

get_dfg_of_object_typein object_centric::dfg

Get the directly-follows graph (DFG) for objects of the given object type.

get_dotted_chartin case_centric::dotted_chart

Generate dotted chart data from an event log.

get_e2o_idsin bindings::slim_ocel_bindings
get_e2o_rev_idsin bindings::slim_ocel_bindings
get_event_ids_of_typein bindings::slim_ocel_bindings
get_event_timestamp_of_idin bindings::slim_ocel_bindings
get_event_timestampsin case_centric::event_timestamp_histogram

Aggregate event timestamps into a fixed number of bins, grouped by activity.

get_event_type_of_idin bindings::slim_ocel_bindings
get_num_casesin utils::activity_projection

Get the total number of cases in the projection

get_num_variantsin utils::activity_projection

Get the number of distinct trace variants in the projection

get_o2o_idsin bindings::slim_ocel_bindings
get_obj_activity_tracein bindings::slim_ocel_bindings

Get the activity trace of an object (i.e., the sequence of event types connected to the object, ordered by event timestamp)

get_object_attribute_changesin object_centric::object_attribute_changes

Extract the attribute change history for a specific object.

get_object_ids_of_typein bindings::slim_ocel_bindings
get_object_type_of_idin bindings::slim_ocel_bindings
get_projection_activitiesin utils::activity_projection

Get the list of all activity names in the projection

get_top_n_variantsin utils::activity_projection

Get the `n` most frequent process variants, sorted by frequency (descending)

get_variantsin utils::activity_projection

Get all process variants, sorted by frequency (descending)

get_variants_of_object_typein bindings::slim_ocel_bindings

Get all activity-trace variants for objects of the given object type, with their occurrence counts

get_variants_of_object_typein object_centric::variants

Get all activity-trace variants for objects of the given object type, with their occurrence counts

index_link_ocelin process_mining::bindings

Convert an [`OCEL`] to an [`IndexLinkedOCEL`]

locel_add_e2oin bindings::slim_ocel_bindings

Add an E2O (event-to-object) relationship with the given qualifier.

locel_add_eventin bindings::slim_ocel_bindings

Add an event and return its [`EventIndex`].

locel_add_event_typein bindings::slim_ocel_bindings

Add an event type with the given ordered attribute declarations.

locel_add_o2oin bindings::slim_ocel_bindings

Add a directed O2O (object-to-object) relationship from `from_obj` to `to_obj` with the given qualifier.

locel_add_objectin bindings::slim_ocel_bindings

Add an object and return its [`ObjectIndex`].

locel_add_object_typein bindings::slim_ocel_bindings

Add an object type with the given ordered attribute declarations.

locel_construct_ocelin bindings::slim_ocel_bindings

Reconstruct a full [`OCEL`] from a [`SlimLinkedOCEL`]. Can be expensive for large logs.

locel_conversion_ratein bindings::slim_ocel_bindings

Conversion rate from `source_type` to `target_type` via O2O, restricted to targets touched by `activity`.

locel_conversion_ratein object_centric::oc_statistics

Conversion rate from `source_type` to `target_type` via O2O, restricted to targets touched by `activity`.

locel_delete_e2oin bindings::slim_ocel_bindings

Remove all E2O relationships between the given event and object (across every qualifier).

locel_delete_o2oin bindings::slim_ocel_bindings

Remove all O2O relationships from `from_obj` to `to_obj` (across every qualifier).

locel_event_object_type_countsin bindings::slim_ocel_bindings

Count E2O relationships per `(event_type, object_type)` pair.

locel_event_object_type_countsin object_centric::oc_statistics

Count E2O relationships per `(event_type, object_type)` pair.

locel_get_e2oin bindings::slim_ocel_bindings

Get the E2O relationships of an event as `(qualifier, object_index)` pairs.

locel_get_e2o_revin bindings::slim_ocel_bindings

Get the reverse E2O relationships of an object (events relating to it) as `(qualifier, event_index)` pairs.

locel_get_ev_attr_valin bindings::slim_ocel_bindings

Get the value of an event attribute by name. `None` if the attribute does not exist.

locel_get_ev_by_idin bindings::slim_ocel_bindings

Look up an event by its ID string. `None` if not found.

locel_get_ev_idin bindings::slim_ocel_bindings

Get the ID string of an event. Panics if the index is out of bounds.

locel_get_ev_timein bindings::slim_ocel_bindings

Get the timestamp of an event. Panics if the index is out of bounds.

locel_get_ev_typein bindings::slim_ocel_bindings

Get the event type specification (name + attributes), or `None` if unknown.

locel_get_ev_type_ofin bindings::slim_ocel_bindings

Get the event type (activity) of an event. Panics if the index is out of bounds.

locel_get_ev_typesin bindings::slim_ocel_bindings

Get all declared event type names, in declaration order.

locel_get_evs_of_typein bindings::slim_ocel_bindings

Get all event indices of the given event type. Empty if unknown.

locel_get_full_evin bindings::slim_ocel_bindings

Get the full [`OCELEvent`] (resolved type name, named attributes, string object IDs).

locel_get_full_obin bindings::slim_ocel_bindings

Get the full [`OCELObject`] (resolved type name, named time-indexed attributes, string object IDs).

locel_get_o2oin bindings::slim_ocel_bindings

Get the outgoing O2O relationships of an object as `(qualifier, object_index)` pairs.

locel_get_o2o_revin bindings::slim_ocel_bindings

Get the reverse O2O relationships of an object (objects with an O2O to it) as `(qualifier, object_index)` pairs.

locel_get_ob_attr_valsin bindings::slim_ocel_bindings

Get the time-indexed history of an object attribute by name as `(timestamp, value)` pairs. Empty if absent.

locel_get_ob_by_idin bindings::slim_ocel_bindings

Look up an object by its ID string. `None` if not found.

locel_get_ob_idin bindings::slim_ocel_bindings

Get the ID string of an object. Panics if the index is out of bounds.

locel_get_ob_typein bindings::slim_ocel_bindings

Get the object type specification (name + attributes), or `None` if unknown.

locel_get_ob_type_ofin bindings::slim_ocel_bindings

Get the object type of an object. Panics if the index is out of bounds.

locel_get_ob_typesin bindings::slim_ocel_bindings

Get all declared object type names, in declaration order.

locel_get_obs_of_typein bindings::slim_ocel_bindings

Get all object indices of the given object type. Empty if unknown.

locel_newin bindings::slim_ocel_bindings

Create a new empty [`SlimLinkedOCEL`].

locel_oc_perf_sojourn_per_eventin bindings::slim_ocel_bindings

Per-event sojourn time.

locel_oc_perf_sojourn_per_eventin object_centric::oc_performance

Per-event sojourn time.

locel_oc_perf_sync_per_eventin bindings::slim_ocel_bindings

Per-event synchronization time and the delaying object.

locel_oc_perf_sync_per_eventin object_centric::oc_performance

Per-event synchronization time and the delaying object.

log_to_activity_projectionin utils::activity_projection

Convert an [`EventLog`] into an [`EventLogActivityProjection`]

num_eventsin process_mining::bindings

Get the number of events in an [`OCEL`]

num_objectsin process_mining::bindings

Get the number of objects in an [`OCEL`]

oc_declare_conformancein object_centric::oc_declare

Returns the confidence conformance of an OC-DECLARE arc on the given OCEL

ocel_type_statsin process_mining::bindings

Compute statistics on object/event types in the OCEL

path_schema_connectionsin bindings::path_schema_bindings

Find the concrete instance connections of a single (resolved) schema, with metrics and

path_schema_discoverin bindings::path_schema_bindings

Discover path schemas between the query types and score each by support / coverage /

path_schema_enumeratein bindings::path_schema_bindings

Enumerate type-level path schemas between two types (or from one type), without any

path_schema_type_graphin bindings::path_schema_bindings

Build the OCEL type graph (typed nodes with entity counts, plus relationship edges).

project_oc_arcsin object_centric::oc_declare

Project OC-DECLARE arcs onto a subset of activities, preserving constraints

read_consolidated_ocel_from_duckdbin schema::reader

Read an [`OCEL`] from a `DuckDB` database file in the consolidated schema, i.e. one written by

read_consolidated_slim_ocel_from_duckdbin schema::reader

Read a [`SlimLinkedOCEL`] from a `DuckDB` database file in the consolidated schema, i.e. one

reduce_oc_arcsin object_centric::oc_declare

Reduce OC-DECLARE arcs based on lossless/lossy transitive reduction

slim_link_ocelin process_mining::bindings

Convert an [`OCEL`] to an [`SlimLinkedOCEL`]

stream_ocel_to_duckdbin schema::stream

Like [`stream_ocel_file_to_duckdb`] with explicit [`DuckDbImportOptions`].

test_some_inputsin process_mining::bindings

This is a test function.

write_ocel_to_consolidated_duckdbin schema::stream

Write an in-memory OCEL into a fresh `DuckDB` database in the consolidated schema.

write_slim_ocel_to_consolidated_duckdbin schema::stream

Write an in-memory Slim OCEL into a fresh `DuckDB` database in the consolidated schema.