漂亮打印std :: tuple

86

这是我先前关于漂亮打印的STL容器的问题的跟进，我们设法为其开发了一个非常优雅且完全通用的解决方案。

在接下来的步骤中，我想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，对定界符）的加分点！

c++  c++11  tuples  variadic-templates 
— 克瑞克SB
source
有人将这里的任何代码放入库了吗？甚至是一个可以抓取并使用的具有所有内容的.hpp？
— einpoklum
@einpoklum：也许是cxx-prettyprint？这就是我需要的代码。
— Kerrek SB 2015年
1
这是一个很好的问题，但对“我不会给我的代码打乱您负担” +1，但我很惊讶，这似乎实际上已经成功地攻防了那些毫无头脑的“您尝试了什么”的大军。
— Don Hatch

Answers:

78

是的，索引〜

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)swallow{0, (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 << ")";
}

有关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)swallow{0, (void(os << (Is == 0? "" : delim) << std::get<Is>(t)), 0)...};
}
— Xeo
source
@Kerrek：我目前正在测试和修复自己，尽管我在Ideone上得到了奇怪的输出。
— Xeo
我认为您还会混淆流和字符串。您正在写类似于“ std :: cout << std :: cout”的东西。换句话说，TuplePrinter没有operator<<。
— Kerrek SB 2011年
1
@Thomas：你不能只用class Tuple了operator<<过载-这将得到回升的任何和所有的东西。这将需要一个约束，这意味着需要某种可变参数。
— Xeo
1
@DanielFrey：这是一个解决问题，列表初始化担保左到右的顺序：swallow{(os << get<Is>(t))...};。
— Xeo
6
@Xeo如果您不介意的话，我向您借了cppreference。
— Cubbi 2013年
19

我在C ++ 11（gcc 4.7）中工作正常。我敢肯定，我没有考虑过一些陷阱，但是我认为代码易于阅读并且并不复杂。唯一奇怪的是可以确保我们在到达最后一个元素时终止的“后卫”结构tuple_printer。另一个奇怪的事情可能是sizeof ...（Types），它返回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;
}
— 托尼·奥尔森
source
1
是的，这看起来很明智-也许还有另一个专门针对空元组的功能，以求完整性。
— Kerrek SB 2013年
@KerrekSB，没有简单的方法在c ++中打印元组吗？在python函数中，隐式返回一个元组，您可以简单地在c ++中打印它们，以便从需要使用打包它们的函数中返回多个变量std::make_tuple()。但是在打印时main()，会引发很多错误！，关于打印元组的更简单方法有什么建议吗？
— 阿努
19

在C ++ 17中，我们可以通过利用Fold表达式（尤其是一元左折）来用更少的代码来完成此操作：

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)>());
}

现场演示输出：

（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

这很麻烦，因此我们需要做更多的技巧才能添加一个逗号分隔符，除非它是第一个元素，否则要首先打印。

为此，如果当前索引不是第一个索引，我们pack将fold表达式的一部分修改为要打印的部分，因此*：" ,"I(I == 0? "" : ", ")

(..., (std::cout << (I == 0? "" : ", ") << std::get<I>(_tup)));

现在我们得到

5，您好，-0.1

看起来更好（注意：我想要与此答案类似的输出）

*注意：您可以用多种方式（而不是我最终使用的方式）进行逗号分隔。我最初添加逗号条件之后，而不是之前的测试反对std::tuple_size<TupType>::value - 1，但那是太长了，所以我测试，而不是对抗sizeof...(I) - 1，但最后我复制XEO，我们结束了，我得到了什么。

— 安迪
source
1
您也可以将其if constexpr用于基本情况。
— Kerrek SB 2013年
@KerrekSB：用于决定是否打印逗号？不错的主意，希望它是三元组。
— AndyG '16
条件表达式已经是一个潜在的常数表达式，所以您所拥有的已经很不错了：-)
— Kerrek SB
17

令我惊讶的是，尚未在此处发布关于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，测试，3.14，Foo，bar，10，测试，3.14，10）

现场演示

— 安迪
source
4

基于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)
— 用户名
source
3

基于Bjarne Stroustrup的C ++编程语言，第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!")
— CW Holeman II
source
3

利用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;
}

或者，在stringstream的帮助下进行点缀：

#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();
}
— 达里奥
source
1

另一个类似于@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 << ")";
}
— 加布里埃尔
source
0

我喜欢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;
}
— 用户名
source
0

我对使用折叠表达式的先前答案不满意的一件事是，它们使用索引序列或标志来跟踪第一个元素，这消除了漂亮的干净折叠表达式的许多好处。

这是一个不需要索引但可以达到类似结果的示例。（不像其他一些复杂，但是可以添加更多。）

技术是使用折痕已经给您的东西：一种元素的特殊情况。即，一个元素的折叠仅扩展为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调用都被压缩了。

然而，这将需要第二次重载来处理一个空的元组。

— 大史密斯
source
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.