Header <boost/compressed_pair.hpp>

All of the contents of <boost/compressed_pair.hpp> are defined inside namespace boost.

The class compressed pair is very similar to std::pair, but if either of the template arguments are empty classes, then the "empty member optimisation" is applied to compress the size of the pair.

template <class T1, class T2>
class compressed_pair
{
public:
	typedef T1                                                 first_type;
	typedef T2                                                 second_type;
	typedef typename call_traits<first_type>::param_type       first_param_type;
	typedef typename call_traits<second_type>::param_type      second_param_type;
	typedef typename call_traits<first_type>::reference        first_reference;
	typedef typename call_traits<second_type>::reference       second_reference;
	typedef typename call_traits<first_type>::const_reference  first_const_reference;
	typedef typename call_traits<second_type>::const_reference second_const_reference;

	         compressed_pair() : base() {}
	         compressed_pair(first_param_type x, second_param_type y);
	explicit compressed_pair(first_param_type x);
	explicit compressed_pair(second_param_type y);

	first_reference       first();
	first_const_reference first() const;

	second_reference       second();
	second_const_reference second() const;

	void swap(compressed_pair& y);
};

The two members of the pair can be accessed using the member functions first() and second(). Note that not all member functions can be instantiated for all template parameter types. In particular compressed_pair can be instantiated for reference and array types, however in these cases the range of constructors that can be used are limited. If types T1 and T2 are the same type, then there is only one version of the single-argument constructor, and this constructor initialises both values in the pair to the passed value.

Note that compressed_pair can not be instantiated if either of the template arguments is an enumerator type, unless there is compiler support for boost::is_enum, or if boost::is_enum is specialised for the enumerator type.

Finally, compressed_pair requires compiler support for partial specialisation of class templates - without that support compressed_pair behaves just like std::pair.

Revised 08 March 2000

© Copyright boost.org 2000. Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose.

Based on contributions by Steve Cleary, Beman Dawes, Howard Hinnant and John Maddock.

Maintained by John Maddock, the latest version of this file can be found at www.boost.org, and the boost discussion list at www.egroups.com/list/boost.