Represents the logical ratio of output currency to input currency. More...

#include <Quality.h>

Collaboration diagram for xrpl::Quality:

Public Types
using	value_type = std::uint64_t

Public Member Functions
	Quality ()=default
	Quality (std::uint64_t value)
	Create a quality from the integer encoding of an STAmount.
	Quality (Amounts const &amount)
	Create a quality from the ratio of two amounts.
template<class In, class Out>
	Quality (TAmounts< In, Out > const &amount)
	Create a quality from the ratio of two amounts.
template<class In, class Out>
	Quality (Out const &out, In const &in)
	Create a quality from the ratio of two amounts.
STAmount	rate () const
	Returns the quality as STAmount.
Quality	round (int tickSize) const
	Returns the quality rounded up to the specified number of decimal digits.
Amounts	ceilIn (Amounts const &amount, STAmount const &limit) const
	Returns the scaled amount with in capped.
template<class In, class Out>
TAmounts< In, Out >	ceilIn (TAmounts< In, Out > const &amount, In const &limit) const
Amounts	ceilInStrict (Amounts const &amount, STAmount const &limit, bool roundUp) const
template<class In, class Out>
TAmounts< In, Out >	ceilInStrict (TAmounts< In, Out > const &amount, In const &limit, bool roundUp) const
Amounts	ceilOut (Amounts const &amount, STAmount const &limit) const
	Returns the scaled amount with out capped.
template<class In, class Out>
TAmounts< In, Out >	ceilOut (TAmounts< In, Out > const &amount, Out const &limit) const
Amounts	ceilOutStrict (Amounts const &amount, STAmount const &limit, bool roundUp) const
template<class In, class Out>
TAmounts< In, Out >	ceilOutStrict (TAmounts< In, Out > const &amount, Out const &limit, bool roundUp) const

Quality &	operator++ ()
	Advances to the next higher quality level.
Quality	operator++ (int)

Quality &	operator-- ()
	Advances to the next lower quality level.
Quality	operator-- (int)

Static Public Attributes
static int const	kMinTickSize = 3
static int const	kMaxTickSize = 16

Private Member Functions
template<class In, class Out, class Lim, typename FnPtr, std::same_as< bool >... Round>
TAmounts< In, Out >	ceilTAmountsHelper (TAmounts< In, Out > const &amount, Lim const &limit, Lim const &limitCmp, FnPtr ceilFunction, Round... round) const

Private Attributes
value_type	value_

Friends
bool	operator< (Quality const &lhs, Quality const &rhs) noexcept
	Returns true if lhs is lower quality than rhs.
bool	operator> (Quality const &lhs, Quality const &rhs) noexcept
bool	operator<= (Quality const &lhs, Quality const &rhs) noexcept
bool	operator>= (Quality const &lhs, Quality const &rhs) noexcept
bool	operator== (Quality const &lhs, Quality const &rhs) noexcept
bool	operator!= (Quality const &lhs, Quality const &rhs) noexcept
std::ostream &	operator<< (std::ostream &os, Quality const &quality)
double	relativeDistance (Quality const &q1, Quality const &q2)

Detailed Description

Represents the logical ratio of output currency to input currency.

Internally this is stored using a custom floating point representation, as the inverse of the ratio, so that quality will be descending in a sequence of actual values that represent qualities.

Definition at line 90 of file Quality.h.

Member Typedef Documentation

◆ value_type

using xrpl::Quality::value_type = std::uint64_t

Definition at line 95 of file Quality.h.

Constructor & Destructor Documentation

◆ Quality() [1/5]

xrpl::Quality::Quality ( )

default

◆ Quality() [2/5]

xrpl::Quality::Quality ( std::uint64_t value )

explicit

Create a quality from the integer encoding of an STAmount.

Definition at line 13 of file Quality.cpp.

◆ Quality() [3/5]

xrpl::Quality::Quality ( Amounts const & amount )

explicit

Create a quality from the ratio of two amounts.

Definition at line 17 of file Quality.cpp.

◆ Quality() [4/5]

template<class In, class Out>

xrpl::Quality::Quality ( TAmounts< In, Out > const & amount )

explicit

Create a quality from the ratio of two amounts.

Definition at line 118 of file Quality.h.

◆ Quality() [5/5]

template<class In, class Out>

xrpl::Quality::Quality	(	Out const &	out,
		In const &	in )

Create a quality from the ratio of two amounts.

Definition at line 125 of file Quality.h.

Member Function Documentation

◆ operator++() [1/2]

Quality & xrpl::Quality::operator++ ( )

Advances to the next higher quality level.

Definition at line 22 of file Quality.cpp.

◆ operator++() [2/2]

Quality xrpl::Quality::operator++ ( int )

Definition at line 30 of file Quality.cpp.

◆ operator--() [1/2]

Quality & xrpl::Quality::operator-- ( )

Advances to the next lower quality level.

Definition at line 38 of file Quality.cpp.

◆ operator--() [2/2]

Quality xrpl::Quality::operator-- ( int )

Definition at line 48 of file Quality.cpp.

◆ rate()

STAmount xrpl::Quality::rate ( ) const

nodiscard

Returns the quality as STAmount.

Definition at line 149 of file Quality.h.

◆ round()

Quality xrpl::Quality::round ( int tickSize ) const

nodiscard

Returns the quality rounded up to the specified number of decimal digits.

Definition at line 134 of file Quality.cpp.

◆ ceilIn() [1/2]

Amounts xrpl::Quality::ceilIn	(	Amounts const &	amount,
		STAmount const &	limit ) const

nodiscard

Returns the scaled amount with in capped.

Math is avoided if the result is exact. The output is clamped to prevent money creation.

Definition at line 73 of file Quality.cpp.

◆ ceilIn() [2/2]

template<class In, class Out>

TAmounts< In, Out > xrpl::Quality::ceilIn	(	TAmounts< In, Out > const &	amount,
		In const &	limit ) const

nodiscard

Definition at line 316 of file Quality.h.

◆ ceilInStrict() [1/2]

Amounts xrpl::Quality::ceilInStrict	(	Amounts const &	amount,
		STAmount const &	limit,
		bool	roundUp ) const

nodiscard

Definition at line 79 of file Quality.cpp.

◆ ceilInStrict() [2/2]

template<class In, class Out>

TAmounts< In, Out > xrpl::Quality::ceilInStrict	(	TAmounts< In, Out > const &	amount,
		In const &	limit,
		bool	roundUp ) const

nodiscard

Definition at line 327 of file Quality.h.

◆ ceilOut() [1/2]

Amounts xrpl::Quality::ceilOut	(	Amounts const &	amount,
		STAmount const &	limit ) const

nodiscard

Returns the scaled amount with out capped.

Math is avoided if the result is exact. The input is clamped to prevent money creation.

Definition at line 102 of file Quality.cpp.

◆ ceilOut() [2/2]

template<class In, class Out>

TAmounts< In, Out > xrpl::Quality::ceilOut	(	TAmounts< In, Out > const &	amount,
		Out const &	limit ) const

nodiscard

Definition at line 338 of file Quality.h.

◆ ceilOutStrict() [1/2]

Amounts xrpl::Quality::ceilOutStrict	(	Amounts const &	amount,
		STAmount const &	limit,
		bool	roundUp ) const

nodiscard

Definition at line 108 of file Quality.cpp.

◆ ceilOutStrict() [2/2]

template<class In, class Out>

TAmounts< In, Out > xrpl::Quality::ceilOutStrict	(	TAmounts< In, Out > const &	amount,
		Out const &	limit,
		bool	roundUp ) const

nodiscard

Definition at line 349 of file Quality.h.

◆ ceilTAmountsHelper()

template<class In, class Out, class Lim, typename FnPtr, std::same_as< bool >... Round>

TAmounts< In, Out > xrpl::Quality::ceilTAmountsHelper	(	TAmounts< In, Out > const &	amount,
		Lim const &	limit,
		Lim const &	limitCmp,
		FnPtr	ceilFunction,
		Round...	round ) const

nodiscardprivate

Definition at line 296 of file Quality.h.

◆ operator<

bool operator<	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Returns true if lhs is lower quality than rhs.

Lower quality means the taker receives a worse deal. Higher quality is better for the taker.

Definition at line 220 of file Quality.h.

◆ operator>

bool operator>	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Definition at line 227 of file Quality.h.

◆ operator<=

bool operator<=	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Definition at line 232 of file Quality.h.

◆ operator>=

bool operator>=	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Definition at line 239 of file Quality.h.

◆ operator==

bool operator==	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Definition at line 245 of file Quality.h.

◆ operator!=

bool operator!=	(	Quality const &	lhs,
		Quality const &	rhs )

friend

Definition at line 251 of file Quality.h.

◆ operator<<

std::ostream & operator<<	(	std::ostream &	os,
		Quality const &	quality )

friend

Definition at line 256 of file Quality.h.

◆ relativeDistance

double relativeDistance	(	Quality const &	q1,
		Quality const &	q2 )

friend

Definition at line 266 of file Quality.h.

Member Data Documentation

◆ kMinTickSize

int const xrpl::Quality::kMinTickSize = 3

static

Definition at line 97 of file Quality.h.

◆ kMaxTickSize

int const xrpl::Quality::kMaxTickSize = 16

static

Definition at line 98 of file Quality.h.

◆ value_

value_type xrpl::Quality::value_

private

Definition at line 105 of file Quality.h.

Public Types

Public Member Functions

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ value_type

Constructor & Destructor Documentation

◆ Quality() [1/5]

◆ Quality() [2/5]

◆ Quality() [3/5]

◆ Quality() [4/5]

◆ Quality() [5/5]

Member Function Documentation

◆ operator++() [1/2]

◆ operator++() [2/2]

◆ operator--() [1/2]

◆ operator--() [2/2]

◆ rate()

◆ round()

◆ ceilIn() [1/2]

◆ ceilIn() [2/2]

◆ ceilInStrict() [1/2]

◆ ceilInStrict() [2/2]

◆ ceilOut() [1/2]

◆ ceilOut() [2/2]

◆ ceilOutStrict() [1/2]

◆ ceilOutStrict() [2/2]

◆ ceilTAmountsHelper()

Friends And Related Symbol Documentation

◆ operator<

◆ operator>

◆ operator<=

◆ operator>=

◆ operator==

◆ operator!=

◆ operator<<

◆ relativeDistance

Member Data Documentation

◆ kMinTickSize

◆ kMaxTickSize

◆ value_