關聯容器之set · STL源碼剖析

### 前言 ? 在SGI STL中的容器set，其實現基本上是在RB-Tree的基礎上，把RB-Tree作為其底層的實現機制，是因為set的操作RB-Tree都能實現，有關RB-Tree的剖析請看《[STL源碼剖析——RB-Tree(紅黑樹)](http://blog.csdn.net/chenhanzhun/article/details/39523519)》。在set容器鍵值key和實值value是相同的，且在容器里面的元素是根據元素的鍵值自動排序的，同時我們不能修改set容器里面的元素值，所以set的迭代器是采用RB-Tree的const_iterator，不允許用戶對其進行修改操作。本文的源碼出自SGI STL中的<stl_set.h>文件。 ### set容器源碼剖析 ~~~ #ifndef __SGI_STL_INTERNAL_SET_H #define __SGI_STL_INTERNAL_SET_H #include <concept_checks.h> __STL_BEGIN_NAMESPACE #if defined(__sgi) && !defined(__GNUC__) && (_MIPS_SIM != _MIPS_SIM_ABI32) #pragma set woff 1174 #pragma set woff 1375 #endif //set內部元素默認使用遞增排序less //用戶可自行制定比較類型 //內部維護的數據結構是紅黑樹, 具有非常優秀的最壞情況的時間復雜度 //注意: set鍵值和實值是相同的,set內不允許重復元素的存在, 如果插入重復元素,則會忽略插入操作 //且不能通過迭代器修改set的元素值,其迭代器類型是定義為RB-Tree的const_iterator // Forward declarations of operators < and ==, needed for friend declaration. template <class _Key, class _Compare __STL_DEPENDENT_DEFAULT_TMPL(less<_Key>), class _Alloc = __STL_DEFAULT_ALLOCATOR(_Key) > class set; template <class _Key, class _Compare, class _Alloc> inline bool operator==(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y); template <class _Key, class _Compare, class _Alloc> inline bool operator<(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y); template <class _Key, class _Compare, class _Alloc> class set { // requirements: __STL_CLASS_REQUIRES(_Key, _Assignable); __STL_CLASS_BINARY_FUNCTION_CHECK(_Compare, bool, _Key, _Key); public: // typedefs: //在set中key就是value, value同時也是key typedef _Key key_type; typedef _Key value_type; //注意：以下key_compare和value_compare使用相同的比較函數 typedef _Compare key_compare; typedef _Compare value_compare; private: //set的底層機制是采用RB-Tree數據結構，在<stl_tree.h>實現 typedef _Rb_tree<key_type, value_type, _Identity<value_type>, key_compare, _Alloc> _Rep_type; _Rep_type _M_t; // red-black tree representing set public: typedef typename _Rep_type::const_pointer pointer; typedef typename _Rep_type::const_pointer const_pointer; typedef typename _Rep_type::const_reference reference; typedef typename _Rep_type::const_reference const_reference; //set的迭代器iterator 定義為RB-Tree的const_iterator，不允許用戶通過迭代器修改set的元素值 //因為set的元素有一定次序安排，修改其值會破壞排序規則 typedef typename _Rep_type::const_iterator iterator; typedef typename _Rep_type::const_iterator const_iterator; typedef typename _Rep_type::const_reverse_iterator reverse_iterator; typedef typename _Rep_type::const_reverse_iterator const_reverse_iterator; typedef typename _Rep_type::size_type size_type; typedef typename _Rep_type::difference_type difference_type; typedef typename _Rep_type::allocator_type allocator_type; // allocation/deallocation // set只能使用RB-tree的insert-unique(),不能使用insert-equal() //當要插入鍵值和已經存在的鍵值相同時，就會被忽略 /*構造函數原型 set(); explicit set (const key_compare& comp = key_compare(), const allocator_type& alloc = allocator_type()); template <class InputIterator> set (InputIterator first, InputIterator last, const key_compare& comp = key_compare(), const allocator_type& alloc = allocator_type()); set (const set& x); */ set() : _M_t(_Compare(), allocator_type()) {} explicit set(const _Compare& __comp, const allocator_type& __a = allocator_type()) : _M_t(__comp, __a) {} #ifdef __STL_MEMBER_TEMPLATES template <class _InputIterator> set(_InputIterator __first, _InputIterator __last) : _M_t(_Compare(), allocator_type()) { _M_t.insert_unique(__first, __last); } template <class _InputIterator> set(_InputIterator __first, _InputIterator __last, const _Compare& __comp, const allocator_type& __a = allocator_type()) : _M_t(__comp, __a) { _M_t.insert_unique(__first, __last); } #else set(const value_type* __first, const value_type* __last) : _M_t(_Compare(), allocator_type()) { _M_t.insert_unique(__first, __last); } set(const value_type* __first, const value_type* __last, const _Compare& __comp, const allocator_type& __a = allocator_type()) : _M_t(__comp, __a) { _M_t.insert_unique(__first, __last); } set(const_iterator __first, const_iterator __last) : _M_t(_Compare(), allocator_type()) { _M_t.insert_unique(__first, __last); } set(const_iterator __first, const_iterator __last, const _Compare& __comp, const allocator_type& __a = allocator_type()) : _M_t(__comp, __a) { _M_t.insert_unique(__first, __last); } #endif /* __STL_MEMBER_TEMPLATES */ set(const set<_Key,_Compare,_Alloc>& __x) : _M_t(__x._M_t) {} set<_Key,_Compare,_Alloc>& operator=(const set<_Key, _Compare, _Alloc>& __x) { _M_t = __x._M_t;//調用了底層紅黑樹的operator=操作函數 return *this; } //以下所有的set操作行為，RB-tree都已提供，所以set只要調用即可 // accessors: //返回用于key比較的函數,調用RB-Tree的key_comp() key_compare key_comp() const { return _M_t.key_comp(); } //由于set的性質, value和key使用同一個比較函數 value_compare value_comp() const { return _M_t.key_comp(); } //獲取分配器類型 allocator_type get_allocator() const { return _M_t.get_allocator(); } //以下是一些set的基本迭代器所指位置 iterator begin() const { return _M_t.begin(); } iterator end() const { return _M_t.end(); } reverse_iterator rbegin() const { return _M_t.rbegin(); } reverse_iterator rend() const { return _M_t.rend(); } //以下的函數都是調用了RB-Tree的實現,set不必自己定義 bool empty() const { return _M_t.empty(); } size_type size() const { return _M_t.size(); } size_type max_size() const { return _M_t.max_size(); } //這里調用的swap()函數是專屬于RB-Tree的swap()，并不是STL的swap()算法 void swap(set<_Key,_Compare,_Alloc>& __x) { _M_t.swap(__x._M_t); } // insert/erase // 根據返回值的情況，判斷是否插入該元素 //pair.second為true則表示已插入該元素 //為false則表示set中已存在與待插入相同的元素, 不會重復插入 pair<iterator,bool> insert(const value_type& __x) { pair<typename _Rep_type::iterator, bool> __p = _M_t.insert_unique(__x); return pair<iterator, bool>(__p.first, __p.second); } //在指定位置插入元素，但是會先遍歷該集合,判斷是否存在相同元素 //若不存在才在指定位置插入該元素 iterator insert(iterator __position, const value_type& __x) { typedef typename _Rep_type::iterator _Rep_iterator; return _M_t.insert_unique((_Rep_iterator&)__position, __x); } #ifdef __STL_MEMBER_TEMPLATES template <class _InputIterator> void insert(_InputIterator __first, _InputIterator __last) { _M_t.insert_unique(__first, __last); } #else void insert(const_iterator __first, const_iterator __last) { _M_t.insert_unique(__first, __last); } void insert(const value_type* __first, const value_type* __last) { _M_t.insert_unique(__first, __last); } #endif /* __STL_MEMBER_TEMPLATES */ //擦除指定位置的元素 void erase(iterator __position) { typedef typename _Rep_type::iterator _Rep_iterator; _M_t.erase((_Rep_iterator&)__position); } //擦除元素值為x的節點 size_type erase(const key_type& __x) { return _M_t.erase(__x); } //擦除指定區間的節點 void erase(iterator __first, iterator __last) { typedef typename _Rep_type::iterator _Rep_iterator; _M_t.erase((_Rep_iterator&)__first, (_Rep_iterator&)__last); } //清除set void clear() { _M_t.clear(); } // set operations: //查找元素值為x的節點 iterator find(const key_type& __x) const { return _M_t.find(__x); } //返回指定元素的個數 size_type count(const key_type& __x) const { return _M_t.find(__x) == _M_t.end() ? 0 : 1; } //返回不小于當前元素的第一個可插入的位置 iterator lower_bound(const key_type& __x) const { return _M_t.lower_bound(__x); } // 返回大于當前元素的第一個可插入的位置 iterator upper_bound(const key_type& __x) const { return _M_t.upper_bound(__x); } pair<iterator,iterator> equal_range(const key_type& __x) const { return _M_t.equal_range(__x); } #ifdef __STL_TEMPLATE_FRIENDS template <class _K1, class _C1, class _A1> friend bool operator== (const set<_K1,_C1,_A1>&, const set<_K1,_C1,_A1>&); template <class _K1, class _C1, class _A1> friend bool operator< (const set<_K1,_C1,_A1>&, const set<_K1,_C1,_A1>&); #else /* __STL_TEMPLATE_FRIENDS */ friend bool __STD_QUALIFIER operator== __STL_NULL_TMPL_ARGS (const set&, const set&); friend bool __STD_QUALIFIER operator< __STL_NULL_TMPL_ARGS (const set&, const set&); #endif /* __STL_TEMPLATE_FRIENDS */ }; template <class _Key, class _Compare, class _Alloc> inline bool operator==(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return __x._M_t == __y._M_t; } template <class _Key, class _Compare, class _Alloc> inline bool operator<(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return __x._M_t < __y._M_t; } #ifdef __STL_FUNCTION_TMPL_PARTIAL_ORDER template <class _Key, class _Compare, class _Alloc> inline bool operator!=(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return !(__x == __y); } template <class _Key, class _Compare, class _Alloc> inline bool operator>(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return __y < __x; } template <class _Key, class _Compare, class _Alloc> inline bool operator<=(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return !(__y < __x); } template <class _Key, class _Compare, class _Alloc> inline bool operator>=(const set<_Key,_Compare,_Alloc>& __x, const set<_Key,_Compare,_Alloc>& __y) { return !(__x < __y); } template <class _Key, class _Compare, class _Alloc> inline void swap(set<_Key,_Compare,_Alloc>& __x, set<_Key,_Compare,_Alloc>& __y) { __x.swap(__y); } #endif /* __STL_FUNCTION_TMPL_PARTIAL_ORDER */ #if defined(__sgi) && !defined(__GNUC__) && (_MIPS_SIM != _MIPS_SIM_ABI32) #pragma reset woff 1174 #pragma reset woff 1375 #endif __STL_END_NAMESPACE #endif /* __SGI_STL_INTERNAL_SET_H */ // Local Variables: // mode:C++ // End: ~~~ 參考資料：《STL源碼剖析》侯捷《[STL源碼剖析-- stl_set.h](http://blog.csdn.net/mdl13412/article/details/6655579)》