Chapter 42. Boost.Ref

The library Boost.Ref provides two functions, boost::ref() and boost::cref(), in the header file boost/ref.hpp. They are useful if you use, for example, std::bind() for a function which expects parameters by reference. Because std::bind() takes parameters by value, you have to deal with references explicitly.

Boost.Ref was added to the standard library in C++11, where you will find the functions std::ref() and std::cref() in the header file functional.

Example 42.1. Using boost::ref()

  1. #include <boost/ref.hpp>
  2. #include <vector>
  3. #include <algorithm>
  4. #include <functional>
  5. #include <iostream>
  7. void print(std::ostream &os, int i)
  8. {
  9.   os << i << std::endl;
  10. }
  12. int main()
  13. {
  14.   std::vector<int> v{1, 3, 2};
  15.   std::for_each(v.begin(), v.end(),
  16.     std::bind(print, boost::ref(std::cout), std::placeholders::_1));
  17. }

In Example 42.1, the function print() is passed to std::foreach() to write the numbers in _v to an output stream. Because print() expects two parameters – an output stream and the number to be written – std::bind() is used. The first parameter passed to print() through std::bind() is std::cout. However, print() expects a reference to an output stream, while std::bind() passes parameters by value. Therefore, boost::ref() is used to wrap std::cout. boost::ref() returns a proxy object that contains a reference to the object passed to it. This makes it possible to pass a reference to std::cout even though std::bind() takes all parameters by value.

The function template boost::cref() lets you pass a const reference.