<!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: csTuple2< First, Second > 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>csTuple2< First, Second > Class Template Reference<br> <small> [<a class="el" href="group__util__containers.html">Containers</a>]</small> </h1><!-- doxytag: class="csTuple2" -->A two length tuple (fixed size collection of elements) Tuples are typically used for quickly bounding grouped values around with a low overhead. <a href="#_details">More...</a> <p> <code>#include <<a class="el" href="tuple_8h-source.html">csutil/tuple.h</a>></code> <p> <p> <a href="classcsTuple2-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">typedef First </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#870d68a15c3453b5ae77c663cb7885bf">FirstType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">typedef that can be accessed to recreate object of the first type <a href="#870d68a15c3453b5ae77c663cb7885bf"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">typedef Second </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#48dc3add5d2c726313f1b865bdc70acd">SecondType</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">typedef that can be accessed to recreate object of the second type <a href="#48dc3add5d2c726313f1b865bdc70acd"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> <tr><td class="memTemplParams" nowrap colspan="2">template<typename AlFirst, typename AlSecond> </td></tr> <tr><td class="memTemplItemLeft" nowrap align="right" valign="top"> </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#93c022a71123dd61abe584eb9df79b9b">csTuple2</a> (const <a class="el" href="classcsTuple2.html">csTuple2</a>< AlFirst, AlSecond > &t)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Templated constructor from another <a class="el" href="classcsTuple2.html" title="A two length tuple (fixed size collection of elements) Tuples are typically used...">csTuple2</a>. <a href="#93c022a71123dd61abe584eb9df79b9b"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#c1f510379b9a297b2631f592d369cae5">csTuple2</a> (const First &<a class="el" href="classcsTuple2.html#287d797534a0bc38e730982deff88a28">first</a>, const Second &<a class="el" href="classcsTuple2.html#674d21d4f8c62036b6bdc5a9b15219ab">second</a>)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor to initialise both elements. <a href="#c1f510379b9a297b2631f592d369cae5"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#0d890c041b10a5d0c952b007aac4beb1">csTuple2</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Empty default constructor. <a href="#0d890c041b10a5d0c952b007aac4beb1"></a><br></td></tr> <tr><td colspan="2"><br><h2>Public Attributes</h2></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">First </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#287d797534a0bc38e730982deff88a28">first</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">First element in Tuple. <a href="#287d797534a0bc38e730982deff88a28"></a><br></td></tr> <tr><td class="memItemLeft" nowrap align="right" valign="top">Second </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsTuple2.html#674d21d4f8c62036b6bdc5a9b15219ab">second</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Second element in Tuple. <a href="#674d21d4f8c62036b6bdc5a9b15219ab"></a><br></td></tr> </table> <hr><a name="_details"></a><h2>Detailed Description</h2> <h3>template<typename First, typename Second><br> class csTuple2< First, Second ></h3> A two length tuple (fixed size collection of elements) Tuples are typically used for quickly bounding grouped values around with a low overhead. <p>Definition at line <a class="el" href="tuple_8h-source.html#l00035">35</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> <hr><h2>Member Typedef Documentation</h2> <a class="anchor" name="870d68a15c3453b5ae77c663cb7885bf"></a><!-- doxytag: member="csTuple2::FirstType" ref="870d68a15c3453b5ae77c663cb7885bf" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname">typedef First <a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html#870d68a15c3453b5ae77c663cb7885bf">FirstType</a> </td> </tr> </table> </div> <div class="memdoc"> <p> typedef that can be accessed to recreate object of the first type <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00040">40</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <a class="anchor" name="48dc3add5d2c726313f1b865bdc70acd"></a><!-- doxytag: member="csTuple2::SecondType" ref="48dc3add5d2c726313f1b865bdc70acd" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname">typedef Second <a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html#48dc3add5d2c726313f1b865bdc70acd">SecondType</a> </td> </tr> </table> </div> <div class="memdoc"> <p> typedef that can be accessed to recreate object of the second type <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00043">43</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <hr><h2>Constructor & Destructor Documentation</h2> <a class="anchor" name="0d890c041b10a5d0c952b007aac4beb1"></a><!-- doxytag: member="csTuple2::csTuple2" ref="0d890c041b10a5d0c952b007aac4beb1" args="()" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html">csTuple2</a> </td> <td>(</td> <td class="paramname"> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Empty default constructor. <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00051">51</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <a class="anchor" name="c1f510379b9a297b2631f592d369cae5"></a><!-- doxytag: member="csTuple2::csTuple2" ref="c1f510379b9a297b2631f592d369cae5" args="(const First &first, const Second &second)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html">csTuple2</a> </td> <td>(</td> <td class="paramtype">const First & </td> <td class="paramname"> <em>first</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const Second & </td> <td class="paramname"> <em>second</em></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> Constructor to initialise both elements. <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00053">53</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <a class="anchor" name="93c022a71123dd61abe584eb9df79b9b"></a><!-- doxytag: member="csTuple2::csTuple2" ref="93c022a71123dd61abe584eb9df79b9b" args="(const csTuple2< AlFirst, AlSecond > &t)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <div class="memtemplate"> template<typename AlFirst, typename AlSecond> </div> <table class="memname"> <tr> <td class="memname"><a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html">csTuple2</a> </td> <td>(</td> <td class="paramtype">const <a class="el" href="classcsTuple2.html">csTuple2</a>< AlFirst, AlSecond > & </td> <td class="paramname"> <em>t</em> </td> <td> ) </td> <td width="100%"><code> [inline]</code></td> </tr> </table> </div> <div class="memdoc"> <p> Templated constructor from another <a class="el" href="classcsTuple2.html" title="A two length tuple (fixed size collection of elements) Tuples are typically used...">csTuple2</a>. <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00057">57</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <hr><h2>Member Data Documentation</h2> <a class="anchor" name="287d797534a0bc38e730982deff88a28"></a><!-- doxytag: member="csTuple2::first" ref="287d797534a0bc38e730982deff88a28" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname">First <a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html#287d797534a0bc38e730982deff88a28">first</a> </td> </tr> </table> </div> <div class="memdoc"> <p> First element in Tuple. <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00046">46</a> of file <a class="el" href="tuple_8h-source.html">tuple.h</a>.</p> </div> </div><p> <a class="anchor" name="674d21d4f8c62036b6bdc5a9b15219ab"></a><!-- doxytag: member="csTuple2::second" ref="674d21d4f8c62036b6bdc5a9b15219ab" args="" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename First, typename Second> </div> <table class="memname"> <tr> <td class="memname">Second <a class="el" href="classcsTuple2.html">csTuple2</a>< First, Second >::<a class="el" href="classcsTuple2.html#674d21d4f8c62036b6bdc5a9b15219ab">second</a> </td> </tr> </table> </div> <div class="memdoc"> <p> Second element in Tuple. <p> <p>Definition at line <a class="el" href="tuple_8h-source.html#l00048">48</a> of file <a class="el" href="tuple_8h-source.html">tuple.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="tuple_8h-source.html">tuple.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>