root/doc/html/factory_8h.html @ 354

Revision 353, 17.9 kB (checked in by smidl, 16 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: factory.h File 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><a href="annotated.html"><span>Classes</span></a></li>
56      <li class="current"><a href="files.html"><span>Files</span></a></li>
57    </ul>
58  </div>
59  <div class="tabs">
60    <ul>
61      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
62      <li><a href="globals.html"><span>File&nbsp;Members</span></a></li>
63    </ul>
64  </div>
65</div>
66<div class="contents">
67<h1>factory.h File Reference</h1>Base class for class factories and memory allocation functions. 
68<a href="#_details">More...</a>
69<p>
70<code>#include &lt;complex&gt;</code><br>
71<code>#include &lt;<a class="el" href="binary_8h-source.html">itpp/base/binary.h</a>&gt;</code><br>
72
73<p>
74<a href="factory_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
75<tr><td></td></tr>
76<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
77<tr><td class="memItemLeft" nowrap align="right" valign="top">class &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitpp_1_1Factory.html">itpp::Factory</a></td></tr>
78
79<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Base class for class factories.  <a href="classitpp_1_1Factory.html#_details">More...</a><br></td></tr>
80<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
81<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="ae225b90dc6e8038166e4a736bb6e297"></a><!-- doxytag: member="factory.h::create_elements" ref="ae225b90dc6e8038166e4a736bb6e297" args="(T *&amp;ptr, int n, const Factory &amp;)" -->
82template&lt;class T &gt; </td></tr>
83<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#ae225b90dc6e8038166e4a736bb6e297">itpp::create_elements</a> (T *&amp;ptr, int n, const Factory &amp;)</td></tr>
84
85<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an n-length array of T to be used as <a class="el" href="classitpp_1_1Array.html" title="General array class.">Array</a>, <a class="el" href="classitpp_1_1Vec.html" title="Vector Class (Templated).">Vec</a> or <a class="el" href="classitpp_1_1Mat.html" title="Matrix Class (Templated).">Mat</a> elements. <br></td></tr>
86<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="32c5985cae37c05d4bc3b84975423cfb"></a><!-- doxytag: member="factory.h::create_elements&lt; unsigned char &gt;" ref="32c5985cae37c05d4bc3b84975423cfb" args="(unsigned char *&amp;ptr, int n, const Factory &amp;)" -->
87template&lt;&gt; </td></tr>
88<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#32c5985cae37c05d4bc3b84975423cfb">itpp::create_elements&lt; unsigned char &gt;</a> (unsigned char *&amp;ptr, int n, const Factory &amp;)</td></tr>
89
90<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for unsigned char data arrays (used in GF2Mat). <br></td></tr>
91<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="6db4987e274f8098ff8cb242d163fe38"></a><!-- doxytag: member="factory.h::create_elements&lt; bin &gt;" ref="6db4987e274f8098ff8cb242d163fe38" args="(bin *&amp;ptr, int n, const Factory &amp;)" -->
92template&lt;&gt; </td></tr>
93<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#6db4987e274f8098ff8cb242d163fe38">itpp::create_elements&lt; bin &gt;</a> (bin *&amp;ptr, int n, const Factory &amp;)</td></tr>
94
95<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for binary data arrays. <br></td></tr>
96<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="8d7e1fb40663d47fc28577c3934692af"></a><!-- doxytag: member="factory.h::create_elements&lt; short int &gt;" ref="8d7e1fb40663d47fc28577c3934692af" args="(short int *&amp;ptr, int n, const Factory &amp;)" -->
97template&lt;&gt; </td></tr>
98<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#8d7e1fb40663d47fc28577c3934692af">itpp::create_elements&lt; short int &gt;</a> (short int *&amp;ptr, int n, const Factory &amp;)</td></tr>
99
100<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for short integer data arrays. <br></td></tr>
101<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="2f3a303b7d4a9343813ebcc33a8a4f6c"></a><!-- doxytag: member="factory.h::create_elements&lt; int &gt;" ref="2f3a303b7d4a9343813ebcc33a8a4f6c" args="(int *&amp;ptr, int n, const Factory &amp;)" -->
102template&lt;&gt; </td></tr>
103<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#2f3a303b7d4a9343813ebcc33a8a4f6c">itpp::create_elements&lt; int &gt;</a> (int *&amp;ptr, int n, const Factory &amp;)</td></tr>
104
105<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for integer data arrays. <br></td></tr>
106<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="d57aca2cdcac825902bbc824584726ba"></a><!-- doxytag: member="factory.h::create_elements&lt; double &gt;" ref="d57aca2cdcac825902bbc824584726ba" args="(double *&amp;ptr, int n, const Factory &amp;)" -->
107template&lt;&gt; </td></tr>
108<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#d57aca2cdcac825902bbc824584726ba">itpp::create_elements&lt; double &gt;</a> (double *&amp;ptr, int n, const Factory &amp;)</td></tr>
109
110<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for 16-byte aligned double data arrays. <br></td></tr>
111<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="9ab3737a7080bc99a0dcde8a72416b11"></a><!-- doxytag: member="factory.h::create_elements&lt; std::complex&lt; double &gt; &gt;" ref="9ab3737a7080bc99a0dcde8a72416b11" args="(std::complex&lt; double &gt; *&amp;ptr, int n, const Factory &amp;)" -->
112template&lt;&gt; </td></tr>
113<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#9ab3737a7080bc99a0dcde8a72416b11">itpp::create_elements&lt; std::complex&lt; double &gt; &gt;</a> (std::complex&lt; double &gt; *&amp;ptr, int n, const Factory &amp;)</td></tr>
114
115<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for 16-byte aligned complex double data arrays. <br></td></tr>
116<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="56418ce92d54f71943a7fc1daf590d92"></a><!-- doxytag: member="factory.h::destroy_elements" ref="56418ce92d54f71943a7fc1daf590d92" args="(T *&amp;ptr, int n)" -->
117template&lt;class T &gt; </td></tr>
118<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#56418ce92d54f71943a7fc1daf590d92">itpp::destroy_elements</a> (T *&amp;ptr, int n)</td></tr>
119
120<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy an array of <a class="el" href="classitpp_1_1Array.html" title="General array class.">Array</a>, <a class="el" href="classitpp_1_1Vec.html" title="Vector Class (Templated).">Vec</a> or <a class="el" href="classitpp_1_1Mat.html" title="Matrix Class (Templated).">Mat</a> elements. <br></td></tr>
121<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="88f11facbf4d459f08f0f5e038a60270"></a><!-- doxytag: member="factory.h::destroy_elements&lt; unsigned char &gt;" ref="88f11facbf4d459f08f0f5e038a60270" args="(unsigned char *&amp;ptr, int)" -->
122template&lt;&gt; </td></tr>
123<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#88f11facbf4d459f08f0f5e038a60270">itpp::destroy_elements&lt; unsigned char &gt;</a> (unsigned char *&amp;ptr, int)</td></tr>
124
125<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for unsigned char data arrays (used in GF2Mat). <br></td></tr>
126<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="ef0a24560b1ad2e62eb75921b3dd0e94"></a><!-- doxytag: member="factory.h::destroy_elements&lt; bin &gt;" ref="ef0a24560b1ad2e62eb75921b3dd0e94" args="(bin *&amp;ptr, int)" -->
127template&lt;&gt; </td></tr>
128<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#ef0a24560b1ad2e62eb75921b3dd0e94">itpp::destroy_elements&lt; bin &gt;</a> (bin *&amp;ptr, int)</td></tr>
129
130<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for binary data arrays. <br></td></tr>
131<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="226e0538b7afef21fa34e281db6200aa"></a><!-- doxytag: member="factory.h::destroy_elements&lt; short int &gt;" ref="226e0538b7afef21fa34e281db6200aa" args="(short int *&amp;ptr, int)" -->
132template&lt;&gt; </td></tr>
133<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#226e0538b7afef21fa34e281db6200aa">itpp::destroy_elements&lt; short int &gt;</a> (short int *&amp;ptr, int)</td></tr>
134
135<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for short integer data arrays. <br></td></tr>
136<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="e7cf7eaed9aa127f7862500081112dd6"></a><!-- doxytag: member="factory.h::destroy_elements&lt; int &gt;" ref="e7cf7eaed9aa127f7862500081112dd6" args="(int *&amp;ptr, int)" -->
137template&lt;&gt; </td></tr>
138<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#e7cf7eaed9aa127f7862500081112dd6">itpp::destroy_elements&lt; int &gt;</a> (int *&amp;ptr, int)</td></tr>
139
140<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialization for integer data arrays. <br></td></tr>
141<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="2bdc05ca0a74068c9f174f339a6b5e00"></a><!-- doxytag: member="factory.h::destroy_elements&lt; double &gt;" ref="2bdc05ca0a74068c9f174f339a6b5e00" args="(double *&amp;ptr, int)" -->
142template&lt;&gt; </td></tr>
143<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#2bdc05ca0a74068c9f174f339a6b5e00">itpp::destroy_elements&lt; double &gt;</a> (double *&amp;ptr, int)</td></tr>
144
145<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialisation for 16-byte aligned double data arrays. <br></td></tr>
146<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="8ce2cddc1044ec6c8265aebabe217d2a"></a><!-- doxytag: member="factory.h::destroy_elements&lt; std::complex&lt; double &gt; &gt;" ref="8ce2cddc1044ec6c8265aebabe217d2a" args="(std::complex&lt; double &gt; *&amp;ptr, int)" -->
147template&lt;&gt; </td></tr>
148<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#8ce2cddc1044ec6c8265aebabe217d2a">itpp::destroy_elements&lt; std::complex&lt; double &gt; &gt;</a> (std::complex&lt; double &gt; *&amp;ptr, int)</td></tr>
149
150<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Specialisation for 16-byte aligned complex double data arrays. <br></td></tr>
151<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="f49015f46833245653cd6da6e524470c"></a><!-- doxytag: member="factory.h::create_elements" ref="f49015f46833245653cd6da6e524470c" args="(Array&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)" -->
152template&lt;class T &gt; </td></tr>
153<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#f49015f46833245653cd6da6e524470c">itpp::create_elements</a> (Array&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)</td></tr>
154
155<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an n-length array of Array&lt;T&gt; to be used as <a class="el" href="classitpp_1_1Array.html" title="General array class.">Array</a> elements. <br></td></tr>
156<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="a432acdda335dc436fe048ecd8d89df4"></a><!-- doxytag: member="factory.h::create_elements" ref="a432acdda335dc436fe048ecd8d89df4" args="(Mat&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)" -->
157template&lt;class T &gt; </td></tr>
158<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#a432acdda335dc436fe048ecd8d89df4">itpp::create_elements</a> (Mat&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)</td></tr>
159
160<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an n-length array of <a class="el" href="classitpp_1_1Mat.html">Mat&lt;T&gt;</a> to be used as <a class="el" href="classitpp_1_1Array.html" title="General array class.">Array</a> elements. <br></td></tr>
161<tr><td class="memTemplParams" nowrap colspan="2"><a class="anchor" name="39fc267297410b9231eb947f7681f0f7"></a><!-- doxytag: member="factory.h::create_elements" ref="39fc267297410b9231eb947f7681f0f7" args="(Vec&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)" -->
162template&lt;class T &gt; </td></tr>
163<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#39fc267297410b9231eb947f7681f0f7">itpp::create_elements</a> (Vec&lt; T &gt; *&amp;ptr, int n, const Factory &amp;f)</td></tr>
164
165<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create an n-length array of <a class="el" href="classitpp_1_1Vec.html">Vec&lt;T&gt;</a> to be used as <a class="el" href="classitpp_1_1Array.html" title="General array class.">Array</a> elements. <br></td></tr>
166<tr><td colspan="2"><br><h2>Variables</h2></td></tr>
167<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d70a88955cc299080ba187618e4e5df6"></a><!-- doxytag: member="factory.h::DEFAULT_FACTORY" ref="d70a88955cc299080ba187618e4e5df6" args="" -->
168const Factory&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceitpp.html#d70a88955cc299080ba187618e4e5df6">itpp::DEFAULT_FACTORY</a></td></tr>
169
170<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Default (dummy) factory. <br></td></tr>
171</table>
172<hr><a name="_details"></a><h2>Detailed Description</h2>
173Base class for class factories and memory allocation functions.
174<p>
175<dl class="author" compact><dt><b>Author:</b></dt><dd>Johan Bergman and Adam Piatyszek</dd></dl>
176-------------------------------------------------------------------------<p>
177Copyright (C) 1995-2008 (see AUTHORS file for a list of contributors)<p>
178This file is part of IT++ - a C++ library of mathematical, signal processing, speech processing, and communications classes and functions.<p>
179IT++ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.<p>
180IT++ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.<p>
181You should have received a copy of the GNU General Public License along with IT++. If not, see &lt;<a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>&gt;.<p>
182------------------------------------------------------------------------- </div>
183<hr size="1"><address style="text-align: right;"><small>Generated on Tue Jun 2 10:02:13 2009 for mixpp by&nbsp;
184<a href="http://www.doxygen.org/index.html">
185<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
186</body>
187</html>
Note: See TracBrowser for help on using the browser.