UT_Bimap.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * COMMENTS: A bi-directional map based on hboost::bimap.
 * 
 * Example usage:
 * 
 *     const auto theBimap = UT_Bimap<UT_StringHolder, int>({
 *         { "a", 1 },
 *         { "b", 2 },
 *         { "c", 3 }
 *     });
 *
 *     // If the string that you are searching for is not a UT_StringHolder, use
 *     // UTmakeUnsafeRef.
 *     const auto left_it = theBimap.left.find(UTmakeUnsafeRef("b"));
 *     if (left_it != theBimap.left.end())
 *         UTdebugPrintCd(green, left_it->first, left_it->second);
 *
 *     const auto right_it = theBimap.right.find(3);
 *     if (right_it != theBimap.right.end())
 *         UTdebugPrintCd(green, right_it->first, right_it->second);
 */

#ifndef __UT_Bimap__
#define __UT_Bimap__

#include <hboost/bimap.hpp>

template<class KeyTypeA, class KeyTypeB>
class UT_Bimap : public hboost::bimap<KeyTypeA, KeyTypeB>
{
public:
    explicit UT_Bimap(std::initializer_list<typename UT_Bimap<KeyTypeA, KeyTypeB>::value_type> list)
        : Base(list.begin(), list.end())
    {
    }

    using Base = hboost::bimap<KeyTypeA, KeyTypeB>;
    using Base::Base;
};

#endif // __UT_Bimap__