Module mz_compute_client::plan::top_k

TopK planning logic.

We provide a plan (TopKPlan) encoding variants of the TopK operator, and provide implementations specific to plan variants.

The TopK variants can be distinguished as follows:

• A MonotonicTop1Plan maintains a single row per key and is suitable for monotonic inputs.
• A MonotonicTopKPlan maintains up to K rows per key and is suitable for monotonic inputs.
• A BasicTopKPlan maintains up to K rows per key and can handle retractions.

Modules

• proto_top_k_plan
  Nested message and enum types in ProtoTopKPlan.

Structs

• BasicTopKPlan
  A plan for generic TopKs that don’t fit any more specific category.
• MonotonicTop1Plan
  A plan for monotonic TopKs with an offset of 0 and a limit of 1.
• MonotonicTopKPlan
  A plan for monotonic TopKs with an offset of 0 and an arbitrary limit.
• ProtoBasicTopKPlan
• ProtoMonotonicTop1Plan
• ProtoMonotonicTopKPlan
• ProtoTopKPlan

Enums

• TopKPlan
  A plan encapsulating different variants to compute a TopK operation.

Constants

• _IMPL_ARBITRARY_FOR_BasicTopKPlan 🔒
• _IMPL_ARBITRARY_FOR_MonotonicTop1Plan 🔒
• _IMPL_ARBITRARY_FOR_MonotonicTopKPlan 🔒
• _IMPL_ARBITRARY_FOR_TopKPlan 🔒