Consider this snippet of code that we introduced in lesson 18.3 -- Introduction to standard library algorithms:
#include #include #include #include // Our function will return true if the element matches bool containsNut(std::string_view str) < // std::string_view::find returns std::string_view::npos if it doesn't find // the substring. Otherwise it returns the index where the substring occurs // in str. return str.find("nut") != std::string_view::npos; >int main() < constexpr std::arrayarr< "apple", "banana", "walnut", "lemon" >; // Scan our array to see if any elements contain the "nut" substring auto found< std::find_if(arr.begin(), arr.end(), containsNut) >; if (found == arr.end()) < std::cout else < std::cout return 0; >This code searches through an array of strings looking for the first element that contains the substring “nut”. Thus, it produces the result:
Found walnut
And while it works, it could be improved.
The root of the issue here is that std::find_if requires that we pass it a function pointer. Because of that, we are forced to define a function that’s only going to be used once, that must be given a name, and that must be put in the global scope (because functions can’t be nested!). The function is also so short, it’s almost easier to discern what it does from the one line of code than from the name and comments.
Lambdas are anonymous functions
A lambda expression (also called a lambda or closure) allows us to define an anonymous function inside another function. The nesting is important, as it allows us both to avoid namespace naming pollution, and to define the function as close to where it is used as possible (providing additional context).
The syntax for lambdas is one of the weirder things in C++, and takes a bit of getting used to. Lambdas take the form:
[ captureClause ] ( parameters ) -> returnTypeAlso note that lambdas (being anonymous) have no name, so we don’t need to provide one.
This means a trivial lambda definition looks like this:
#include int main() < [] <>; // a lambda with an omitted return type, no captures, and omitted parameters. return 0; >Let’s rewrite the above example using a lambda:
#include #include #include #include int main() < constexpr std::arrayarr< "apple", "banana", "walnut", "lemon" >; // Define the function right where we use it. auto found< std::find_if(arr.begin(), arr.end(), [](std::string_view str) // here's our lambda, no capture clause < return str.find("nut") != std::string_view::npos; >) >; if (found == arr.end()) < std::cout else < std::cout return 0; >This works just like the function pointer case, and produces an identical result:
Found walnut
Note how similar our lambda is to our containsNut function. They both have identical parameters and function bodies. The lambda has no capture clause (we’ll explain what a capture clause is in the next lesson) because it doesn’t need one. And we’ve omitted the trailing return type in the lambda (for conciseness), but since operator!= returns a bool , our lambda will return a bool too.
Following the best practice of defining things in the smallest scope and closest to first use, lambdas are preferred over normal functions when we need a trivial, one-off function to pass as an argument to some other function.
Type of a lambda
In the above example, we defined a lambda right where it was needed. This use of a lambda is sometimes called a function literal.
However, writing a lambda in the same line as it’s used can sometimes make code harder to read. Much like we can initialize a variable with a literal value (or a function pointer) for use later, we can also initialize a lambda variable with a lambda definition and then use it later. A named lambda along with a good function name can make code easier to read.
For example, in the following snippet, we’re using std::all_of to check if all elements of an array are even:
// Bad: We have to read the lambda to understand what's happening. return std::all_of(array.begin(), array.end(), [](int i)< return ((i % 2) == 0); >);We can improve the readability of this as follows:
// Good: Instead, we can store the lambda in a named variable and pass it to the function. auto isEven < [](int i) < return (i % 2) == 0; >>; return std::all_of(array.begin(), array.end(), isEven);Note how well the last line reads: “return whether all of the elements in the array are even”
Storing a lambda in a variable provides a way for us to give the lambda a useful name, which can help make our code more readable.
Storing a lambda in a variable also provides us with a way to use that lambda more than once.
But what is the type of lambda isEven ?
As it turns out, lambdas don’t have a type that we can explicitly use. When we write a lambda, the compiler generates a unique type just for the lambda that is not exposed to us.
For advanced readers
In actuality, lambdas aren’t functions (which is part of how they avoid the limitation of C++ not supporting nested functions). They’re a special kind of object called a functor. Functors are objects that contain an overloaded operator() that make them callable like a function.
Although we don’t know the type of a lambda, there are several ways of storing a lambda for use post-definition. If the lambda has an empty capture clause (nothing between the hard brackets []), we can use a regular function pointer. std::function or type deduction via the auto keyword will also work (even if the lambda has a non-empty capture clause).
#include int main() < // A regular function pointer. Only works with an empty capture clause (empty []). double (*addNumbers1)(double, double)< [](double a, double b) < return a + b; >>; addNumbers1(1, 2); // Using std::function. The lambda could have a non-empty capture clause (discussed next lesson). std::function addNumbers2 < // note: pre-C++17, use std::functioninstead [](double a, double b) < return a + b; >>; addNumbers2(3, 4); // Using auto. Stores the lambda with its real type. auto addNumbers3 < [](double a, double b) < return a + b; >>; addNumbers3(5, 6); return 0; > The only way of using the lambda’s actual type is by means of auto . auto also has the benefit of having no overhead compared to std::function .
What if we want to pass a lambda to a function? There are 4 options:
#include #include // Case 1: use a `std::function` parameter void repeat1(int repetitions, const std::function& fn) < for (int i< 0 >; i < repetitions; ++i) fn(i); >// Case 2: use a function template with a type template parameter template void repeat2(int repetitions, const T& fn) < for (int i< 0 >; i < repetitions; ++i) fn(i); >// Case 3: use the abbreviated function template syntax (C++20) void repeat3(int repetitions, const auto& fn) < for (int i< 0 >; i < repetitions; ++i) fn(i); >// Case 4: use function pointer (only for lambda with no captures) void repeat4(int repetitions, void (*fn)(int)) < for (int i< 0 >; i < repetitions; ++i) fn(i); >int main() < auto lambda = [](int i) < std::cout ; repeat1(3, lambda); repeat2(3, lambda); repeat3(3, lambda); repeat4(3, lambda); return 0; >In case 1, our function parameter is a std::function . This is nice because we can explicitly see what the parameters and return type of the std::function are. However, this requires the lambda to be implicitly converted whenever the function is called, which adds some overhead. This method also has the benefit of being separable into a declaration (in a header) and a definition (in a .cpp file) if that’s desirable.
In case 2, we’re using a function template with type template parameter T . When the function is called, a function will be instantiated where T matches the actual type of the lambda. This is more efficient, but the parameters and return type of T are not obvious.
In case 3, we use C++20’s auto to invoke the abbreviated function template syntax. This generates a function template identical to case 2.
In case 4, the function parameter is a function pointer. Since a lambda with no captures will implicitly convert to a function pointer, we can pass a lambda with no captures to this function.
When storing a lambda in a variable, use auto as the variable’s type.
For the most part, lambda parameters work by the same rules as regular function parameters.
One notable exception is that since C++14 we’re allowed to use auto for parameters (note: in C++20, regular functions are able to use auto for parameters too). When a lambda has one or more auto parameter, the compiler will infer what parameter types are needed from the calls to the lambda.
Because lambdas with one or more auto parameter can potentially work with a wide variety of types, they are called generic lambdas.
For advanced readers
When used in the context of a lambda, auto is just a shorthand for a template parameter.
Let’s take a look at a generic lambda:
#include #include #include #include int main() < constexpr std::array months< // pre-C++17 use std::array"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" >; // Search for two consecutive months that start with the same letter. const auto sameLetter< std::adjacent_find(months.begin(), months.end(), [](const auto& a, const auto& b) < return a[0] == b[0]; >) >; // Make sure that two months were found. if (sameLetter != months.end()) < // std::next returns the next iterator after sameLetter std::cout return 0; >June and July start with the same letter
In the above example, we use auto parameters to capture our strings by const reference. Because all string types allow access to their individual characters via operator[] , we don’t need to care whether the user is passing in a std::string , C-style string, or something else. This allows us to write a lambda that could accept any of these, meaning if we change the type of months later, we won’t have to rewrite the lambda.
However, auto isn’t always the best choice. Consider:
#include #include #include #include int main() < constexpr std::array months< // pre-C++17 use std::array"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December" >; // Count how many months consist of 5 letters const auto fiveLetterMonths< std::count_if(months.begin(), months.end(), [](std::string_view str) < return str.length() == 5; >) >; std::cout
There are 2 months with 5 letters
In this example, using auto would infer a type of const char* . C-style strings aren’t easy to work with (apart from using operator[] ). In this case, we prefer to explicitly define the parameter as a std::string_view , which allows us to work with the underlying data much more easily (e.g. we can ask the string view for its length, even if the user passed in a C-style array).
As of C++17, lambdas are implicitly constexpr if the result satisfies the requirements of a constant expression. This generally requires two things:
In the above example, our lambda would not be implicitly constexpr in C++17 but it would be in C++20 (as std::count_if was made constexpr in C++20). This means in C++20 we can make fiveLetterMonths constexpr:
constexpr auto fiveLetterMonths< std::count_if(months.begin(), months.end(), [](std::string_view str) < return str.length() == 5; >) >;
Generic lambdas and static variables
In lesson 11.7 -- Function template instantiation, we discussed that when a function template contains a static local variable, each function instantiated from that template will receive its own independent static local variable. This may cause issues if that is not expected.
Generic lambdas work the same way: a unique lambda will be generated for each different type that auto resolves to.
The following example shows how one generic lambda turns into two distinct lambdas:
#include #include #include #include int main() < // Print a value and count how many times @print has been called. auto print< [](auto value) < static int callCount< 0 >; std::cout >; print("hello"); // 0: hello print("world"); // 1: world print(1); // 0: 1 print(2); // 1: 2 print("ding dong"); // 2: ding dong return 0; >0: hello 1: world 0: 1 1: 2 2: ding dong
In the above example, we define a lambda and then call it with two different parameters (a string literal parameter, and an integer parameter). This generates two different versions of the lambda (one with a string literal parameter, and one with an integer parameter).
Most of the time, this is inconsequential. However, note that if the generic lambda uses static duration variables, those variables are not shared between the generated lambdas.
We can see this in the example above, where each type (string literals and integers) has its own unique count! Although we only wrote the lambda once, two lambdas were generated -- and each has its own version of callCount . To have a shared counter between the two generated lambdas, we’d have to define a global variable or a static local variable outside of the lambda. As you know from previous lessons, both global- and static local variables can cause problems and make it more difficult to understand code. We’ll be able to avoid those variables after talking about lambda captures in the next lesson.
Return type deduction and trailing return types
If return type deduction is used, a lambda’s return type is deduced from the return -statements inside the lambda, and all return statements in the lambda must return the same type (otherwise the compiler won’t know which one to prefer).
#include int main() < auto divide< [](int x, int y, bool intDivision) < // note: no specified return type if (intDivision) return x / y; // return type is int else return static_cast(x) / y; // ERROR: return type doesn't match previous return type > >; std::cout
This produces a compile error because the return type of the first return statement (int) doesn’t match the return type of the second return statement (double).
The second case is usually the better choice:
#include int main() < // note: explicitly specifying this returns a double auto divide< [](int x, int y, bool intDivision) ->double < if (intDivision) return x / y; // will do an implicit conversion of result to double else return static_cast(x) / y; > >; std::cout
That way, if you ever decide to change the return type, you (usually) only need to change the lambda’s return type, and not touch the lambda body.
Standard library function objects
For common operations (e.g. addition, negation, or comparison) you don’t need to write your own lambdas, because the standard library comes with many basic callable objects that can be used instead. These are defined in the header.
In the following example:
#include #include #include bool greater(int a, int b) < // Order @a before @b if @a is greater than @b. return a >b; > int main() < std::array arr< 13, 90, 99, 5, 40, 80 >; // Pass greater to std::sort std::sort(arr.begin(), arr.end(), greater); for (int i : arr) < std::cout std::cout
99 90 80 40 13 5
Instead of converting our greater function to a lambda (which would obscure its meaning a bit), we can instead use std::greater :
#include #include #include #include // for std::greater int main() < std::array arr< 13, 90, 99, 5, 40, 80 >; // Pass std::greater to std::sort std::sort(arr.begin(), arr.end(), std::greater<>); // note: need curly braces to instantiate object for (int i : arr) < std::cout std::cout
99 90 80 40 13 5
Lambdas and the algorithm library may seem unnecessarily complicated when compared to a solution that uses a loop. However, this combination can allow some very powerful operations in just a few lines of code, and can be more readable than writing your own loops. On top of that, the algorithm library features powerful and easy-to-use parallelism, which you won’t get with loops. Upgrading source code that uses library functions is easier than upgrading code that uses loops.
Lambdas are great, but they don’t replace regular functions for all cases. Prefer regular functions for non-trivial and reusable cases.
Create a struct Student that stores the name and points of a student. Create an array of students and use std::max_element to find the student with the most points, then print that student’s name. std::max_element takes the begin and end of a list, and a function that takes 2 parameters and returns true if the first argument is less than the second.
Given the following array
std::array arr< < < "Albert", 3 >, < "Ben", 5 >, < "Christine", 2 >, < "Dan", 8 >, // Dan has the most points (8). < "Enchilada", 4 >, < "Francis", 1 >, < "Greg", 3 >, < "Hagrid", 5 >> >;your program should print
Dan is the best student
#include #include #include #include struct Student < std::string_view name<>; int points<>; >; int main() < constexpr std::arrayarr< < < "Albert", 3 >, < "Ben", 5 >, < "Christine", 2 >, < "Dan", 8 >, < "Enchilada", 4 >, < "Francis", 1 >, < "Greg", 3 >, < "Hagrid", 5 >> >; const auto best< std::max_element(arr.begin(), arr.end(), /* lambda */) // returns an iterator >; std::cout name #include #include #include #include struct Student < std::string_view name<>; int points<>; >; int main() < constexpr std::arrayarr< < < "Albert", 3 >, < "Ben", 5 >, < "Christine", 2 >, < "Dan", 8 >, < "Enchilada", 4 >, < "Francis", 1 >, < "Greg", 3 >, < "Hagrid", 5 >> >; const auto best < // returns an iterator std::max_element(arr.begin(), arr.end(), [](const auto& a, const auto& b) < return a.points < b.points; >) >; std::cout name Use std::sort and a lambda in the following code to sort the seasons by ascending average temperature.
#include #include #include #include struct Season < std::string_view name<>; double averageTemperature<>; >; int main() < std::arrayseasons< < < "Spring", 285.0 >, < "Summer", 296.0 >, < "Fall", 288.0 >, < "Winter", 263.0 >> >; /* * Use std::sort here */ for (const auto& season : seasons) < std::cout return 0; >The program should print
Winter Spring Fall Summer
#include #include #include #include struct Season < std::string_view name<>; double averageTemperature<>; >; int main() < std::arrayseasons< < < "Spring", 285.0 >, < "Summer", 296.0 >, < "Fall", 288.0 >, < "Winter", 263.0 >> >; // We can compare averageTemperature of the two arguments to // sort the array. std::sort(seasons.begin(), seasons.end(), [](const auto& a, const auto& b) < return a.averageTemperature < b.averageTemperature; >); for (const auto& season : seasons) < std::cout return 0; >