Skip to main content
Rust4PM
Back to Docs

All Functions

Browse all 149 available functions in the library.

Showing 149 of 149 functions
add_init_exit_events_to_ocelin utils::init_exit_events

Add artificial init/exit events to an OCEL

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.

apply_token_based_replayin case_centric::token_based_replay

Computes token-based replay for a Petri net that has unique labels and no silent transitions

compute_fitnessin case_centric::alignments

Compute fitness stats from alignment results

conversion_ratein object_centric::oc_statistics

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

dfg_layoutin visualization::bindings

Lay the model out, returning the positions only.

dfg_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

dfg_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

dfg_svgin visualization::bindings

Draw the model as a standalone SVG document.

dfg_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

discover_alphappp_netin alphappp::full

Discovers an [`AcceptingPetriNet`] with the Alpha+++ process discovery algorithm.

discover_dfgin case_centric::dfg

Discover [`DirectlyFollowsGraph`] with default classifier

discover_inductive_netin case_centric::inductive_miner

Discovers an [`AcceptingPetriNet`] with the Inductive Miner, by converting the

discover_inductive_treein case_centric::inductive_miner

Discovers a [`ProcessTree`] with the Inductive Miner.

discover_oc_declarein object_centric::oc_declare

Discover behavioral OC-DECLARE constraints from the given OCEL

discover_ocdfgin ocdfg::object_centric_dfg_struct

[`discover_ocdfg_from`] on a [`SlimLinkedOCEL`], which is what the binding takes.

discover_ocpnin object_centric::ocpn

[`discover_ocpn_from`] on a [`SlimLinkedOCEL`], returning the flat JSON form.

discover_path_schemasin object_centric::path_schemas

Discover path schemas between the query types: enumerate schemas, summarize each schema's

escaping_edges_optionsin case_centric::precision

The [`EscapingEdgesOptions`] of a preset, e.g., for a host to adjust before calling

escaping_edges_precisionin case_centric::precision

Escaping-edges precision of `net` with respect to `log`

escaping_edges_precision_from_alignmentsin case_centric::precision

Escaping-edges precision of `net` with respect to the log behind `alignments`

event_object_type_countsin object_centric::oc_statistics

Count related `(event, object)` pairs per `(event_type, object_type)` pair.

event_timestamp_histogramin case_centric::event_timestamp_histogram

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

extraction_column_domainin bindings::extraction_dbcon_bindings

The distinct values `table.column` holds in the source named `source_id`, for compiling a

extraction_column_domain_itemsin bindings::extraction_bindings

Every distinct value of `table.column` in a source held in the registry.

extraction_compilein bindings::extraction_bindings

Compile `blueprint` into SQL views presenting the OCEL 2.0 surface over `catalog`'s tables,

extraction_connection_kindsin bindings::extraction_dbcon_bindings

The source kinds *this build's* connector can open, as `dbcon` backend ids (`"csv"`,

extraction_discover_catalogin bindings::extraction_dbcon_bindings

Connect to every source in `connections` and discover its schema, returning one merged

extraction_discover_catalog_itemsin bindings::extraction_bindings

Discover the schema of every source in `sources`, merged into one [`ExtractionCatalog`].

extraction_runin bindings::extraction_dbcon_bindings

Run `blueprint` against `connections`, storing the extracted log under `output_id` and

extraction_run_itemsin bindings::extraction_bindings

Run `blueprint` against sources held in the registry, returning the resulting log.

extraction_run_to_duckdbin bindings::extraction_dbcon_bindings

Run `blueprint` against `connections`, streaming straight to a new `DuckDB` file at

extraction_table_previewin bindings::extraction_dbcon_bindings

The first `limit` rows of `table` in the source named `source_id`, for showing a person what

extraction_table_preview_itemsin bindings::extraction_bindings

The first `limit` rows of `table` in a source held in the registry.

extraction_validatein bindings::extraction_bindings

Check `blueprint` against `catalog` for problems decidable from the schema alone, such as an

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 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_object_attribute_changesin object_centric::object_attribute_changes

Extract the attribute change history for a specific object.

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 object_centric::variants

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

inductive_miner_optionsin case_centric::inductive_miner

The settings of an Inductive Miner variant under a preset, with a noise threshold of `0.2`

layout_graphin visualization::engine

Lay the graph of `request` out with the layered engine, e.g., the `request` of a

layout_treein visualization::engine

Lay the rooted tree or forest of `request` out with the tidy-tree engine, e.g., the `request`

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_attribute_valuein bindings::slim_ocel_bindings

Add a value to the history of an object attribute.

locel_add_object_typein bindings::slim_ocel_bindings

Add an object type with the given ordered attribute declarations.

locel_append_batchin bindings::slim_ocel_bindings

Add many events and objects, referring to objects by id.

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_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

locel_get_e2o_rev_idsin bindings::slim_ocel_bindings

Get the ids of the events related to an object, or `None` for an unknown object id.

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.

locel_get_ev_ids_of_typein bindings::slim_ocel_bindings

Get the ids of all events of a type.

locel_get_ev_timein bindings::slim_ocel_bindings

Get the timestamp of an event.

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.

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_activity_tracein bindings::slim_ocel_bindings

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

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.

locel_get_ob_ids_of_typein bindings::slim_ocel_bindings

Get the ids of all objects of a type.

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.

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`].

num_casesin utils::activity_projection

Get the total number of cases in the projection

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`]

num_variantsin utils::activity_projection

Get the number of distinct trace variants in the projection

oc_declare_conformancein object_centric::oc_declare

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

oc_declare_involvementsin visualization::oc_declare

Per activity of `ocel`, how many objects of each type one of its events involves, as

oc_declare_layoutin visualization::bindings

Lay the model out, returning the positions only.

oc_declare_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

oc_declare_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

oc_declare_svgin visualization::bindings

Draw the model as a standalone SVG document.

oc_declare_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

oc_perf_sojourn_per_eventin object_centric::oc_performance

Per-event sojourn time.

oc_perf_sync_per_eventin object_centric::oc_performance

Per-event synchronization time and the delaying object.

oc_type_graph_from_ocelin visualization::bindings

The type graph of an OCEL: its event and object types with their counts, and their qualified

oc_type_graph_layoutin visualization::bindings

Lay the model out, returning the positions only.

oc_type_graph_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

oc_type_graph_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

oc_type_graph_svgin visualization::bindings

Draw the model as a standalone SVG document.

oc_type_graph_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

ocdfg_layoutin visualization::bindings

Lay the model out, returning the positions only.

ocdfg_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

ocdfg_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

ocdfg_svgin visualization::bindings

Draw the model as a standalone SVG document.

ocdfg_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

ocel_type_statsin process_mining::bindings

Compute statistics on object/event types in the OCEL

ocpn_layoutin visualization::bindings

Lay the model out, returning the positions only.

ocpn_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

ocpn_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

ocpn_svgin visualization::bindings

Draw the model as a standalone SVG document.

ocpn_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

partial_order_layoutin visualization::bindings

Lay the model out, returning the positions only.

partial_order_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

partial_order_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

partial_order_svgin visualization::bindings

Draw the model as a standalone SVG document.

partial_order_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

path_schema_connectionsin bindings::path_schema_bindings

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

path_schema_enumeratein bindings::path_schema_bindings

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

petri_net_layoutin visualization::bindings

Lay the model out, returning the positions only.

petri_net_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

petri_net_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

petri_net_svgin visualization::bindings

Draw the model as a standalone SVG document.

petri_net_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

process_tree_layoutin visualization::bindings

Lay the model out, returning the positions only.

process_tree_layout_requestin visualization::bindings

The layout request of the model, with the model element behind each node and edge.

process_tree_scene_from_layoutin visualization::bindings

Draw the model over a layout of its graph, with per-node and per-edge style overrides.

process_tree_svgin visualization::bindings

Draw the model as a standalone SVG document.

process_tree_svg_from_layoutin visualization::bindings

Draw the model over a layout of its graph as a standalone SVG document, so no [`Scene`]

project_oc_arcsin object_centric::oc_declare

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

reduce_oc_arcsin object_centric::oc_declare

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

reflowin object_centric::reflow

Reflow under the abstraction [`ReflowOptions::abstraction`] names.

reflow_annotated_ocpnin bindings::reflow_bindings

Discover an object-centric Petri net from the flow projection of a log under a result, with

reflow_annotated_ocpn_drawingin reflow_bindings::drawing

The flat net, build options with a badge per non-flow cell, and the style of the added

reflow_annotated_ocpn_netin bindings::reflow_bindings

The object-centric Petri net of an annotated net, as a handle for other bindings.

reflow_annotated_ocpn_svgin reflow_bindings::drawing

Draw an annotated net as a standalone SVG document.

reflow_cellsin bindings::reflow_bindings

The cells of a result with their states, and its counts.

reflow_flow_login bindings::reflow_bindings

The flow projection of a log under a result, which is what discovery reads: the same as

reflow_flow_projectionin bindings::reflow_bindings

The flowing participations of a tagged log, which is what discovery reads.

reflow_from_taggedin object_centric::reflow

Read the flow layer off a tagged log and annotate it.

reflow_full_projectionin bindings::reflow_bindings

Every participation of a tagged log, with the `!` prefix dropped.

reflow_tagin bindings::reflow_bindings

Tag a log with a result's flow layer: non-flow participations get the `!` qualifier prefix,

reflow_untagin bindings::reflow_bindings

The log a tagged log tags: added participations removed and the `!` prefix dropped.

reflow_with_flow_layerin bindings::reflow_bindings

A result for another flow layer of the same log, e.g., an edited one, repaired so that every

render_scene_svgin visualization::bindings

Draw a scene, e.g., from a `<model>_scene_from_layout`, as a standalone SVG document. Elements

reroute_graphin visualization::engine

Keep every node where it is and route the edges again, e.g., after the user dragged a node.

stream_ocel_file_to_duckdbin schema::stream

Stream an OCEL file into a new `DuckDB` database in the consolidated schema.

write_ocel_to_duckdbin schema::stream

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