Boost C++ Libraries

...one of the most highly regarded and expertly designed C++ library projects in the world. Herb Sutter and Andrei Alexandrescu, C++ Coding Standards

Click here to view the latest version of this page.
C++ Boost

const_associative_property_map<UniquePairAssociativeContainer>

This property map is an adaptor that converts any type that is a model of both Pair Associative Container and Unique Associative Container such as std::map into a constant Lvalue Property Map. Note that the adaptor only retains a reference to the container, so the lifetime of the container must encompass the use of the adaptor.

Example

example1.cpp:
#include <iostream>
#include <map>
#include <string>
#include <boost/property_map/property_map.hpp>


template <typename ConstAddressMap>
void display(ConstAddressMap address)
{
  typedef typename boost::property_traits<ConstAddressMap>::value_type
    value_type;
  typedef typename boost::property_traits<ConstAddressMap>::key_type key_type;

  key_type fred = "Fred";
  key_type joe = "Joe";

  value_type freds_address = get(address, fred);
  value_type joes_address = get(address, joe);
  
  std::cout << fred << ": " << freds_address << "\n"
	    << joe  << ": " << joes_address  << "\n";
}

int
main()
{
  std::map<std::string, std::string> name2address;
  boost::const_associative_property_map< std::map<std::string, std::string> >
    address_map(name2address);

  name2address.insert(make_pair(std::string("Fred"), 
				std::string("710 West 13th Street")));
  name2address.insert(make_pair(std::string("Joe"), 
				std::string("710 West 13th Street")));

  display(address_map);
  
  return EXIT_SUCCESS;
}


Where Defined

boost/property_map/property_map.hpp

Model Of

Lvalue Property Map

Template Parameters

ParameterDescriptionDefault
UniquePairAssociativeContainer Must be a model of both Pair Associative Container and Unique Associative Container .  

Members

In addition to the methods and functions required by Lvalue Property Map, this class has the following members.


property_traits<const_associative_property_map>::value_type
This is the same type as UniquePairAssociativeContainer::data_type.
const_associative_property_map()
Default Constructor.
const_associative_property_map(const UniquePairAssociativeContainer& c)
Constructor.
const data_type& operator[](const key_type& k) const
The operator bracket for property access. The key_type and data_type types are from the typedefs inside of UniquePairAssociativeContainer.

Non-Member functions


  template <typename UniquePairAssociativeContainer>
  const_associative_property_map<UniquePairAssociativeContainer>
  make_assoc_property_map(const UniquePairAssociativeContainer& c);
A function for conveniently creating an associative property map.


Copyright © 2002 Jeremy Siek, Indiana University (jsiek@osl.iu.edu)
Lie-Quan Lee, Indiana University (llee1@osl.iu.edu)
Andrew Lumsdaine, Indiana University (lums@osl.iu.edu)