tlx
format_si_units.hpp
Go to the documentation of this file.
1/*******************************************************************************
2 * tlx/string/format_si_units.hpp
3 *
4 * Part of tlx - http://panthema.net/tlx
5 *
6 * Copyright (C) 2016-2017 Timo Bingmann <tb@panthema.net>
7 *
8 * All rights reserved. Published under the Boost Software License, Version 1.0
9 ******************************************************************************/
10
11#ifndef TLX_STRING_FORMAT_SI_UNITS_HEADER
12#define TLX_STRING_FORMAT_SI_UNITS_HEADER
13
14#include <string>
15
16namespace tlx {
17
18//! \addtogroup tlx_string
19//! \{
20
21//! Format a byte size using SI (K, M, G, T) suffixes (powers of ten). Returns
22//! "123 M" or similar.
23std::string format_si_units(uint64_t number, int precision = 3);
24
25//! \}
26
27} // namespace tlx
28
29#endif // !TLX_STRING_FORMAT_SI_UNITS_HEADER
30
31/******************************************************************************/
std::string format_si_units(uint64_t number, int precision)
Format number as something like 1 TB.