[#CompareChunks]
= CompareChunks
:mrdocs:

Compare the feerate diagrams implied by the provided sorted chunks data.

== Synopsis

Declared in `<util/feefrac.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::partial_ordering
CompareChunks(
    std::span<FeeFrac const> chunks0,
    std::span<FeeFrac const> chunks1);
----

== Description

The implied diagram for each starts at (0, 0), then contains for each chunk the cumulative fee and size up to that chunk, and then extends infinitely to the right with a horizontal line.

The caller must guarantee that the sum of the FeeFracs in either of the chunks' data set do not overflow (so sum fees < 2ˆ63, and sum sizes < 2ˆ31).

== Return Value

The ordering of the first diagram relative to the second, or std::partial_ordering::unordered if the diagrams cross.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *chunks0*
| The first sorted chunks data set.
| *chunks1*
| The second sorted chunks data set.
|===


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