Files
rippled/include/xrpl/protocol/Book.h
Bart 2406b28e64 refactor: Remove unused and add missing includes (#5293)
The codebase is filled with includes that are unused, and which thus can be removed. At the same time, the files often do not include all headers that contain the definitions used in those files. This change uses clang-format and clang-tidy to clean up the includes, with minor manual intervention to ensure the code compiles on all platforms.
2025-03-11 14:16:45 -04:00

177 lines
4.3 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2012, 2013 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#ifndef RIPPLE_PROTOCOL_BOOK_H_INCLUDED
#define RIPPLE_PROTOCOL_BOOK_H_INCLUDED
#include <xrpl/basics/CountedObject.h>
#include <xrpl/protocol/Issue.h>
#include <boost/utility/base_from_member.hpp>
namespace ripple {
/** Specifies an order book.
The order book is a pair of Issues called in and out.
@see Issue.
*/
class Book final : public CountedObject<Book>
{
public:
Issue in;
Issue out;
Book()
{
}
Book(Issue const& in_, Issue const& out_) : in(in_), out(out_)
{
}
};
bool
isConsistent(Book const& book);
std::string
to_string(Book const& book);
std::ostream&
operator<<(std::ostream& os, Book const& x);
template <class Hasher>
void
hash_append(Hasher& h, Book const& b)
{
using beast::hash_append;
hash_append(h, b.in, b.out);
}
Book
reversed(Book const& book);
/** Equality comparison. */
/** @{ */
[[nodiscard]] inline constexpr bool
operator==(Book const& lhs, Book const& rhs)
{
return (lhs.in == rhs.in) && (lhs.out == rhs.out);
}
/** @} */
/** Strict weak ordering. */
/** @{ */
[[nodiscard]] inline constexpr std::weak_ordering
operator<=>(Book const& lhs, Book const& rhs)
{
if (auto const c{lhs.in <=> rhs.in}; c != 0)
return c;
return lhs.out <=> rhs.out;
}
/** @} */
} // namespace ripple
//------------------------------------------------------------------------------
namespace std {
template <>
struct hash<ripple::Issue>
: private boost::base_from_member<std::hash<ripple::Currency>, 0>,
private boost::base_from_member<std::hash<ripple::AccountID>, 1>
{
private:
using currency_hash_type =
boost::base_from_member<std::hash<ripple::Currency>, 0>;
using issuer_hash_type =
boost::base_from_member<std::hash<ripple::AccountID>, 1>;
public:
explicit hash() = default;
using value_type = std::size_t;
using argument_type = ripple::Issue;
value_type
operator()(argument_type const& value) const
{
value_type result(currency_hash_type::member(value.currency));
if (!isXRP(value.currency))
boost::hash_combine(
result, issuer_hash_type::member(value.account));
return result;
}
};
//------------------------------------------------------------------------------
template <>
struct hash<ripple::Book>
{
private:
using hasher = std::hash<ripple::Issue>;
hasher m_hasher;
public:
explicit hash() = default;
using value_type = std::size_t;
using argument_type = ripple::Book;
value_type
operator()(argument_type const& value) const
{
value_type result(m_hasher(value.in));
boost::hash_combine(result, m_hasher(value.out));
return result;
}
};
} // namespace std
//------------------------------------------------------------------------------
namespace boost {
template <>
struct hash<ripple::Issue> : std::hash<ripple::Issue>
{
explicit hash() = default;
using Base = std::hash<ripple::Issue>;
// VFALCO NOTE broken in vs2012
// using Base::Base; // inherit ctors
};
template <>
struct hash<ripple::Book> : std::hash<ripple::Book>
{
explicit hash() = default;
using Base = std::hash<ripple::Book>;
// VFALCO NOTE broken in vs2012
// using Base::Base; // inherit ctors
};
} // namespace boost
#endif