<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>RAUL: Table.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>Table.hpp</h1> </div>
</div>
<div class="contents">
<div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* This file is part of Raul.</span>
<a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2007-2009 David Robillard <http://drobilla.net></span>
<a name="l00003"></a>00003 <span class="comment"> *</span>
<a name="l00004"></a>00004 <span class="comment"> * Raul is free software; you can redistribute it and/or modify it under the</span>
<a name="l00005"></a>00005 <span class="comment"> * terms of the GNU General Public License as published by the Free Software</span>
<a name="l00006"></a>00006 <span class="comment"> * Foundation; either version 2 of the License, or (at your option) any later</span>
<a name="l00007"></a>00007 <span class="comment"> * version.</span>
<a name="l00008"></a>00008 <span class="comment"> *</span>
<a name="l00009"></a>00009 <span class="comment"> * Raul is distributed in the hope that it will be useful, but WITHOUT ANY</span>
<a name="l00010"></a>00010 <span class="comment"> * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
<a name="l00011"></a>00011 <span class="comment"> * FOR A PARTICULAR PURPOSE. See the GNU General Public License for details.</span>
<a name="l00012"></a>00012 <span class="comment"> *</span>
<a name="l00013"></a>00013 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
<a name="l00014"></a>00014 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
<a name="l00015"></a>00015 <span class="comment"> * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA</span>
<a name="l00016"></a>00016 <span class="comment"> */</span>
<a name="l00017"></a>00017
<a name="l00018"></a>00018 <span class="preprocessor">#ifndef RAUL_TABLE_HPP</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span><span class="preprocessor">#define RAUL_TABLE_HPP</span>
<a name="l00020"></a>00020 <span class="preprocessor"></span>
<a name="l00021"></a>00021 <span class="preprocessor">#include <vector></span>
<a name="l00022"></a>00022 <span class="preprocessor">#include <algorithm></span>
<a name="l00023"></a>00023 <span class="preprocessor">#include <boost/utility.hpp></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "SharedPtr.hpp"</span>
<a name="l00025"></a>00025
<a name="l00026"></a>00026 <span class="comment">//#define TABLE_SORT_DEBUG</span>
<a name="l00027"></a>00027
<a name="l00028"></a>00028 <span class="keyword">namespace </span>Raul {
<a name="l00029"></a>00029
<a name="l00030"></a>00030
<a name="l00037"></a>00037 <span class="keyword">template</span> <<span class="keyword">typename</span> K, <span class="keyword">typename</span> T>
<a name="l00038"></a>00038 <span class="keyword">class </span>Table : <span class="keyword">public</span> boost::noncopyable {
<a name="l00039"></a>00039 <span class="keyword">public</span>:
<a name="l00040"></a>00040 Table<K, T>() : _entries() {}
<a name="l00041"></a>00041 Table<K, T>(<span class="keywordtype">size_t</span> capacity) : _entries(capacity) {}
<a name="l00042"></a>00042
<a name="l00043"></a>00043 <span class="keywordtype">void</span> clear() { _entries.clear(); }
<a name="l00044"></a>00044 <span class="keywordtype">bool</span> empty()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _entries.empty(); }
<a name="l00045"></a>00045 <span class="keywordtype">void</span> reserve(<span class="keywordtype">size_t</span> n) { _entries.reserve(n); }
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">struct </span>const_iterator {
<a name="l00048"></a>00048 const_iterator(<span class="keyword">const</span> Table<K,T>& t, <span class="keywordtype">size_t</span> i) : _table(&t), _index(i) {}
<a name="l00049"></a>00049 <span class="keyword">inline</span> <span class="keyword">const</span> std::pair<const K, T> operator*()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _table->_entries[_index]; }
<a name="l00050"></a>00050 <span class="keyword">inline</span> <span class="keyword">const</span> std::pair<const K, T>* operator->()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (std::pair<const K, T>*)&_table->_entries[_index]; }
<a name="l00051"></a>00051 <span class="keyword">inline</span> const_iterator& operator++() { ++_index; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00052"></a>00052 <span class="keyword">inline</span> const_iterator& operator--() { --_index; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00053"></a>00053 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> const_iterator& i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _index == i._index; }
<a name="l00054"></a>00054 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> const_iterator& i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _index != i._index; }
<a name="l00055"></a>00055 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> const_iterator& i) { _table = i._table; _index = i._index; }
<a name="l00056"></a>00056 <span class="keyword">private</span>:
<a name="l00057"></a>00057 <span class="keyword">friend</span> <span class="keyword">class </span>Table<K,T>;
<a name="l00058"></a>00058 <span class="keyword">const</span> Table<K,T>* _table;
<a name="l00059"></a>00059 <span class="keywordtype">size_t</span> _index;
<a name="l00060"></a>00060 };
<a name="l00061"></a>00061
<a name="l00062"></a>00062 <span class="keyword">struct </span>iterator {
<a name="l00063"></a>00063 iterator(Table<K,T>& t, <span class="keywordtype">size_t</span> i) : _table(&t), _index(i) {}
<a name="l00064"></a>00064 <span class="keyword">inline</span> std::pair<K, T>& operator*()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (std::pair<K, T>&)_table->_entries[_index]; }
<a name="l00065"></a>00065 <span class="keyword">inline</span> std::pair<K, T>* operator->()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> (std::pair<K, T>*)&_table->_entries[_index]; }
<a name="l00066"></a>00066 <span class="keyword">inline</span> iterator& operator++() { ++_index; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00067"></a>00067 <span class="keyword">inline</span> iterator& operator--() { --_index; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00068"></a>00068 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> iterator& i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _index == i._index; }
<a name="l00069"></a>00069 <span class="keyword">inline</span> <span class="keywordtype">bool</span> operator!=(<span class="keyword">const</span> iterator& i)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _index != i._index; }
<a name="l00070"></a>00070 operator const_iterator() { <span class="keywordflow">return</span> *(const_iterator*)<span class="keyword">this</span>; }
<a name="l00071"></a>00071 iterator& operator=(<span class="keyword">const</span> iterator& i) { _table = i._table; _index = i._index; <span class="keywordflow">return</span> *<span class="keyword">this</span>; }
<a name="l00072"></a>00072 <span class="keyword">private</span>:
<a name="l00073"></a>00073 <span class="keyword">friend</span> <span class="keyword">class </span>Table<K,T>;
<a name="l00074"></a>00074 Table<K,T>* _table;
<a name="l00075"></a>00075 <span class="keywordtype">size_t</span> _index;
<a name="l00076"></a>00076 };
<a name="l00077"></a>00077
<a name="l00078"></a>00078 <span class="keyword">inline</span> <span class="keywordtype">size_t</span> size()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> _entries.size(); }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 std::pair<iterator,bool> <a class="code" href="classRaul_1_1Table.html#a31e420e7176789d39f88fc391e5144cd" title="Add an item to the table, using entry.first as the search key.">insert</a>(<span class="keyword">const</span> std::pair<K, T>& entry);
<a name="l00081"></a>00081
<a name="l00082"></a>00082 <span class="keywordtype">void</span> erase(<span class="keyword">const</span> K& key);
<a name="l00083"></a>00083 <span class="keywordtype">void</span> erase(iterator i);
<a name="l00084"></a>00084 <span class="keywordtype">void</span> erase(iterator start, iterator end);
<a name="l00085"></a>00085 <span class="keywordtype">void</span> <a class="code" href="classRaul_1_1Table.html#a1bc42977f8be398f35527a77614a9250" title="Erase a range of elements from first_index to last_index, including first_index but not including las...">erase_by_index</a>(<span class="keywordtype">size_t</span> start, <span class="keywordtype">size_t</span> end);
<a name="l00086"></a>00086
<a name="l00087"></a>00087 SharedPtr< Table<K, T> > <a class="code" href="classRaul_1_1Table.html#a4d2e5cc4364c35ff35e5f0d2e1704822" title="Erase and return a range of entries.">yank</a>(iterator start, iterator end);
<a name="l00088"></a>00088
<a name="l00089"></a>00089 std::pair<iterator, bool> <a class="code" href="classRaul_1_1Table.html#ac163ceab6c10c10b69016fede580c888" title="Cram a range of entries back in.">cram</a>(<span class="keyword">const</span> Table<K, T>& range);
<a name="l00090"></a>00090
<a name="l00091"></a>00091 const_iterator <a class="code" href="classRaul_1_1Table.html#a9128fe7b2e9ef926e8de6dffb9962fa8" title="Binary search (O(log(end - start))).">find</a>(const_iterator start, const_iterator end, <span class="keyword">const</span> K& key) <span class="keyword">const</span>;
<a name="l00092"></a>00092 const_iterator <a class="code" href="classRaul_1_1Table.html#a9128fe7b2e9ef926e8de6dffb9962fa8" title="Binary search (O(log(end - start))).">find</a>(<span class="keyword">const</span> K& key) <span class="keyword">const</span>;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 iterator <a class="code" href="classRaul_1_1Table.html#a9128fe7b2e9ef926e8de6dffb9962fa8" title="Binary search (O(log(end - start))).">find</a>(const_iterator start, const_iterator end, <span class="keyword">const</span> K& key);
<a name="l00095"></a>00095 iterator <a class="code" href="classRaul_1_1Table.html#a9128fe7b2e9ef926e8de6dffb9962fa8" title="Binary search (O(log(end - start))).">find</a>(<span class="keyword">const</span> K& key);
<a name="l00096"></a>00096
<a name="l00097"></a>00097 const_iterator <a class="code" href="classRaul_1_1Table.html#a36c21ad901a72be1c94391660cd696d1" title="Find the end of a range using a custom comparator.">find_range_end</a>(const_iterator left, <span class="keywordtype">bool</span> (*comp)(<span class="keyword">const</span> K&,<span class="keyword">const</span> K&)) <span class="keyword">const</span>;
<a name="l00098"></a>00098 iterator <a class="code" href="classRaul_1_1Table.html#a36c21ad901a72be1c94391660cd696d1" title="Find the end of a range using a custom comparator.">find_range_end</a>(iterator left, <span class="keywordtype">bool</span> (*comp)(<span class="keyword">const</span> K&,<span class="keyword">const</span> K&));
<a name="l00099"></a>00099
<a name="l00100"></a>00100 T& <a class="code" href="classRaul_1_1Table.html#ac1a5714461807b88759f4e94cf538d22" title="Insert an item, and return a reference to it&#39;s value.">operator[]</a>(<span class="keyword">const</span> K& key);
<a name="l00101"></a>00101
<a name="l00102"></a>00102 const_iterator begin()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> const_iterator(*<span class="keyword">this</span>, 0); }
<a name="l00103"></a>00103 const_iterator end()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> const_iterator(*<span class="keyword">this</span>, size()); }
<a name="l00104"></a>00104 iterator begin() { <span class="keywordflow">return</span> iterator(*<span class="keyword">this</span>, 0); }
<a name="l00105"></a>00105 iterator end() { <span class="keywordflow">return</span> iterator(*<span class="keyword">this</span>, size()); }
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">private</span>:
<a name="l00108"></a>00108 <span class="preprocessor">#ifdef TABLE_SORT_DEBUG</span>
<a name="l00109"></a>00109 <span class="preprocessor"></span> <span class="keywordtype">bool</span> is_sorted() <span class="keyword">const</span>;
<a name="l00110"></a>00110 <span class="preprocessor">#endif</span>
<a name="l00111"></a>00111 <span class="preprocessor"></span>
<a name="l00112"></a>00112 <span class="keyword">friend</span> <span class="keyword">class </span>iterator;
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keyword">typedef</span> std::pair<K, T> Entry;
<a name="l00115"></a>00115
<a name="l00116"></a>00116 std::vector<Entry> _entries;
<a name="l00117"></a>00117 };
<a name="l00118"></a>00118
<a name="l00119"></a>00119
<a name="l00120"></a>00120 } <span class="comment">// namespace Raul</span>
<a name="l00121"></a>00121
<a name="l00122"></a>00122 <span class="preprocessor">#endif // RAUL_TABLE_HPP</span>
</pre></div></div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
76
