root/doc/html/classitpp_1_1Stack.html @ 354

Revision 353, 10.6 kB (checked in by smidl, 15 years ago)

doc

Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3<title>mixpp: itpp::Stack&lt; T &gt; Class Template Reference</title>
4<link href="tabs.css" rel="stylesheet" type="text/css">
5<link href="doxygen.css" rel="stylesheet" type="text/css">
6</head><body>
7<!-- Generated by Doxygen 1.5.8 -->
8<script type="text/javascript">
9<!--
10function changeDisplayState (e){
11  var num=this.id.replace(/[^[0-9]/g,'');
12  var button=this.firstChild;
13  var sectionDiv=document.getElementById('dynsection'+num);
14  if (sectionDiv.style.display=='none'||sectionDiv.style.display==''){
15    sectionDiv.style.display='block';
16    button.src='open.gif';
17  }else{
18    sectionDiv.style.display='none';
19    button.src='closed.gif';
20  }
21}
22function initDynSections(){
23  var divs=document.getElementsByTagName('div');
24  var sectionCounter=1;
25  for(var i=0;i<divs.length-1;i++){
26    if(divs[i].className=='dynheader'&&divs[i+1].className=='dynsection'){
27      var header=divs[i];
28      var section=divs[i+1];
29      var button=header.firstChild;
30      if (button!='IMG'){
31        divs[i].insertBefore(document.createTextNode(' '),divs[i].firstChild);
32        button=document.createElement('img');
33        divs[i].insertBefore(button,divs[i].firstChild);
34      }
35      header.style.cursor='pointer';
36      header.onclick=changeDisplayState;
37      header.id='dynheader'+sectionCounter;
38      button.src='closed.gif';
39      section.id='dynsection'+sectionCounter;
40      section.style.display='none';
41      section.style.marginLeft='14px';
42      sectionCounter++;
43    }
44  }
45}
46window.onload = initDynSections;
47-->
48</script>
49<div class="navigation" id="top">
50  <div class="tabs">
51    <ul>
52      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
53      <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
54      <li><a href="modules.html"><span>Modules</span></a></li>
55      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
56      <li><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="annotated.html"><span>Class&nbsp;List</span></a></li>
62      <li><a href="classes.html"><span>Class&nbsp;Index</span></a></li>
63      <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
64      <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
65    </ul>
66  </div>
67  <div class="navpath"><b>itpp</b>::<a class="el" href="classitpp_1_1Stack.html">Stack</a>
68  </div>
69</div>
70<div class="contents">
71<h1>itpp::Stack&lt; T &gt; Class Template Reference</h1><!-- doxytag: class="itpp::Stack" -->General stack class. 
72<a href="#_details">More...</a>
73<p>
74<code>#include &lt;<a class="el" href="stack_8h-source.html">stack.h</a>&gt;</code>
75<p>
76
77<p>
78<a href="classitpp_1_1Stack-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
79<tr><td></td></tr>
80<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
81<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4cb90649da75b936c62765154a3a83dd"></a><!-- doxytag: member="itpp::Stack::Stack" ref="4cb90649da75b936c62765154a3a83dd" args="()" -->
82&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#4cb90649da75b936c62765154a3a83dd">Stack</a> ()</td></tr>
83
84<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default constructor. <br></td></tr>
85<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="67b6b5cc1dbd2ff12f56885ecf5b749d"></a><!-- doxytag: member="itpp::Stack::Stack" ref="67b6b5cc1dbd2ff12f56885ecf5b749d" args="(int n)" -->
86&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#67b6b5cc1dbd2ff12f56885ecf5b749d">Stack</a> (int n)</td></tr>
87
88<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a <a class="el" href="classitpp_1_1Stack.html" title="General stack class.">Stack</a> of size <code>n</code>. <br></td></tr>
89<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="237b05e0f8e473dbd0310200def68708"></a><!-- doxytag: member="itpp::Stack::Stack" ref="237b05e0f8e473dbd0310200def68708" args="(const Stack&lt; T &gt; &amp;s)" -->
90&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#237b05e0f8e473dbd0310200def68708">Stack</a> (const <a class="el" href="classitpp_1_1Stack.html">Stack</a>&lt; T &gt; &amp;s)</td></tr>
91
92<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a copy of <code>s</code>. <br></td></tr>
93<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="16ce049c48699f4704b91000cbe223a7"></a><!-- doxytag: member="itpp::Stack::~Stack" ref="16ce049c48699f4704b91000cbe223a7" args="()" -->
94virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#16ce049c48699f4704b91000cbe223a7">~Stack</a> ()</td></tr>
95
96<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default destructor. <br></td></tr>
97<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b37580fdfc0834fdefce08ed71543cc0"></a><!-- doxytag: member="itpp::Stack::pop" ref="b37580fdfc0834fdefce08ed71543cc0" args="()" -->
98T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#b37580fdfc0834fdefce08ed71543cc0">pop</a> ()</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Pop the topmost element of the stack. <br></td></tr>
101<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="cd617bc3ea3aa848a8390688986926e4"></a><!-- doxytag: member="itpp::Stack::peek" ref="cd617bc3ea3aa848a8390688986926e4" args="() const " -->
102T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#cd617bc3ea3aa848a8390688986926e4">peek</a> () const </td></tr>
103
104<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Peek at the topmost element of the stack, without removing it. <br></td></tr>
105<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="7d367256a03d6cb42c8e19321b4a4ac4"></a><!-- doxytag: member="itpp::Stack::push" ref="7d367256a03d6cb42c8e19321b4a4ac4" args="(T v)" -->
106void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#7d367256a03d6cb42c8e19321b4a4ac4">push</a> (T v)</td></tr>
107
108<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Push an element at top of stack. <br></td></tr>
109<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="eec8bd657e5636f02472e8610231e557"></a><!-- doxytag: member="itpp::Stack::clear" ref="eec8bd657e5636f02472e8610231e557" args="()" -->
110void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#eec8bd657e5636f02472e8610231e557">clear</a> ()</td></tr>
111
112<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Empty the stack. <br></td></tr>
113<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2f0b3362f0fe86685756fd5015d0fa5"></a><!-- doxytag: member="itpp::Stack::operator=" ref="a2f0b3362f0fe86685756fd5015d0fa5" args="(const Stack&lt; T &gt; &amp;s)" -->
114void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#a2f0b3362f0fe86685756fd5015d0fa5">operator=</a> (const <a class="el" href="classitpp_1_1Stack.html">Stack</a>&lt; T &gt; &amp;s)</td></tr>
115
116<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Assignment operator. <br></td></tr>
117<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3c8a6f4c9309682884234371b040b131"></a><!-- doxytag: member="itpp::Stack::size" ref="3c8a6f4c9309682884234371b040b131" args="() const " -->
118int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#3c8a6f4c9309682884234371b040b131">size</a> () const </td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the maximum number of data elements the stack can store. <br></td></tr>
121<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="53f0e07e95fca870bed08e44efce0d97"></a><!-- doxytag: member="itpp::Stack::no_elements" ref="53f0e07e95fca870bed08e44efce0d97" args="() const " -->
122int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#53f0e07e95fca870bed08e44efce0d97">no_elements</a> () const </td></tr>
123
124<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of data elements currently in the stack. <br></td></tr>
125<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="55bb36306697de98aec9da9b41c50e70"></a><!-- doxytag: member="itpp::Stack::set_size" ref="55bb36306697de98aec9da9b41c50e70" args="(int n, bool copy=false)" -->
126void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Stack.html#55bb36306697de98aec9da9b41c50e70">set_size</a> (int n, bool copy=false)</td></tr>
127
128<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resizing a Stack&lt;T&gt;. <br></td></tr>
129</table>
130<hr><a name="_details"></a><h2>Detailed Description</h2>
131<h3>template&lt;class T&gt;<br>
132 class itpp::Stack&lt; T &gt;</h3>
133
134General stack class.
135<p>
136This class is a general stack class for arbitrary types.<p>
137For rarely used types you will need to instantiate the class by <div class="fragment"><pre class="fragment">  <span class="keyword">template</span> <span class="keyword">class </span>Stack&lt;type&gt;;
138</pre></div><p>
139The following example shows how to define a <a class="el" href="classitpp_1_1Stack.html" title="General stack class.">Stack</a> of vectors: <div class="fragment"><pre class="fragment">  vec a = <a class="code" href="group__randgen.html#g9ecf5af23567f51abc9af737fdbd872a" title="Generates a random Gaussian (0,1) variable.">randn</a>(10);
140  vec b = <a class="code" href="group__randgen.html#g9ecf5af23567f51abc9af737fdbd872a" title="Generates a random Gaussian (0,1) variable.">randn</a>(20);
141  Stack&lt;vec&gt; my_stack(10);
142  my_stack.push(a);
143  my_stack.push(b);
144
145  cout &lt;&lt; my_stack.pop() &lt;&lt; <span class="stringliteral">" "</span> &lt;&lt; my_stack.pop() &lt;&lt; endl ;
146</pre></div> <hr>The documentation for this class was generated from the following file:<ul>
147<li><a class="el" href="stack_8h-source.html">stack.h</a></ul>
148</div>
149<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:19 2009 for mixpp by&nbsp;
150<a href="http://www.doxygen.org/index.html">
151<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
152</body>
153</html>
Note: See TracBrowser for help on using the browser.