broom::map< Key, T, Compare, Allocator > Class Template Reference

#include <broom-map.h>

Inheritance diagram for broom::map< Key, T, Compare, Allocator >:

Collaboration diagram for broom::map< Key, T, Compare, Allocator >:

Public Member Functions
	map (std::initializer_list< std::pair< const Key, T > > il, const Compare &comp=Compare(), const Allocator &alloc=Allocator())
virtual void	Visit (Visitor *visitor) const
Public Member Functions inherited from broom::BroomValue
virtual	~BroomValue ()

Additional Inherited Members
Protected Member Functions inherited from broom::BroomValue
	BroomValue (GarbageCollector *gc)
	BroomValue ()
	BroomValue (const BroomValue &other)
BroomValue &	operator= (const BroomValue &other)
BroomValue &	operator= (BroomValue &&other) noexcept

Detailed Description

template<typename Key, typename T, typename Compare = std::less<Key>, typename Allocator = std::allocator<std::pair<const Key, T>>>
class broom::map< Key, T, Compare, Allocator >

A Broom wrapper for std::map. broom::map aims to cover all the cases where one might want to use a std::map, while still remaining safe in the context of garbage collection. Since std::map is not on the stack and won't be scanned automatically, any managed pointer in it will be garbage collected prematurely. broom::map aims to alleviate this concern by implementing it as a precise root. broom::map also supports the usage of managed pointers as keys. They will be scanned along with the values. broom::map is only available as an interface and you should never rely on its implementation details, as they may change.

Definition at line 30 of file broom-map.h.

Constructor & Destructor Documentation

map()

template<typename Key , typename T , typename Compare = std::less<Key>, typename Allocator = std::allocator<std::pair<const Key, T>>>

broom::map< Key, T, Compare, Allocator >::map ( std::initializer_list< std::pair< const Key, T > >  il, const Compare &  comp = Compare(), const Allocator &  alloc = Allocator()  )

inline

Definition at line 36 of file broom-map.h.

Member Function Documentation

Visit()

template<typename Key , typename T , typename Compare = std::less<Key>, typename Allocator = std::allocator<std::pair<const Key, T>>>

virtual void broom::map< Key, T, Compare, Allocator >::Visit ( Visitor *  visitor ) const

inlinevirtual

An abstract Visit() method that needs to be implemented by any class that inherits from this class. The Visit() method is expected to call the visitor's Visitor::Visit() method on any managed pointer member.

Parameters

visitor

The Visitor object that implements a Visitor::Visit() method.

Implements broom::BroomValue.

Definition at line 41 of file broom-map.h.

---

The documentation for this class was generated from the following file:

• include/broom-map.h