<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: csSet< T, Allocator > Class Template Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<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 class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>csSet< T, Allocator > Class Template Reference<br>
<small>
[<a class="el" href="group__util__containers.html">Containers</a>]</small>
</h1><!-- doxytag: class="csSet" -->This class implements a basic set for objects.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="set_8h-source.html">csutil/set.h</a>></code>
<p>
<p>
<a href="classcsSet-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="c13311a966ccf100a680c965323bfd16"></a><!-- doxytag: member="csSet::HashType" ref="c13311a966ccf100a680c965323bfd16" args="" -->
typedef <a class="el" href="classcsHash.html">csHash</a>< bool,<br>
T, Allocator > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#c13311a966ccf100a680c965323bfd16">HashType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#fe4c3dcd135ff9ae5ca5c5b965434fb7">Add</a> (const T &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object to this set. <a href="#fe4c3dcd135ff9ae5ca5c5b965434fb7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#b1551cc10ebf97fd75517879218ad30c">AddNoTest</a> (const T &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Add an object to this set. <a href="#b1551cc10ebf97fd75517879218ad30c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#c2d43d082a72a2b2aa26d15e112f6e68">Contains</a> (const T &object) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if an object is in this set. <a href="#c2d43d082a72a2b2aa26d15e112f6e68"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#2e6f6cbb1d5f6da27ebc8840e61802ed">csSet</a> (int size=23, int grow_rate=5, int max_size=20000)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Construct a new empty set. <a href="#2e6f6cbb1d5f6da27ebc8840e61802ed"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#8f56f8ccb6ae68138ae23840126b490e">Delete</a> (const T &object)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete an object from the set. <a href="#8f56f8ccb6ae68138ae23840126b490e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#82c92adf572745bb7e0495c7512d462a">DeleteAll</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all elements in the set. <a href="#82c92adf572745bb7e0495c7512d462a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#cc0eb2404b92070ddbf9304e6301aa47">Empty</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Delete all elements in the set. (Idiomatic alias for <a class="el" href="classcsSet.html#82c92adf572745bb7e0495c7512d462a" title="Delete all elements in the set.">DeleteAll()</a>.). <a href="#cc0eb2404b92070ddbf9304e6301aa47"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classcsSet_1_1GlobalIterator.html">GlobalIterator</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#600ed2758c5ed06c5fff0bd26eeec44a">GetIterator</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return an iterator for the set which iterates over all elements. <a href="#600ed2758c5ed06c5fff0bd26eeec44a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#922fee4e4905f62562d97ad9e4f5a945">GetSize</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the number of elements in the set. <a href="#922fee4e4905f62562d97ad9e4f5a945"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#90440c896b860bd6dacf7ed4c9f21386">In</a> (const T &object) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test if an object is in this set. <a href="#90440c896b860bd6dacf7ed4c9f21386"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#2eb53f1b6dfeb25eb847161457a17f6b">IsEmpty</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return true if the set is empty. <a href="#2eb53f1b6dfeb25eb847161457a17f6b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="594373255032048e48ada9ba4e8b6e0f"></a><!-- doxytag: member="csSet::GlobalIterator" ref="594373255032048e48ada9ba4e8b6e0f" args="" -->
class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet.html#594373255032048e48ada9ba4e8b6e0f">GlobalIterator</a></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsSet_1_1GlobalIterator.html">GlobalIterator</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An iterator class for the set. <a href="classcsSet_1_1GlobalIterator.html#_details">More...</a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class T, class Allocator = CS::Memory::AllocatorMalloc><br>
class csSet< T, Allocator ></h3>
This class implements a basic set for objects.
<p>
You can basically use this to test for the occurrence of some object quickly.
<p>Definition at line <a class="el" href="set_8h-source.html#l00037">37</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="2e6f6cbb1d5f6da27ebc8840e61802ed"></a><!-- doxytag: member="csSet::csSet" ref="2e6f6cbb1d5f6da27ebc8840e61802ed" args="(int size=23, int grow_rate=5, int max_size=20000)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::<a class="el" href="classcsSet.html">csSet</a> </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>size</em> = <code>23</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>grow_rate</em> = <code>5</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"> <em>max_size</em> = <code>20000</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Construct a new empty set.
<p>
<em>size</em>, <em>grow_rate</em>, and <em>max_size</em> allow fine-tuning of how the set manages its internal allocations.
<p>Definition at line <a class="el" href="set_8h-source.html#l00082">82</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fe4c3dcd135ff9ae5ca5c5b965434fb7"></a><!-- doxytag: member="csSet::Add" ref="fe4c3dcd135ff9ae5ca5c5b965434fb7" args="(const T &object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::Add </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>object</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an object to this set.
<p>
This will do nothing if the object is already present.
<p>Definition at line <a class="el" href="set_8h-source.html#l00091">91</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="b1551cc10ebf97fd75517879218ad30c"></a><!-- doxytag: member="csSet::AddNoTest" ref="b1551cc10ebf97fd75517879218ad30c" args="(const T &object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::AddNoTest </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>object</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Add an object to this set.
<p>
This function does not test if the object is already there. This is used for efficiency reasons. But use with care!
<p>Definition at line <a class="el" href="set_8h-source.html#l00103">103</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
<p>Referenced by <a class="el" href="set_8h-source.html#l00091">csSet< csPtrKey< iMeshWrapper > >::Add()</a>.</p>
</div>
</div><p>
<a class="anchor" name="c2d43d082a72a2b2aa26d15e112f6e68"></a><!-- doxytag: member="csSet::Contains" ref="c2d43d082a72a2b2aa26d15e112f6e68" args="(const T &object) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::Contains </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>object</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if an object is in this set.
<p>
<p>Definition at line <a class="el" href="set_8h-source.html#l00111">111</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
<p>Referenced by <a class="el" href="set_8h-source.html#l00091">csSet< csPtrKey< iMeshWrapper > >::Add()</a>, and <a class="el" href="set_8h-source.html#l00121">csSet< csPtrKey< iMeshWrapper > >::In()</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f56f8ccb6ae68138ae23840126b490e"></a><!-- doxytag: member="csSet::Delete" ref="8f56f8ccb6ae68138ae23840126b490e" args="(const T &object)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::Delete </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>object</em> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete an object from the set.
<p>
This function does nothing if the object is not in the set. Return true if the object was present.
<p>Definition at line <a class="el" href="set_8h-source.html#l00140">140</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="82c92adf572745bb7e0495c7512d462a"></a><!-- doxytag: member="csSet::DeleteAll" ref="82c92adf572745bb7e0495c7512d462a" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::DeleteAll </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete all elements in the set.
<p>
<p>Definition at line <a class="el" href="set_8h-source.html#l00127">127</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
<p>Referenced by <a class="el" href="set_8h-source.html#l00133">csSet< csPtrKey< iMeshWrapper > >::Empty()</a>.</p>
</div>
</div><p>
<a class="anchor" name="cc0eb2404b92070ddbf9304e6301aa47"></a><!-- doxytag: member="csSet::Empty" ref="cc0eb2404b92070ddbf9304e6301aa47" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::Empty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delete all elements in the set. (Idiomatic alias for <a class="el" href="classcsSet.html#82c92adf572745bb7e0495c7512d462a" title="Delete all elements in the set.">DeleteAll()</a>.).
<p>
<p>Definition at line <a class="el" href="set_8h-source.html#l00133">133</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="600ed2758c5ed06c5fff0bd26eeec44a"></a><!-- doxytag: member="csSet::GetIterator" ref="600ed2758c5ed06c5fff0bd26eeec44a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classcsSet_1_1GlobalIterator.html">GlobalIterator</a> <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::GetIterator </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return an iterator for the set which iterates over all elements.
<p>
<dl class="warning" compact><dt><b>Warning:</b></dt><dd>Modifying the set while you have open iterators will cause undefined behaviour. </dd></dl>
<p>Definition at line <a class="el" href="set_8h-source.html#l00166">166</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="922fee4e4905f62562d97ad9e4f5a945"></a><!-- doxytag: member="csSet::GetSize" ref="922fee4e4905f62562d97ad9e4f5a945" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">size_t <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::GetSize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the number of elements in the set.
<p>
<p>Definition at line <a class="el" href="set_8h-source.html#l00146">146</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
<p>Referenced by <a class="el" href="set_8h-source.html#l00156">csSet< csPtrKey< iMeshWrapper > >::IsEmpty()</a>.</p>
</div>
</div><p>
<a class="anchor" name="90440c896b860bd6dacf7ed4c9f21386"></a><!-- doxytag: member="csSet::In" ref="90440c896b860bd6dacf7ed4c9f21386" args="(const T &object) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::In </td>
<td>(</td>
<td class="paramtype">const T & </td>
<td class="paramname"> <em>object</em> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Test if an object is in this set.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>This is rigidly equivalent to Contains(object), but may be considered more idiomatic by some. </dd></dl>
<p>Definition at line <a class="el" href="set_8h-source.html#l00121">121</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2eb53f1b6dfeb25eb847161457a17f6b"></a><!-- doxytag: member="csSet::IsEmpty" ref="2eb53f1b6dfeb25eb847161457a17f6b" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class T, class Allocator = CS::Memory::AllocatorMalloc> </div>
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classcsSet.html">csSet</a>< T, Allocator >::IsEmpty </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return true if the set is empty.
<p>
<dl class="remark" compact><dt><b>Remarks:</b></dt><dd>Rigidly equivalent to <code>return <a class="el" href="classcsSet.html#922fee4e4905f62562d97ad9e4f5a945" title="Get the number of elements in the set.">GetSize()</a> == 0</code>, but more idiomatic. </dd></dl>
<p>Definition at line <a class="el" href="set_8h-source.html#l00156">156</a> of file <a class="el" href="set_8h-source.html">set.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csutil/<a class="el" href="set_8h-source.html">set.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
1017
