smash::ToASCII Struct Reference

#include <outputformatter.h>

Structure to convert a given value into ASCII format, such that all methods return a std::string.

Definition at line 27 of file outputformatter.h.

Public Types
using	type = std::string
	Return type of this converter. More...

Public Member Functions
type	as_integer (int value) const
	Converts an integer. More...
type	as_double (double value)
	Converts a double with 6 digits of precision. More...
type	as_precise_double (double value)
	Converts a double with 9 digits of precision. More...
type	as_string (const std::string &str) const
	Because ToASCII converts into strings, this simply returns the string itself. More...

Member Typedef Documentation

type

using smash::ToASCII::type = std::string

Return type of this converter.

Definition at line 29 of file outputformatter.h.

Member Function Documentation

as_integer()

type smash::ToASCII::as_integer ( int  value ) const

inline

Converts an integer.

Parameters

[in]

value

number to convert

Definition at line 36 of file outputformatter.h.

{ return std::to_string(value); }

as_double()

type smash::ToASCII::as_double ( double  value )

inline

Converts a double with 6 digits of precision.

Note

The usage of std::snprintf over std::ostringstream is because of performance reasons (in C++20 this will be replaced with std::format which is even better). The returned string is constructed from the buffer in a way to exclude the terminating null character from the buffer. The hard-coded buffer size should fit any number, but a couple of assert are used to possibly investigate unexpected behaviour.

Warning

Since the buffer size is needed twice, it makes sense to store it in a variable. However, cpplint complains if the variable name is not starting with k followed by CamelCase.

Parameters

[in]

value

number to convert

Definition at line 54 of file outputformatter.h.

                               {
    constexpr size_t kBufferSize = 13;
    char buffer[kBufferSize];
    const auto length = std::snprintf(buffer, kBufferSize, "%g", value);
    assert(static_cast<size_t>(length) < kBufferSize);
    assert(length > 0);
    return std::string{buffer, buffer + length};
  }

as_precise_double()

type smash::ToASCII::as_precise_double ( double  value )

inline

Converts a double with 9 digits of precision.

See also

as_double for further information.

Note

The duplication of the code of the as_double method is done on purpose as naively extracting a function passing the std::snprintf format string as parameter would trigger a warning in compilation (the format has to be a literal in order to be checked by the compiler at compile time) and the effort to avoid this is not worth now, especially since this code will be changed anyhow when using C++20.

Parameters

[in]

value

number to convert

Definition at line 77 of file outputformatter.h.

                                       {
    constexpr size_t kBufferSize = 16;
    char buffer[kBufferSize];
    const auto length = std::snprintf(buffer, kBufferSize, "%.9g", value);
    assert(static_cast<size_t>(length) < kBufferSize);
    assert(length > 0);
    return std::string{buffer, buffer + length};
  }

as_string()

type smash::ToASCII::as_string ( const std::string &  str ) const

inline

Because ToASCII converts into strings, this simply returns the string itself.

Parameters

[in,out]

str

string to be written

Definition at line 92 of file outputformatter.h.

{ return str; }

---

The documentation for this struct was generated from the following file:

• src/include/smash/outputformatter.h