漂亮的打印 std::tuple
Posted
技术标签:
【中文标题】漂亮的打印 std::tuple【英文标题】：Pretty-print std::tuple 【发布时间】：2011-09-08 21:34:16 【问题描述】：这是我之前在 pretty-printing STL containers 上的问题的后续，我们设法为此开发了一个非常优雅且完全通用的解决方案。
在下一步中，我想使用可变参数模板为std::tuple<Args...> 进行漂亮打印（所以这严格来说是 C++11）。对于std::pair<S,T>，我简单说
std::ostream & operator<<(std::ostream & o, const std::pair<S,T> & p)
return o << "(" << p.first << ", " << p.second << ")";
打印元组的类似结构是什么？
我尝试了各种模板参数堆栈解包、传递索引并使用 SFINAE 来发现我何时位于最后一个元素，但没有成功。我不会用我损坏的代码给你带来负担；希望问题描述足够直截了当。本质上，我想要以下行为：
auto a = std::make_tuple(5, "Hello", -0.1);
std::cout << a << std::endl; // prints: (5, "Hello", -0.1)
包含与上一个问题相同级别的通用性（char/wchar_t，对分隔符）的加分！
【问题讨论】：
有人将这里的任何代码放入库中吗？或者甚至是一个可以抓取和使用的 .hpp-with-everything-in？ @einpoklum：也许是cxx-prettyprint？这就是我需要该代码的目的。 很好的问题，并且 +1 表示“我不会用我损坏的代码给你带来负担”，尽管我很惊讶它似乎实际上成功地抵御了盲目的“你尝试过什么”群体. 【参考方案1】：耶，indices~
namespace aux
template<std::size_t...> struct seq;
template<std::size_t N, std::size_t... Is>
struct gen_seq : gen_seq<N-1, N-1, Is...>;
template<std::size_t... Is>
struct gen_seq<0, Is...> : seq<Is...>;
template<class Ch, class Tr, class Tuple, std::size_t... Is>
void print_tuple(std::basic_ostream<Ch,Tr>& os, Tuple const& t, seq<Is...>)
using swallow = int[];
(void)swallow0, (void(os << (Is == 0? "" : ", ") << std::get<Is>(t)), 0)...;
// aux::
template<class Ch, class Tr, class... Args>
auto operator<<(std::basic_ostream<Ch, Tr>& os, std::tuple<Args...> const& t)
-> std::basic_ostream<Ch, Tr>&
os << "(";
aux::print_tuple(os, t, aux::gen_seq<sizeof...(Args)>());
return os << ")";
Live example on Ideone.
对于分隔符，只需添加这些部分特化：
// Delimiters for tuple
template<class... Args>
struct delimiters<std::tuple<Args...>, char>
static const delimiters_values<char> values;
;
template<class... Args>
const delimiters_values<char> delimiters<std::tuple<Args...>, char>::values = "(", ", ", ")" ;
template<class... Args>
struct delimiters<std::tuple<Args...>, wchar_t>
static const delimiters_values<wchar_t> values;
;
template<class... Args>
const delimiters_values<wchar_t> delimiters<std::tuple<Args...>, wchar_t>::values = L"(", L", ", L")" ;
并相应地更改operator<< 和print_tuple：
template<class Ch, class Tr, class... Args>
auto operator<<(std::basic_ostream<Ch, Tr>& os, std::tuple<Args...> const& t)
-> std::basic_ostream<Ch, Tr>&
typedef std::tuple<Args...> tuple_t;
if(delimiters<tuple_t, Ch>::values.prefix != 0)
os << delimiters<tuple_t,char>::values.prefix;
print_tuple(os, t, aux::gen_seq<sizeof...(Args)>());
if(delimiters<tuple_t, Ch>::values.postfix != 0)
os << delimiters<tuple_t,char>::values.postfix;
return os;
和
template<class Ch, class Tr, class Tuple, std::size_t... Is>
void print_tuple(std::basic_ostream<Ch, Tr>& os, Tuple const& t, seq<Is...>)
using swallow = int[];
char const* delim = delimiters<Tuple, Ch>::values.delimiter;
if(!delim) delim = "";
(void)swallow0, (void(os << (Is == 0? "" : delim) << std::get<Is>(t)), 0)...;
【讨论】：
@Kerrek：我目前正在测试和修复自己，但我在 Ideone 上得到了奇怪的输出。 我认为您也混淆了流和字符串。您正在编写类似于“std::cout TuplePrinter 没有operator<<。
@Thomas：你不能只使用class Tuple 来实现operator<< 重载——它会被用于任何事情。它需要一个约束，这有点暗示需要某种可变参数。
@DanielFrey：这是一个已解决的问题，列表初始化保证从左到右的顺序：swallow(os << get<Is>(t))...;。
@Xeo 我为cppreference借了你的燕子，如果你不介意的话。【参考方案2】：
在 C++17 中，我们可以通过利用 Fold expressions（尤其是一元左折叠）用更少的代码完成此操作：
template<class TupType, size_t... I>
void print(const TupType& _tup, std::index_sequence<I...>)
std::cout << "(";
(..., (std::cout << (I == 0? "" : ", ") << std::get<I>(_tup)));
std::cout << ")\n";
template<class... T>
void print (const std::tuple<T...>& _tup)
print(_tup, std::make_index_sequence<sizeof...(T)>());
Live Demo 输出：
（5，你好，-0.1）
给定
auto a = std::make_tuple(5, "Hello", -0.1);
print(a);
说明
我们的一元左折叠的形式是
... op pack
在我们的场景中，op 是逗号运算符，pack 是在未扩展上下文中包含我们的元组的表达式，例如：
(..., (std::cout << std::get<I>(myTuple))
如果我有这样的元组：
auto myTuple = std::make_tuple(5, "Hello", -0.1);
还有一个std::integer_sequence，其值由非类型模板指定（参见上面的代码）
size_t... I
然后是表达式
(..., (std::cout << std::get<I>(myTuple))
展开成
((std::cout << std::get<0>(myTuple)), (std::cout << std::get<1>(myTuple))), (std::cout << std::get<2>(myTuple));
哪个会打印
5Hello-0.1
这很恶心，所以我们需要做一些花招来添加一个逗号分隔符来首先打印，除非它是第一个元素。
为了实现这一点，如果当前索引I 不是第一个，我们修改折叠表达式的pack 部分以打印" ,"，因此(I == 0? "" : ", ") 部分*：
(..., (std::cout << (I == 0? "" : ", ") << std::get<I>(_tup)));
现在我们将得到
5，你好，-0.1
哪个看起来更好（注意：我想要与this answer类似的输出）
*注意：您可以通过多种方式进行逗号分隔，而不是我最终的结果。我最初通过测试std::tuple_size<TupType>::value - 1 有条件地添加逗号after 而不是before，但这太长了，所以我测试了sizeof...(I) - 1，但最后我复制了Xeo，我们最终得到了我所拥有的。
【讨论】：
您也可以使用if constexpr 作为基本情况。
@KerrekSB：决定是否打印逗号？不错的主意，希望它是三元的。
条件表达式已经是一个潜在的常量表达式，所以你所拥有的已经很好了:-)
对不起，你介意详细说明((std::cout << std::get<0>(myTuple)), (std::cout << std::get<1>(myTuple))), (std::cout << std::get<2>(myTuple));是什么表达方式吗？还没有看到逗号分隔的ostream列表...
@HCSF：好的，谢谢你的提问。这是cout << something 的三个调用，由comma operator 分隔。逗号运算符强制按顺序计算各个表达式，并丢弃表达式的结果（返回的流）。我们这样做是为了让折叠表达式能够以这样的方式工作，即包扩展... 会导致包中的每个参数调用一个函数（折叠表达式仅适用于运算符）。希望对您有所帮助。【参考方案3】：
我在 C++11 (gcc 4.7) 中运行良好。我确信有些陷阱我没有考虑过，但我认为代码易于阅读且并不复杂。唯一可能奇怪的是“守卫”结构 tuple_printer 确保我们在到达最后一个元素时终止。另一个奇怪的事情可能是 sizeof...(Types) ，它返回 Types 类型包中的类型数。用于确定最后一个元素的索引（size...(Types) - 1）。
template<typename Type, unsigned N, unsigned Last>
struct tuple_printer
static void print(std::ostream& out, const Type& value)
out << std::get<N>(value) << ", ";
tuple_printer<Type, N + 1, Last>::print(out, value);
;
template<typename Type, unsigned N>
struct tuple_printer<Type, N, N>
static void print(std::ostream& out, const Type& value)
out << std::get<N>(value);
;
template<typename... Types>
std::ostream& operator<<(std::ostream& out, const std::tuple<Types...>& value)
out << "(";
tuple_printer<std::tuple<Types...>, 0, sizeof...(Types) - 1>::print(out, value);
out << ")";
return out;
【讨论】：
是的，这看起来很合理——为了完整起见，也许还有空元组的另一种特化。 @KerrekSB，没有一种简单的方法可以在 c++ 中打印元组吗？在 python 函数中隐式返回一个元组，您可以简单地打印它们，在 c++ 中以便从功能我需要使用std::make_tuple() 打包它们。但是在main() 中打印它时，它会抛出一堆错误！，有什么更简单的打印元组方法的建议吗？【参考方案4】：
我很惊讶cppreference 上的实现还没有在这里发布，所以我会为后代做这件事。它隐藏在std::tuple_cat 的文档中，因此不容易找到。它像这里的其他一些解决方案一样使用保护结构，但我认为他们的最终更简单，更易于遵循。
#include <iostream>
#include <tuple>
#include <string>
// helper function to print a tuple of any size
template<class Tuple, std::size_t N>
struct TuplePrinter
static void print(const Tuple& t)
TuplePrinter<Tuple, N-1>::print(t);
std::cout << ", " << std::get<N-1>(t);
;
template<class Tuple>
struct TuplePrinter<Tuple, 1>
static void print(const Tuple& t)
std::cout << std::get<0>(t);
;
template<class... Args>
void print(const std::tuple<Args...>& t)
std::cout << "(";
TuplePrinter<decltype(t), sizeof...(Args)>::print(t);
std::cout << ")\n";
// end helper function
还有一个测试：
int main()
std::tuple<int, std::string, float> t1(10, "Test", 3.14);
int n = 7;
auto t2 = std::tuple_cat(t1, std::make_pair("Foo", "bar"), t1, std::tie(n));
n = 10;
print(t2);
输出：
(10, Test, 3.14, Foo, bar, 10, Test, 3.14, 10)
Live Demo
【讨论】：
【参考方案5】：利用std::apply (C++17) 我们可以删除std::index_sequence 并定义一个函数：
#include <tuple>
#include <iostream>
template<class Ch, class Tr, class... Args>
auto& operator<<(std::basic_ostream<Ch, Tr>& os, std::tuple<Args...> const& t)
std::apply([&os](auto&&... args) ((os << args << " "), ...);, t);
return os;
或者，在字符串流的帮助下稍微修饰一下：
#include <tuple>
#include <iostream>
#include <sstream>
template<class Ch, class Tr, class... Args>
auto& operator<<(std::basic_ostream<Ch, Tr>& os, std::tuple<Args...> const& t)
std::basic_stringstream<Ch, Tr> ss;
ss << "[ ";
std::apply([&ss](auto&&... args) ((ss << args << ", "), ...);, t);
ss.seekp(-2, ss.cur);
ss << " ]";
return os << ss.str();
【讨论】：
任何使用const& 的人都值得一票（而且我使用了这个解决方案）。【参考方案6】：
基于 AndyG 代码，用于 C++17
#include <iostream>
#include <tuple>
template<class TupType, size_t... I>
std::ostream& tuple_print(std::ostream& os,
const TupType& _tup, std::index_sequence<I...>)
os << "(";
(..., (os << (I == 0 ? "" : ", ") << std::get<I>(_tup)));
os << ")";
return os;
template<class... T>
std::ostream& operator<< (std::ostream& os, const std::tuple<T...>& _tup)
return tuple_print(os, _tup, std::make_index_sequence<sizeof...(T)>());
int main()
std::cout << "deep tuple: " << std::make_tuple("Hello",
0.1, std::make_tuple(1,2,3,"four",5.5), 'Z')
<< std::endl;
return 0;
有输出：
deep tuple: (Hello, 0.1, (1, 2, 3, four, 5.5), Z)
【讨论】：
【参考方案7】：基于The C++ Programming Language By Bjarne Stroustrup, page 817的示例：
#include <tuple>
#include <iostream>
#include <string>
#include <type_traits>
template<size_t N>
struct print_tuple
template<typename... T>static typename std::enable_if<(N<sizeof...(T))>::type
print(std::ostream& os, const std::tuple<T...>& t)
char quote = (std::is_convertible<decltype(std::get<N>(t)), std::string>::value) ? '"' : 0;
os << ", " << quote << std::get<N>(t) << quote;
print_tuple<N+1>::print(os,t);
template<typename... T>static typename std::enable_if<!(N<sizeof...(T))>::type
print(std::ostream&, const std::tuple<T...>&)
;
std::ostream& operator<< (std::ostream& os, const std::tuple<>&)
return os << "()";
template<typename T0, typename ...T> std::ostream&
operator<<(std::ostream& os, const std::tuple<T0, T...>& t)
char quote = (std::is_convertible<T0, std::string>::value) ? '"' : 0;
os << '(' << quote << std::get<0>(t) << quote;
print_tuple<1>::print(os,t);
return os << ')';
int main()
std::tuple<> a;
auto b = std::make_tuple("One meatball");
std::tuple<int,double,std::string> c(1,1.2,"Tail!");
std::cout << a << std::endl;
std::cout << b << std::endl;
std::cout << c << std::endl;
输出：
()
("One meatball")
(1, 1.2, "Tail!")
【讨论】：
【参考方案8】：另一个类似于@Tony Olsson 的，包括空元组的特化，正如@Kerrek SB 所建议的那样。
#include <tuple>
#include <iostream>
template<class Ch, class Tr, size_t I, typename... TS>
struct tuple_printer
static void print(std::basic_ostream<Ch,Tr> & out, const std::tuple<TS...> & t)
tuple_printer<Ch, Tr, I-1, TS...>::print(out, t);
if (I < sizeof...(TS))
out << ",";
out << std::get<I>(t);
;
template<class Ch, class Tr, typename... TS>
struct tuple_printer<Ch, Tr, 0, TS...>
static void print(std::basic_ostream<Ch,Tr> & out, const std::tuple<TS...> & t)
out << std::get<0>(t);
;
template<class Ch, class Tr, typename... TS>
struct tuple_printer<Ch, Tr, -1, TS...>
static void print(std::basic_ostream<Ch,Tr> & out, const std::tuple<TS...> & t)
;
template<class Ch, class Tr, typename... TS>
std::ostream & operator<<(std::basic_ostream<Ch,Tr> & out, const std::tuple<TS...> & t)
out << "(";
tuple_printer<Ch, Tr, sizeof...(TS) - 1, TS...>::print(out, t);
return out << ")";
【讨论】：
【参考方案9】：我喜欢 DarioP 的回答，但 stringstream 使用堆。这是可以避免的：
template <class... Args>
std::ostream& operator<<(std::ostream& os, std::tuple<Args...> const& t)
os << "(";
bool first = true;
std::apply([&os, &first](auto&&... args)
auto print = [&] (auto&& val)
if (!first)
os << ",";
(os << " " << val);
first = false;
;
(print(args), ...);
, t);
os << " )";
return os;
【讨论】：
【参考方案10】：我看到使用带有 C++17 的 std::index_sequence 的答案，但是，这不是我个人要走的路。我宁愿去递归和constexpr if：
#include <tuple>
#include <iostream>
template<std::size_t I, class... Ts>
void doPrintTuple(const std::tuple<Ts...>& tuples)
if constexpr (I == sizeof...(Ts))
std::cout << ')';
else
std::cout << std::get<I>(tuples);
if constexpr (I + 1 != sizeof...(Ts))
std::cout << ", ";
doPrintTuple<I + 1>(tuples);
template<class... Ts>
void printTuple(const std::tuple<Ts...>& tuples)
std::cout << '(';
doPrintTuple<0>(tuples);
int main()
auto tup = std::make_tuple(1, "hello", 4.5);
printTuple(tup);
输出：
(1, hello, 4.5)
【讨论】：
【参考方案11】：我不喜欢之前使用折叠表达式的答案的一点是，它们使用索引序列或标志来跟踪第一个元素，这消除了漂亮干净折叠表达式的大部分好处。
这是一个不需要索引的示例，但可以实现类似的结果。 （不如其他一些复杂，但可以添加更多。）
技术是使用折叠已经给你的东西：一个元素的特殊情况。即，一个元素折叠只扩展为elem[0]，然后2个元素是elem[0] + elem[1]，其中+是一些操作。我们想要的是让一个元素只将那个元素写入流中，而对于更多元素，也这样做，但将每个元素与额外的“，”写入连接起来。因此，将其映射到 c++ 折叠，我们希望每个元素都是将某个对象写入流的动作。我们希望我们的+ 操作是在两个写入之间穿插一个“，”写入。因此，首先将我们的元组序列转换为一系列写入操作，CommaJoiner 我已经调用了它，然后为该操作添加一个 operator+ 以按照我们想要的方式加入两个操作，在两者之间添加一个“，”：
#include <tuple>
#include <iostream>
template <typename T>
struct CommaJoiner
T thunk;
explicit CommaJoiner(const T& t) : thunk(t)
template <typename S>
auto operator+(CommaJoiner<S> const& b) const
auto joinedThunk = [a=this->thunk, b=b.thunk] (std::ostream& os)
a(os);
os << ", ";
b(os);
;
return CommaJoiner<decltype(joinedThunk)>joinedThunk;
void operator()(std::ostream& os) const
thunk(os);
;
template <typename ...Ts>
std::ostream& operator<<(std::ostream& os, std::tuple<Ts...> tup)
std::apply([&](auto ...ts)
return (... + CommaJoiner[=](auto&os) os << ts;);, tup)(os);
return os;
int main()
auto tup = std::make_tuple(1, 2.0, "Hello");
std::cout << tup << std::endl;
粗略看一下 Godbolt 表明它编译得也很好，所有的 thunk 调用都被展平了。
然而，这将需要第二次重载来处理空元组。
【讨论】：
【参考方案12】：这是我最近为打印元组编写的一些代码。
#include <iostream>
#include <tuple>
using namespace std;
template<typename... Ts>
ostream& operator<<(ostream& output, const tuple<Ts...> t)
output << '(';
apply([&](auto&&... args)
((cout << args << ", "), ...);
, t);
output << "\b\b";
output << ')';
return output;
使用您的示例案例：
auto a = std::make_tuple(5, "Hello", -0.1);
cout << a << '\n'; // (5, Hello, -0.1)
【讨论】：
以上是关于漂亮的打印 std::tuple的主要内容，如果未能解决你的问题，请参考以下文章