Re: [Boost-users] [MultiIndex] documentation for macros

Subject: Re: [Boost-users] [MultiIndex] documentation for macros
From: joaquin_at_[hidden]
Date: 2009-09-24 08:40:01

Igor R escribió:
> Hello,
>
> Is there any description of the various macros that control MI
> behavior, like BOOST_MULTI_INDEX_ENABLE_SAFE_MODE etc.?
> I tried to search through the library reference, but haven't managed
> to find any.
>   

These macros are not documented in the reference for a very academic reason,
they're details of this particular implementation rather than part of 
the public
interface --this is admittedly a little too picky, maybe.

The macros are documented through the tutorial, though. For your reference:

BOOST_MULTI_INDEX_ENABLE_SAFE_MODE
BOOST_MULTI_INDEX_SAFE_MODE_ASSERT
  http://www.boost.org/libs/multi_index/doc/tutorial/debug.html#safe_mode

BOOST_MULTI_INDEX_ENABLE_INVARIANT_CHECKING
BOOST_MULTI_INDEX_INVARIANT_ASSERT
  
http://www.boost.org/libs/multi_index/doc/tutorial/debug.html#invariant_check

BOOST_MULTI_INDEX_DISABLE_SERIALIZATION
  
http://www.boost.org/libs/multi_index/doc/tutorial/creation.html#serialization

BOOST_MULTI_INDEX_DISABLE_COMPRESSED_ORDERED_INDEX_NODES
  
http://www.boost.org/libs/multi_index/doc/tutorial/indices.html#ordered_node_compression

BOOST_MULTI_INDEX_LIMIT_INDEXED_BY_SIZE
BOOST_MULTI_INDEX_LIMIT_TAG_SIZE
  
http://www.boost.org/libs/multi_index/doc/compiler_specifics.html#symbol_reduction

HTH,

Joaquín M López Muñoz
Telefónica, Investigación y Desarrollo