[#cluster_linearize]
= cluster_linearize
:mrdocs:

Algorithms and data structures for ordering (linearizing) clusters of dependent transactions.

== Types

[cols="1,4"]
|===
| Name| Description
| xref:cluster_linearize/DepGraph.adoc[`DepGraph`] 
| Data structure that holds a transaction graph's preprocessed data (fee, size, ancestors, descendants).
| xref:cluster_linearize/SFLDefaultCostModel.adoc[`SFLDefaultCostModel`] 
| A default cost model for SFL for SetType=BitSet<64>, based on benchmarks.
| xref:cluster_linearize/SetInfo.adoc[`SetInfo`] 
| A set of transactions together with their aggregate feerate.
| xref:cluster_linearize/SpanningForestState.adoc[`SpanningForestState`] 
| Class to represent the internal state of the spanning‐forest linearization (SFL) algorithm.
|===


== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:cluster_linearize/DepGraphIndex.adoc[`DepGraphIndex`] 
| Data type to represent transaction indices in DepGraphs and the clusters they represent.
| xref:cluster_linearize/IndexTxOrder.adoc[`IndexTxOrder`] 
| Simple default transaction ordering function for SpanningForestState::GetLinearization() and Linearize(), which just sorts by DepGraphIndex.
|===


== Functions

[cols="1,4"]
|===
| Name| Description
| xref:cluster_linearize/ChunkLinearization.adoc[`ChunkLinearization`] 
| Compute the feerates of the chunks of linearization. Identical to ChunkLinearizationInfo, but only returns the chunk feerates, not the corresponding transaction sets.
| xref:cluster_linearize/ChunkLinearizationInfo.adoc[`ChunkLinearizationInfo`] 
| Compute the chunks of linearization as SetInfos.
| xref:cluster_linearize/Linearize.adoc[`Linearize`] 
| Find or improve a linearization for a cluster.
| xref:cluster_linearize/PostLinearize.adoc[`PostLinearize`] 
| Improve a given linearization.
| xref:cluster_linearize/swap.adoc[`swap`] 
| Swap two SetInfo objects.
| xref:cluster_linearize/operator_eq-01.adoc[`operator==`] 
| Equality operators
|===


== Concepts

[cols="1,4"]
|===
| Name| Description
| xref:cluster_linearize/StrongComparator.adoc[`StrongComparator`] 
| Concept for function objects that return std::strong_ordering when invoked with two Args.
|===



[.small]#Created with https://www.mrdocs.com[MrDocs]#