包括一个大 header 以使用 object 作为默认参数

Including a large header to use an object as a default argument

我正在开发一个用于命令行应用程序的小型库。这个库的一个特点是它的主要 class 可以在 ostream 中生成文本,例如:

#include <iostream>    

class MyClass {
    std::string a;
    std::string b;

    void printToStream(std::ostream& stream = std::cout)
    {
        stream << "a: " << a << " | b: " << b << std::endl;
    }
}

我的问题是关于使用 std::cout 作为默认参数。 它的存在只是为了使库更易于使用,因为正如我之前所说,它适用于命令行应用程序,所以大多数时候所需的输出应该是标准输出,但以防用户需要不同的输出流他们可以自己提供一个。

这是我的库中唯一使用 iostream 中的任何内容的点,所以我想知道使用这样的默认参数是否会导致任何效率损失。据我了解,iostream 是一个庞然大物,超过 25,000 行代码,如果用户提供自己的输出流,它会被无偿地包含在内。

此外,我知道编译器可能足够聪明,如果 cout 最终未在此处使用,则不会在最终可执行文件中包含来自 iostream 的任何内容,但我想知道此包含在我的库中的全部影响 - 以及是否有更好的方法将 cout 实现为默认参数,而无需用户在不需要时针对 iostream 进行构建。

非常简短的回答:就您的编程工作而言,可能不是您最重要的决定。

更长的答案,实际上并没有比上面告诉你更多,但如果你愿意的话,你可能仍然会觉得很有趣。

这是高度依赖于您的环境敏感程度的问题之一。如果您正在构建一个具有 256KB RAM 的系统,并且您必须将多个应用程序、一个操作系统和一个数据库引擎安装到所有这些系统中,显然,每千字节的应用程序 space 都是宝贵的。另一方面,在我的笔记本电脑或台式机上,一方面内存的兆字节比手指多,可能根本没有什么可担心的。在具有几兆字节 RAM 的中等系统中,减少代码大小不是您的首要任务。

我使用单个头文件快速编写了两个简单的应用程序:

myclass.h:

#include <iostream>    

class MyClass {
public:
    std::string a;
    std::string b;

    void printToStream(std::ostream& stream = std::cout)
    {
        stream << "a: " << a << " | b: " << b << std::endl;
    }
};

然后 "uses" printToStream:

uses.cpp:

#include "myclass.h"

int main()
{
    MyClass m;
    m.a = "Hello";
    m.b = "World";
    m.printToStream();
}

g++ -O1 中的大小:3502 字节,clang++ -O1:4409

和一个不使用 printToStream:

nouse.cpp:

#include "myclass.h"

int main()
{
    MyClass m;
    m.a = "Hello";
    m.b = "World";
}

g++ -O1 中的大小:2349 字节,clang++ -O1:2923

clang++ -O1 的大小差异约为 1500 字节,g++ -O1 的大小差异约为 1200 字节。总代码大小约为 2.5-4KB,因此在这个小示例中它大约占总大小的 30%。显然,这远非线性 - 一旦您使用 std::cout,所有使用的初始化都在那里。

如果我将 myclass.h 文件修改为 #include <string>,并完全删除对流的引用,它会进一步从 nouse.cpp 生成的二进制文件中删除大约 300 字节的代码。这表明只要包含 <iostream> 就会将一些代码添加到您的二进制文件中。但是,使用 <ostream> 而不是 <iostream> 对生成的二进制文件没有影响。

我还尝试删除 std::cout 默认参数。这根本没有区别(除了代码更改以在 uses.cpp 中具有附加参数),所以大小是相同的。它对 nouse.cpp 也没有影响 - 额外的代码仍然存在以初始化 cout.

同样,在主文件中包含 <ostream> 然后包含 <iostream>uses.cpp 的大小没有影响(不使用默认参数)。

我也尝试了 -O2,它使代码大小发生变化(在 g++ 中更大,在 clang++ 中更小),但相对差异不是很大。

显然,这是两个最流行的 open-source C++ 编译器的两个实例。其他编译器可能会给出略有不同的结果。如果它非常重要,请使用您的编译器进行测试。

g++ 版本:7.2.0 与 Ubunt 一起提供,clang++:7.0.0(使用 git 版本的源构建