【C++】STL 算法 - for_each 遍历算法 ( for_each 函数原型 | for_each 函数源码分析 | for_each 函数 _Fn _Func 参数值传递说明 )

韩曙亮

发布于 2024-01-14 09:58:06

1800

发布于 2024-01-14 09:58:06

文章被收录于专栏：韩曙亮的移动开发专栏韩曙亮的移动开发专栏

文章目录

一、for_each 算法
- 1、for_each 函数简介
- 2、for_each 函数原型
- 3、for_each 函数源码分析
- 4、for_each 函数 _Fn _Func 参数值传递说明
二、代码示例 - for_each 算法
- 1、代码示例 - for_each 算法传入普通函数
- 2、代码示例 - for_each 算法传入 Lambda 表达式
- 3、代码示例 - for_each 算法传入一元函数对象
- 4、代码示例 - for_each 算法函数对象值传递

一、for_each 算法

1、for_each 函数简介

在 C++ 语言的标准模板库 ( STL , Standard Template Library ) 中 , 提供了 for_each 算法用于对一个 STL 容器中的每个元素执行某个指定的 " 操作 " ;

for_each 算法中执行的 " 操作 " 可以是一个函数 / 函数对象 / Lambda 表达式 ;

在 for_each 函数中可以修改被遍历的元素 , 也可以不修改元素 ;

2、for_each 函数原型

for_each 算法函数原型 : 将迭代器范围内的所有元素传入一个参数的可调用对象 , 逐个遍历执行上述操作 ;

template <class InputIt, class Function>  
Function for_each(InputIt first, InputIt last, Function f);

参数解析 :
- InputIt first 参数 : 要遍历的迭代器范围的起始迭代器 , first 参数是指向序列中第一个元素的迭代器 ; 这是 " 前闭后开区间 " 的起始闭区间 ;
- InputIt last 参数 : 要遍历的迭代器范围的终止迭代器 , last 参数是指向序列中最后一个元素之后位置的迭代器 ; 这是 " 前闭后开区间 " 的末尾开区间 ;
- Function f 参数 : 接收一个参数的可调用对象 , 可以是一元函数对象或者接收一个参数的普通函数 / Lambda 表达式 , 将迭代器范围内的所有元素 , 传入该可调用对象中 ,
- 迭代器范围解析 : 是一个 " 前闭后开区间 " , 起始迭代器指向的元素包含在范围之内 , 终止迭代器指向的元素不包含在范围之内 , 如果终止迭代器是末尾迭代器 end() , 那么指向无意义元素 ;
返回值解析 : 该算法函数的返回值是传入的函数对象 ;
- 保存状态 : 如果传入的是函数对象 , 这一返回值特性使得作为参数传入的函数对象可以在 for_each 调用之后保持其状态 , 这里的 " 状态 " 指的是函数对象类中的成员变量 ; 如果传入的事普通函数或 Lambda 表达式 , 则没有状态 ;
- 链式调用 : 返回值是传入的可调用对象本身 , 可用于实现 " 链式调用 " ;

3、for_each 函数源码分析

for_each 源代码如下 :

// FUNCTION TEMPLATE for_each
template <class _InIt, class _Fn>
_Fn for_each(_InIt _First, _InIt _Last, _Fn _Func) { // perform function for each element [_First, _Last)
    _Adl_verify_range(_First, _Last);
    auto _UFirst      = _Get_unwrapped(_First);
    const auto _ULast = _Get_unwrapped(_Last);
    for (; _UFirst != _ULast; ++_UFirst) {
        _Func(*_UFirst);
    }

    return _Func;
}

该函数是一个 " 模板函数 " , 第一个模板类型 _InIt 是迭代器类型 , 第二个模板类型 _Fn 是可调用对象类型 , 该可调用对象接收一个函数参数 , 可以是函数对象 / 普通函数 ,

在该模板函数中 , 遍历 _InIt _First 和 _InIt _Last 范围的元素 , 传入到 _Func 函数对象中 , 调用完成后 , 将 _Func 函数对象返回 , 该函数可进行链式调用 ;

4、for_each 函数 _Fn _Func 参数值传递说明

这里特别注意 : 传入的 _Fn _Func 参数是函数对象 , 该参数类型是值类型 , 不是引用或一维指针类型 , 因此该传入的参数是值传递 , 传入参数是实参的副本 ,

也就是将函数对象 A 传入到 for_each 函数中 , 此时会将 A 对象赋值一份副本 B 传入到 for_each 中 , 在 for_each 函数中使用的是对象 B , 然后返回的也是对象 B ;

二、代码示例 - for_each 算法

1、代码示例 - for_each 算法传入普通函数

代码示例 :

#include "iostream"
using namespace std;
#include <vector>
#include <algorithm>
#include "functional"

// 普通函数
void printElement(int& n)
{
	cout << n << " ";
}

int main() {

	// 创建一个 set 集合容器
	vector<int> myVector;

	// 向容器中插入元素
	myVector.push_back(9);
	myVector.push_back(5);
	myVector.push_back(2);
	myVector.push_back(7);
	myVector.push_back(2);

	// 向 foreach 循环中传入 Lambda 表达式
	for_each(myVector.begin(), myVector.end(), printElement);
	cout << endl;

	// 控制台暂停 , 按任意键继续向后执行
	system("pause");
	return 0;
};

执行结果 :

9 5 2 7 2
请按任意键继续. . .

2、代码示例 - for_each 算法传入 Lambda 表达式

代码示例 :

#include "iostream"
using namespace std;
#include <vector>
#include <algorithm>
#include "functional"

int main() {

	// 创建一个 set 集合容器
	vector<int> myVector;

	// 向容器中插入元素
	myVector.push_back(9);
	myVector.push_back(5);
	myVector.push_back(2);
	myVector.push_back(7);
	myVector.push_back(2);

	// 向 foreach 循环中传入 Lambda 表达式
	for_each(myVector.begin(), myVector.end(), [](int a) {
		std::cout << a << " ";
		});
	cout << endl;

	// 控制台暂停 , 按任意键继续向后执行
	system("pause");
	return 0;
};

执行结果 :

9 5 2 7 2
请按任意键继续. . .

3、代码示例 - for_each 算法传入一元函数对象

代码示例 :

#include "iostream"
using namespace std;
#include <vector>
#include <algorithm>
#include "functional"

// 一元函数对象
class PrintElement{
public:
	PrintElement(){
		count = 0;
	}
	void operator()(int& n){
		cout << count << ". " << n << " , ";
		count++;
	}
private:
	int count;
};

int main() {

	// 创建一个 vector 集合容器
	vector<int> myVector;

	// 向容器中插入元素
	myVector.push_back(9);
	myVector.push_back(5);
	myVector.push_back(2);
	myVector.push_back(7);
	myVector.push_back(2);

	// 向 foreach 循环中传入 Lambda 表达式
	for_each(myVector.begin(), myVector.end(), PrintElement());
	cout << endl;

	// 控制台暂停 , 按任意键继续向后执行
	system("pause");
	return 0;
};

执行结果 :

0. 9 , 1. 5 , 2. 2 , 3. 7 , 4. 2 ,
请按任意键继续. . .

4、代码示例 - for_each 算法函数对象值传递

代码示例 :

#include "iostream"
using namespace std;
#include <vector>
#include <algorithm>
#include "functional"

// 一元函数对象
class PrintElement{
public:
	PrintElement(){
		count = 0;
	}
	void operator()(int& n){
		cout << count << ". " << n << " , ";
		count++;
	}
	void printCount() {
		cout << "count = " << count << endl;
	}
private:
	int count;
};

int main() {

	// 创建一个 vector 集合容器
	vector<int> myVector;

	// 向容器中插入元素
	myVector.push_back(9);
	myVector.push_back(5);
	myVector.push_back(2);
	myVector.push_back(7);
	myVector.push_back(2);

	// 向 foreach 循环中传入 Lambda 表达式
	auto PE1 = PrintElement();
	auto PE2 = for_each(myVector.begin(), myVector.end(), PE1);
	cout << endl;

	PE1.printCount();
	PE2.printCount();

	// 控制台暂停 , 按任意键继续向后执行
	system("pause");
	return 0;
};

执行结果 :

0. 9 , 1. 5 , 2. 2 , 3. 7 , 4. 2 ,
count = 0
count = 5
请按任意键继续. . .

本文参与?腾讯云自媒体分享计划，分享自作者个人站点/博客。

原始发表：2024-01-13，如有侵权请联系 cloudcommunity@tencent.com 删除

源码分析

本文分享自作者个人站点/博客?前往查看

如有侵权，请联系 cloudcommunity@tencent.com 删除。

本文参与?腾讯云自媒体分享计划? ，欢迎热爱写作的你一起参与！

登录后参与评论

0 条评论

热度