【C++基础】第五十七课:[泛型算法]初识泛型算法

accumulate,equal,fill,fill_n,back_inserter,copy,replace,replace_copy,sort,unique

Posted by x-jeff on November 27, 2022

【C++基础】系列博客为参考《C++ Primer中文版(第5版)》C++11标准)一书,自己所做的读书笔记。
本文为原创文章,未经本人允许,禁止转载。转载请注明出处。

1.初识泛型算法

标准库提供了超过100个算法。除了少数例外,标准库算法都对一个范围内的元素进行操作。我们将此元素范围称为“输入范围”。接受输入范围的算法总是使用前两个参数来表示此范围,两个参数分别是指向要处理的第一个元素和尾元素之后位置的迭代器。

2.只读算法

一些算法只会读取其输入范围内的元素,而从不改变元素。find就是这样一种算法。

另一个只读算法是accumulate,它定义在头文件numeric中。accumulate函数接受三个参数,前两个指出了需要求和的元素的范围,第三个参数是和的初值。假定vec是一个整数序列,则:

1
2
//对vec中的元素求和,和的初值是0
int sum = accumulate(vec.cbegin(), vec.cend(), 0);

accumulate的第三个参数的类型决定了函数中使用哪个加法运算符以及返回值的类型。

1
2
3
4
5
vector<int> vec = {1,2,3};
int sum = accumulate(vec.cbegin(),vec.cend(),0);
cout<< sum << endl; //输出6
sum = accumulate(vec.cbegin(),vec.cend(),2);
cout<< sum << endl; //输出8

2.1.算法和元素类型

accumulate将第三个参数作为求和起点,这蕴含着一个编程假定:将元素类型加到和的类型上的操作必须是可行的。即,序列中元素的类型必须与第三个参数匹配,或者能够转换为第三个参数的类型。在上例中,vec中的元素可以是int,或者是double、long long或任何其他可以加到int上的类型。

下面是另一个例子,由于string定义了+运算符,所以我们可以通过调用accumulate来将vector中所有string元素连接起来:

1
string sum = accumulate(v.cbegin(), v.cend(), string(""));

此调用将v中每个元素连接到一个string上,该string初始时为空串。注意,我们通过第三个参数显式地创建了一个string。将空串当做一个字符串字面值传递给第三个参数是不可以的,会导致一个编译错误。

1
2
//错误:const char*上没有定义+运算符
string sum = accumulate(v.cbegin(), v.cend(), "");

原因在于,如果我们传递了一个字符串字面值,用于保存和的对象的类型将是const char*。如前所述,此类型决定了使用哪个+运算符。由于const char*并没有+运算符,此调用将产生编译错误。

对于只读取而不改变元素的算法,通常最好使用cbegin()和cend()。但是,如果你计划使用算法返回的迭代器来改变元素的值,就需要使用begin()和end()的结果作为参数。

2.2.操作两个序列的算法

另一个只读算法是equal,用于确定两个序列是否保存相同的值。它将第一个序列中的每个元素与第二个序列中的对应元素进行比较。如果所有对应元素都相等,则返回true,否则返回false。此算法接受三个迭代器:前两个(与以往一样)表示第一个序列中的元素范围,第三个表示第二个序列的首元素:

1
2
//roster2中的元素数目应该至少与roster1一样多
equal(roster1.cbegin(), roster1.cend(), roster2.cbegin());

由于equal利用迭代器完成操作,因此我们可以通过调用equal来比较两个不同类型的容器中的元素。而且,元素类型也不必一样,只要我们能用==来比较两个元素类型即可。例如,在此例中,roster1可以是vector<string>,而roster2是list<const char*>。

但是,equal基于一个非常重要的假设:它假定第二个序列至少与第一个序列一样长。此算法要处理第一个序列中的每个元素,它假定每个元素在第二个序列中都有一个与之对应的元素。

那些只接受一个单一迭代器来表示第二个序列的算法,都假定第二个序列至少与第一个序列一样长。

一些特殊情况的测试:

1
2
3
4
5
6
7
8
9
10
11
vector<int> vec1 = {1,2,3};
vector<int> vec2 = {1,2};
vector<int> vec3 = {1,2,3,4};
vector<float> vec4 = {1.f,2.f,3.f};
bool b;
b = equal(vec1.cbegin(),vec1.cend(),vec2.cbegin());
cout << b << endl; //打印0,即false,如果vec2的长度短于vec1,无论vec2里面是什么值,都返回0
b = equal(vec1.cbegin(),vec1.cend(),vec3.cbegin());
cout << b << endl; //打印1,即true,只要vec3和vec1中对应位置上的元素相等即返回1,不管vec3中多出的元素
b = equal(vec1.cbegin(),vec1.cend(),vec4.cbegin());
cout << b << endl; //打印1,即true

3.写容器元素的算法

一些算法将新值赋予序列中的元素。当我们使用这类算法时,必须注意确保序列原大小至少不小于我们要求算法写入的元素数目。记住,算法不会执行容器操作,因此它们自身不可能改变容器的大小。

一些算法会自己向输入范围写入元素。这些算法本质上并不危险,它们最多写入与给定序列一样多的元素。

例如,算法fill接受一对迭代器表示一个范围,还接受一个值作为第三个参数。fill将给定的这个值赋予输入序列中的每个元素。

1
2
3
fill(vec.begin(), vec.end(), 0); //将每个元素重置为0
//将容器的一个子序列设置为10
fill(vec.begin(), vec.begin() + vec.size()/2, 10);

由于fill向给定输入序列中写入数据,因此,只要我们传递了一个有效的输入序列,写入操作就是安全的。

关键概念:迭代器参数

一些算法从两个序列中读取元素。构成这两个序列的元素可以来自于不同类型的容器。例如,第一个序列可能保存于一个vector中,而第二个序列可能保存于一个list、deque、内置数组或其他容器中。而且,两个序列中元素的类型也不要求严格匹配。算法要求的只是能够比较两个序列中的元素。例如,对equal算法,元素类型不要求相同,但是我们必须能使用==来比较来自两个序列中的元素。

操作两个序列的算法之间的区别在于我们如何传递第二个序列。一些算法,例如equal,接受三个迭代器:前两个表示第一个序列的范围,第三个表示第二个序列中的首元素。其他算法接受四个迭代器:前两个表示第一个序列的元素范围,后两个表示第二个序列的范围。

用一个单一迭代器表示第二个序列的算法都假定第二个序列至少与第一个一样长。确保算法不会试图访问第二个序列中不存在的元素是程序员的责任。例如,算法equal会将其第一个序列中的每个元素与第二个序列中的对应元素进行比较。如果第二个序列是第一个序列的一个子集,则程序会产生一个严重错误–equal会试图访问第二个序列中末尾之后(不存在)的元素。

3.1.算法不检查写操作

一些算法接受一个迭代器来指出一个单独的目的位置。这些算法将新值赋予一个序列中的元素,该序列从目的位置迭代器指向的元素开始。例如,函数fill_n接受一个单迭代器、一个计数值和一个值。它将给定值赋予迭代器指向的元素开始的指定个元素。我们可以用fill_n将一个新值赋予vector中的元素:

1
2
3
vector<int> vec;//空vector
//使用vec,赋予它不同值
fill_n(vec.begin(), vec.size(), 0);//将所有元素重置为0,vec其实依然是空的

函数fill_n假定写入指定个元素是安全的。即,如下形式的调用

1
fill_n(dest, n, val)

fill_n假定dest指向一个元素,而从dest开始的序列至少包含n个元素。

一个非常容器犯的错误是在一个空容器上调用fill_n(或类似的写元素的算法):

1
2
3
vector<int> vec;//空vector
//灾难:修改vec中的10个(不存在)元素,结果是未定义的
fill_n(vec.begin(), 10, 0);

向目的位置迭代器写入数据的算法假定目的位置足够大,能容纳要写入的元素。

3.2.介绍back_inserter

一种保证算法有足够元素空间来容纳输出数据的方法是使用插入迭代器(insert iterator)。插入迭代器是一种向容器中添加元素的迭代器。通常情况,当我们通过一个迭代器向容器元素赋值时,值被赋予迭代器指向的元素。而当我们通过一个插入迭代器赋值时,一个与赋值号右侧值相等的元素被添加到容器中。

后续博文会详细介绍插入迭代器的内容。但是,为了展示如何用算法向容器写入数据,我们现在将使用back_inserter,它是定义在头文件iterator中的一个函数。

back_inserter接受一个指向容器的引用,返回一个与该容器绑定的插入迭代器。当我们通过此迭代器赋值时,赋值运算符会调用push_back将一个具有给定值的元素添加到容器中:

1
2
3
vector<int> vec = {1, 2, 3};
auto it = back_inserter(vec);//通过它赋值会将元素添加到vec中
*it = 42;//vec={1,2,3,42}

我们常常使用back_inserter来创建一个迭代器,作为算法的目的位置来使用。例如:

1
2
3
vector<int> vec;//空vector
//正确:back_inserter创建一个插入迭代器,可用来向vec添加元素
fill_n(back_inserter(vec), 10, 0);//添加10个元素到vec

在每步迭代中,fill_n向给定序列的一个元素赋值。由于我们传递的参数是back_inserter返回的迭代器,因此每次赋值都会在vec上调用push_back。最终,这条fill_n调用语句向vec的末尾添加了10个元素,每个元素的值都是0。

3.3.拷贝算法

拷贝(copy)算法是另一个向目的位置迭代器指向的输出序列中的元素写入数据的算法。此算法接受三个迭代器,前两个表示一个输入范围,第三个表示目的序列的起始位置。此算法将输入范围中的元素拷贝到目的序列中。传递给copy的目的序列至少要包含与输入序列一样多的元素,这一点很重要。

我们可以用copy实现内置数组的拷贝:

1
2
3
4
int a1[] = {0,1,2,3,4,5,6,7,8,9};
int a2[sizeof(a1)/sizeof(*a1)];//a2与a1大小一样
//ret指向拷贝到a2的尾元素之后的位置
auto ret = copy(begin(a1), end(a1), a2);//把a1的内容拷贝给a2,此时a1和a2完全一样

多个算法都提供所谓的“拷贝”版本。这些算法计算新元素的值,但不会将它们放置在输入序列的末尾,而是创建一个新序列保存这些结果。

例如,replace算法读入一个序列,并将其中所有等于给定值的元素都改为另一个值。此算法接受4个参数:前两个是迭代器,表示输入序列,后两个一个是要搜索的值,另一个是新值。它将所有等于第一个值的元素替换为第二个值:

1
2
//将所有值为0的元素改为42
replace(ilst.begin(), ilst.end(), 0, 42);

此调用将序列中所有的0都替换为42。如果我们希望保留原序列不变,可以调用replace_copy。此算法接受额外第三个迭代器参数,指出调整后序列的保存位置:

1
2
3
4
list ilst = {0,1,0,1};
vector<int> ivec = {9,8,7};
//使用back_inserter按需要增长目标序列
replace_copy(ilst.cbegin(), ilst.cend(), back_inserter(ivec), 0, 42);//ivec={9,8,7,42,1,42,1}

此调用后,ilst并未改变。

4.重排容器元素的算法

某些算法会重排容器中元素的顺序,一个明显的例子是sort。调用sort会重排输入序列中的元素,使之有序,它是利用元素类型的<运算符来实现排序的。

例如,假定我们想分析一系列儿童故事中所用的词汇。假定已有一个vector,保存了多个故事的文本。我们希望化简这个vector,使得每个单词只出现一次,而不管单词在任意给定文档中到底出现了多少次。

为了便于说明问题,我们将使用下面简单的故事作为输入:

1
the quick red fox jumps over the slow red turtle

给定此输入,我们的程序应该生成如下vector:

4.1.消除重复单词

为了消除重复单词,首先将vector排序,使得重复的单词都相邻出现。一旦vector排序完毕,我们就可以使用另一个称为unique的标准库算法来重排vector,使得不重复的元素出现在vector的开始部分。由于算法不能执行容器的操作,我们将使用vector的erase成员来完成真正的删除操作:

1
2
3
4
5
6
7
8
9
10
void elimDups(vector<string>& words)
{
	//按字典序排序words,以便查找重复单词
	sort(words.begin(), words.end());
	//unique重排输入范围,使得每个单词只出现一次
	//排列在范围的前部,返回指向不重复区域之后一个位置的迭代器
	auto end_unique = unique(words.begin(), words.end());
	//使用向量操作erase删除重复单词
	words.erase(end_unique, words.end());
}

sort算法接受两个迭代器,表示要排序的元素范围。在此例中,我们排序整个vector。完成sort后,words的顺序如下所示:

注意,单词red和the各出现了两次。

4.2.使用unique

words排序完毕后,我们希望将每个单词都只保存一次。unique算法重排输入序列,将相邻的重复项“消除”,并返回一个指向不重复值范围末尾的迭代器。调用unique后,vector将变为:

words的大小并未改变,它仍有10个元素。但这些元素的顺序被改变了—相邻的重复元素被“删除”了。我们将删除打引号是因为unique并不真的删除任何元素,它只是覆盖相邻的重复元素,使得不重复元素出现在序列开始部分。unique返回的迭代器指向最后一个不重复元素之后的位置。此位置之后的元素仍然存在,但我们不知道它们的值是什么。

标准库算法对迭代器而不是容器进行操作。因此,算法不能(直接)添加或删除元素。

4.3.使用容器操作删除元素

为了真正地删除无用元素,我们必须使用容器操作,本例中使用erase。我们删除从end_unique开始直至words末尾的范围内的所有元素。这个调用之后,words包含来自输入的8个不重复的单词。

值得注意的是,即使words中没有重复单词,这样调用erase也是安全的。在此情况下,unique会返回words.end()。因此,传递给erase的两个参数具有相同的值:words.end()。迭代器相等意味着传递给erase的元素范围为空。删除一个空范围没有什么不良后果,因此程序即使在输入中无重复元素的情况下也是正确的。