[#ByRatio]
= ByRatio
:mrdocs:

Wrapper around FeeFrac & derived types, which adds a feerate‐based ordering which treats equal‐feerate but distinct‐size FeeFracs as equals.

== Synopsis

Declared in `<util/feefrac.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<std::derived_from<FeeFrac> T>
class ByRatio;
----

== Description

This is not included inside FeeFrac itself, because it is not a total ordering (as would be expected for built‐in comparison operators).

== Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:ByRatio/2constructor.adoc[`ByRatio`]         [.small]#[constructor]#
| Wrap a FeeFrac (or derived type) for feerate‐based comparison.
|===


== Friends

[cols="1,4"]
|===
| Name| Description
| `xref:operator_ge.adoc[operator>=]`
| Check whether the first feerate is higher than or equal to the second.
| `xref:operator_le.adoc[operator<=]`
| Check whether the first feerate is lower than or equal to the second.
| `xref:operator_gt-0c.adoc[operator>]`
| Check whether the first feerate is strictly higher than the second.
| `xref:operator_lt-068.adoc[operator<]`
| Check whether the first feerate is strictly lower than the second.
| `xref:operator_3way-00a.adoc[operator<=>]`
| Order two wrapped FeeFracs by feerate.
| `xref:operator_eq-0cc.adoc[operator==]`
| Compare two wrapped FeeFracs for equal feerate.
|===


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