<!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>GNU Radio 3.3.0 C++ API: pmt.h 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.6.3 -->
<h1>pmt.h</h1><a href="pmt_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* -*- c++ -*- */</span>
<a name="l00002"></a>00002 <span class="comment">/*</span>
<a name="l00003"></a>00003 <span class="comment"> * Copyright 2006,2009,2010 Free Software Foundation, Inc.</span>
<a name="l00004"></a>00004 <span class="comment"> * </span>
<a name="l00005"></a>00005 <span class="comment"> * This file is part of GNU Radio</span>
<a name="l00006"></a>00006 <span class="comment"> * </span>
<a name="l00007"></a>00007 <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span>
<a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
<a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span>
<a name="l00010"></a>00010 <span class="comment"> * any later version.</span>
<a name="l00011"></a>00011 <span class="comment"> * </span>
<a name="l00012"></a>00012 <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span>
<a name="l00013"></a>00013 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00014"></a>00014 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
<a name="l00015"></a>00015 <span class="comment"> * GNU General Public License for more details.</span>
<a name="l00016"></a>00016 <span class="comment"> * </span>
<a name="l00017"></a>00017 <span class="comment"> * You should have received a copy of the GNU General Public License</span>
<a name="l00018"></a>00018 <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span>
<a name="l00019"></a>00019 <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span>
<a name="l00020"></a>00020 <span class="comment"> * Boston, MA 02110-1301, USA.</span>
<a name="l00021"></a>00021 <span class="comment"> */</span>
<a name="l00022"></a>00022
<a name="l00023"></a>00023 <span class="preprocessor">#ifndef INCLUDED_PMT_H</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_PMT_H</span>
<a name="l00025"></a>00025 <span class="preprocessor"></span>
<a name="l00026"></a>00026 <span class="preprocessor">#include <boost/intrusive_ptr.hpp></span>
<a name="l00027"></a>00027 <span class="preprocessor">#include <boost/shared_ptr.hpp></span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <boost/any.hpp></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <complex></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <string></span>
<a name="l00031"></a>00031 <span class="preprocessor">#include <stdint.h></span>
<a name="l00032"></a>00032 <span class="preprocessor">#include <iosfwd></span>
<a name="l00033"></a>00033 <span class="preprocessor">#include <stdexcept></span>
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="keyword">namespace </span>gruel {
<a name="l00036"></a>00036 <span class="keyword">class </span>msg_accepter;
<a name="l00037"></a>00037 };
<a name="l00038"></a>00038 <span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/*!</span>
<a name="l00040"></a>00040 <span class="comment"> * This file defines a polymorphic type and the operations on it.</span>
<a name="l00041"></a>00041 <span class="comment"> *</span>
<a name="l00042"></a>00042 <span class="comment"> * It draws heavily on the idea of scheme and lisp data types.</span>
<a name="l00043"></a>00043 <span class="comment"> * The interface parallels that in Guile 1.8, with the notable</span>
<a name="l00044"></a>00044 <span class="comment"> * exception that these objects are transparently reference counted.</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a>00046
<a name="l00047"></a>00047 <span class="keyword">namespace </span>pmt {
<a name="l00048"></a>00048 <span class="comment"></span>
<a name="l00049"></a>00049 <span class="comment">/*!</span>
<a name="l00050"></a>00050 <span class="comment"> * \brief base class of all pmt types</span>
<a name="l00051"></a>00051 <span class="comment"> */</span>
<a name="l00052"></a>00052 <span class="keyword">class </span>pmt_base;
<a name="l00053"></a>00053 <span class="comment"></span>
<a name="l00054"></a>00054 <span class="comment">/*!</span>
<a name="l00055"></a>00055 <span class="comment"> * \brief typedef for shared pointer (transparent reference counting).</span>
<a name="l00056"></a>00056 <span class="comment"> * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058 <span class="keyword">typedef</span> boost::intrusive_ptr<pmt_base> pmt_t;
<a name="l00059"></a>00059
<a name="l00060"></a>00060 <span class="keyword">extern</span> <span class="keywordtype">void</span> intrusive_ptr_add_ref(pmt_base*);
<a name="l00061"></a>00061 <span class="keyword">extern</span> <span class="keywordtype">void</span> intrusive_ptr_release(pmt_base*);
<a name="l00062"></a>00062
<a name="l00063"></a><a class="code" href="classpmt_1_1pmt__exception.html">00063</a> <span class="keyword">class </span><a class="code" href="classpmt_1_1pmt__exception.html">pmt_exception</a> : <span class="keyword">public</span> std::logic_error
<a name="l00064"></a>00064 {
<a name="l00065"></a>00065 <span class="keyword">public</span>:
<a name="l00066"></a>00066 <a class="code" href="classpmt_1_1pmt__exception.html#a5ba5f07e45c2acab0c082db8487a271a">pmt_exception</a>(<span class="keyword">const</span> std::string &msg, pmt_t obj);
<a name="l00067"></a>00067 };
<a name="l00068"></a>00068
<a name="l00069"></a><a class="code" href="classpmt_1_1pmt__wrong__type.html">00069</a> <span class="keyword">class </span><a class="code" href="classpmt_1_1pmt__wrong__type.html">pmt_wrong_type</a> : <span class="keyword">public</span> <a class="code" href="classpmt_1_1pmt__exception.html">pmt_exception</a>
<a name="l00070"></a>00070 {
<a name="l00071"></a>00071 <span class="keyword">public</span>:
<a name="l00072"></a>00072 <a class="code" href="classpmt_1_1pmt__wrong__type.html#a42fe082bf5d74157131c027846171b04">pmt_wrong_type</a>(<span class="keyword">const</span> std::string &msg, pmt_t obj);
<a name="l00073"></a>00073 };
<a name="l00074"></a>00074
<a name="l00075"></a><a class="code" href="classpmt_1_1pmt__out__of__range.html">00075</a> <span class="keyword">class </span><a class="code" href="classpmt_1_1pmt__out__of__range.html">pmt_out_of_range</a> : <span class="keyword">public</span> <a class="code" href="classpmt_1_1pmt__exception.html">pmt_exception</a>
<a name="l00076"></a>00076 {
<a name="l00077"></a>00077 <span class="keyword">public</span>:
<a name="l00078"></a>00078 <a class="code" href="classpmt_1_1pmt__out__of__range.html#ac0f0ca064653229f51a06e76c6bb5bfa">pmt_out_of_range</a>(<span class="keyword">const</span> std::string &msg, pmt_t obj);
<a name="l00079"></a>00079 };
<a name="l00080"></a>00080
<a name="l00081"></a><a class="code" href="classpmt_1_1pmt__notimplemented.html">00081</a> <span class="keyword">class </span><a class="code" href="classpmt_1_1pmt__notimplemented.html">pmt_notimplemented</a> : <span class="keyword">public</span> <a class="code" href="classpmt_1_1pmt__exception.html">pmt_exception</a>
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 <span class="keyword">public</span>:
<a name="l00084"></a>00084 <a class="code" href="classpmt_1_1pmt__notimplemented.html#a16a05c6c0557db6e2b282859e3b1addf">pmt_notimplemented</a>(<span class="keyword">const</span> std::string &msg, pmt_t obj);
<a name="l00085"></a>00085 };
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="comment">/*</span>
<a name="l00088"></a>00088 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00089"></a>00089 <span class="comment"> * Booleans. Two constants, #t and #f.</span>
<a name="l00090"></a>00090 <span class="comment"> *</span>
<a name="l00091"></a>00091 <span class="comment"> * In predicates, anything that is not #f is considered true.</span>
<a name="l00092"></a>00092 <span class="comment"> * I.e., there is a single false value, #f.</span>
<a name="l00093"></a>00093 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00094"></a>00094 <span class="comment"> */</span>
<a name="l00095"></a>00095 <span class="keyword">extern</span> <span class="keyword">const</span> pmt_t PMT_T; <span class="comment">//< \#t : boolean true constant</span>
<a name="l00096"></a>00096 <span class="keyword">extern</span> <span class="keyword">const</span> pmt_t PMT_F; <span class="comment">//< \#f : boolean false constant</span>
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">//! Return true if obj is \#t or \#f, else return false.</span>
<a name="l00099"></a>00099 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_bool(pmt_t obj);
<a name="l00100"></a>00100 <span class="comment"></span>
<a name="l00101"></a>00101 <span class="comment">//! Return false if obj is \#f, else return true.</span>
<a name="l00102"></a>00102 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_true(pmt_t obj);
<a name="l00103"></a>00103 <span class="comment"></span>
<a name="l00104"></a>00104 <span class="comment">//! Return true if obj is \#f, else return true.</span>
<a name="l00105"></a>00105 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_false(pmt_t obj);
<a name="l00106"></a>00106 <span class="comment"></span>
<a name="l00107"></a>00107 <span class="comment">//! Return \#f is val is false, else return \#t.</span>
<a name="l00108"></a>00108 <span class="comment"></span>pmt_t pmt_from_bool(<span class="keywordtype">bool</span> val);
<a name="l00109"></a>00109 <span class="comment"></span>
<a name="l00110"></a>00110 <span class="comment">//! Return true if val is PMT_T, return false when val is PMT_F, </span>
<a name="l00111"></a>00111 <span class="comment"></span><span class="comment">// else raise wrong_type exception.</span>
<a name="l00112"></a>00112 <span class="keywordtype">bool</span> pmt_to_bool(pmt_t val);
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="comment">/*</span>
<a name="l00115"></a>00115 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00116"></a>00116 <span class="comment"> * Symbols</span>
<a name="l00117"></a>00117 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00118"></a>00118 <span class="comment"> */</span>
<a name="l00119"></a>00119 <span class="comment"></span>
<a name="l00120"></a>00120 <span class="comment">//! Return true if obj is a symbol, else false.</span>
<a name="l00121"></a>00121 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_symbol(<span class="keyword">const</span> pmt_t& obj);
<a name="l00122"></a>00122 <span class="comment"></span>
<a name="l00123"></a>00123 <span class="comment">//! Return the symbol whose name is \p s.</span>
<a name="l00124"></a>00124 <span class="comment"></span>pmt_t pmt_string_to_symbol(<span class="keyword">const</span> std::string &s);
<a name="l00125"></a>00125 <span class="comment"></span>
<a name="l00126"></a>00126 <span class="comment">//! Alias for pmt_string_to_symbol</span>
<a name="l00127"></a>00127 <span class="comment"></span>pmt_t pmt_intern(<span class="keyword">const</span> std::string &s);
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment"></span>
<a name="l00130"></a>00130 <span class="comment">/*!</span>
<a name="l00131"></a>00131 <span class="comment"> * If \p is a symbol, return the name of the symbol as a string.</span>
<a name="l00132"></a>00132 <span class="comment"> * Otherwise, raise the wrong_type exception.</span>
<a name="l00133"></a>00133 <span class="comment"> */</span>
<a name="l00134"></a>00134 <span class="keyword">const</span> std::string pmt_symbol_to_string(<span class="keyword">const</span> pmt_t& sym);
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">/*</span>
<a name="l00137"></a>00137 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00138"></a>00138 <span class="comment"> * Numbers: we support integer, real and complex</span>
<a name="l00139"></a>00139 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a>00141 <span class="comment"></span>
<a name="l00142"></a>00142 <span class="comment">//! Return true if obj is any kind of number, else false.</span>
<a name="l00143"></a>00143 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_number(pmt_t obj);
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">/*</span>
<a name="l00146"></a>00146 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00147"></a>00147 <span class="comment"> * Integers</span>
<a name="l00148"></a>00148 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00149"></a>00149 <span class="comment"> */</span>
<a name="l00150"></a>00150 <span class="comment"></span>
<a name="l00151"></a>00151 <span class="comment">//! Return true if \p x is an integer number, else false</span>
<a name="l00152"></a>00152 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_integer(pmt_t x);
<a name="l00153"></a>00153 <span class="comment"></span>
<a name="l00154"></a>00154 <span class="comment">//! Return the pmt value that represents the integer \p x.</span>
<a name="l00155"></a>00155 <span class="comment"></span>pmt_t pmt_from_long(<span class="keywordtype">long</span> x);
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment">/*!</span>
<a name="l00158"></a>00158 <span class="comment"> * \brief Convert pmt to long if possible.</span>
<a name="l00159"></a>00159 <span class="comment"> *</span>
<a name="l00160"></a>00160 <span class="comment"> * When \p x represents an exact integer that fits in a long,</span>
<a name="l00161"></a>00161 <span class="comment"> * return that integer. Else raise an exception, either wrong_type</span>
<a name="l00162"></a>00162 <span class="comment"> * when x is not an exact integer, or out_of_range when it doesn't fit.</span>
<a name="l00163"></a>00163 <span class="comment"> */</span>
<a name="l00164"></a>00164 <span class="keywordtype">long</span> pmt_to_long(pmt_t x);
<a name="l00165"></a>00165
<a name="l00166"></a>00166 <span class="comment">/*</span>
<a name="l00167"></a>00167 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00168"></a>00168 <span class="comment"> * Reals</span>
<a name="l00169"></a>00169 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00170"></a>00170 <span class="comment"> */</span>
<a name="l00171"></a>00171
<a name="l00172"></a>00172 <span class="comment">/*</span>
<a name="l00173"></a>00173 <span class="comment"> * \brief Return true if \p obj is a real number, else false.</span>
<a name="l00174"></a>00174 <span class="comment"> */</span>
<a name="l00175"></a>00175 <span class="keywordtype">bool</span> pmt_is_real(pmt_t obj);
<a name="l00176"></a>00176 <span class="comment"></span>
<a name="l00177"></a>00177 <span class="comment">//! Return the pmt value that represents double \p x.</span>
<a name="l00178"></a>00178 <span class="comment"></span>pmt_t pmt_from_double(<span class="keywordtype">double</span> x);
<a name="l00179"></a>00179 <span class="comment"></span>
<a name="l00180"></a>00180 <span class="comment">/*!</span>
<a name="l00181"></a>00181 <span class="comment"> * \brief Convert pmt to double if possible.</span>
<a name="l00182"></a>00182 <span class="comment"> *</span>
<a name="l00183"></a>00183 <span class="comment"> * Returns the number closest to \p val that is representable</span>
<a name="l00184"></a>00184 <span class="comment"> * as a double. The argument \p val must be a real or integer, otherwise</span>
<a name="l00185"></a>00185 <span class="comment"> * a wrong_type exception is raised.</span>
<a name="l00186"></a>00186 <span class="comment"> */</span>
<a name="l00187"></a>00187 <span class="keywordtype">double</span> pmt_to_double(pmt_t x);
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">/*</span>
<a name="l00190"></a>00190 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00191"></a>00191 <span class="comment"> * Complex</span>
<a name="l00192"></a>00192 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00193"></a>00193 <span class="comment"> */</span>
<a name="l00194"></a>00194 <span class="comment"></span>
<a name="l00195"></a>00195 <span class="comment">/*!</span>
<a name="l00196"></a>00196 <span class="comment"> * \brief return true if \p obj is a complex number, false otherwise.</span>
<a name="l00197"></a>00197 <span class="comment"> */</span>
<a name="l00198"></a>00198 <span class="keywordtype">bool</span> pmt_is_complex(pmt_t obj);
<a name="l00199"></a>00199 <span class="comment"></span>
<a name="l00200"></a>00200 <span class="comment">//! Return a complex number constructed of the given real and imaginary parts.</span>
<a name="l00201"></a>00201 <span class="comment"></span>pmt_t pmt_make_rectangular(<span class="keywordtype">double</span> re, <span class="keywordtype">double</span> im);
<a name="l00202"></a>00202 <span class="comment"></span>
<a name="l00203"></a>00203 <span class="comment">/*!</span>
<a name="l00204"></a>00204 <span class="comment"> * If \p z is complex, real or integer, return the closest complex<double>.</span>
<a name="l00205"></a>00205 <span class="comment"> * Otherwise, raise the wrong_type exception.</span>
<a name="l00206"></a>00206 <span class="comment"> */</span>
<a name="l00207"></a>00207 std::complex<double> pmt_to_complex(pmt_t z);
<a name="l00208"></a>00208
<a name="l00209"></a>00209 <span class="comment">/*</span>
<a name="l00210"></a>00210 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00211"></a>00211 <span class="comment"> * Pairs</span>
<a name="l00212"></a>00212 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00213"></a>00213 <span class="comment"> */</span>
<a name="l00214"></a>00214
<a name="l00215"></a>00215 <span class="keyword">extern</span> <span class="keyword">const</span> pmt_t PMT_NIL; <span class="comment">//< the empty list</span>
<a name="l00216"></a>00216 <span class="comment"></span>
<a name="l00217"></a>00217 <span class="comment">//! Return true if \p x is the empty list, otherwise return false.</span>
<a name="l00218"></a>00218 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_null(<span class="keyword">const</span> pmt_t& x);
<a name="l00219"></a>00219 <span class="comment"></span>
<a name="l00220"></a>00220 <span class="comment">//! Return true if \p obj is a pair, else false.</span>
<a name="l00221"></a>00221 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_pair(<span class="keyword">const</span> pmt_t& obj);
<a name="l00222"></a>00222 <span class="comment"></span>
<a name="l00223"></a>00223 <span class="comment">//! Return a newly allocated pair whose car is \p x and whose cdr is \p y.</span>
<a name="l00224"></a>00224 <span class="comment"></span>pmt_t pmt_cons(<span class="keyword">const</span> pmt_t& x, <span class="keyword">const</span> pmt_t& y);
<a name="l00225"></a>00225 <span class="comment"></span>
<a name="l00226"></a>00226 <span class="comment">//! If \p pair is a pair, return the car of the \p pair, otherwise raise wrong_type.</span>
<a name="l00227"></a>00227 <span class="comment"></span>pmt_t pmt_car(<span class="keyword">const</span> pmt_t& pair);
<a name="l00228"></a>00228 <span class="comment"></span>
<a name="l00229"></a>00229 <span class="comment">//! If \p pair is a pair, return the cdr of the \p pair, otherwise raise wrong_type.</span>
<a name="l00230"></a>00230 <span class="comment"></span>pmt_t pmt_cdr(<span class="keyword">const</span> pmt_t& pair);
<a name="l00231"></a>00231 <span class="comment"></span>
<a name="l00232"></a>00232 <span class="comment">//! Stores \p value in the car field of \p pair.</span>
<a name="l00233"></a>00233 <span class="comment"></span><span class="keywordtype">void</span> pmt_set_car(pmt_t pair, pmt_t value);
<a name="l00234"></a>00234 <span class="comment"></span>
<a name="l00235"></a>00235 <span class="comment">//! Stores \p value in the cdr field of \p pair.</span>
<a name="l00236"></a>00236 <span class="comment"></span><span class="keywordtype">void</span> pmt_set_cdr(pmt_t pair, pmt_t value);
<a name="l00237"></a>00237
<a name="l00238"></a>00238 pmt_t pmt_caar(pmt_t pair);
<a name="l00239"></a>00239 pmt_t pmt_cadr(pmt_t pair);
<a name="l00240"></a>00240 pmt_t pmt_cdar(pmt_t pair);
<a name="l00241"></a>00241 pmt_t pmt_cddr(pmt_t pair);
<a name="l00242"></a>00242 pmt_t pmt_caddr(pmt_t pair);
<a name="l00243"></a>00243 pmt_t pmt_cadddr(pmt_t pair);
<a name="l00244"></a>00244
<a name="l00245"></a>00245 <span class="comment">/*</span>
<a name="l00246"></a>00246 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00247"></a>00247 <span class="comment"> * Tuples</span>
<a name="l00248"></a>00248 <span class="comment"> *</span>
<a name="l00249"></a>00249 <span class="comment"> * Store a fixed number of objects. Tuples are not modifiable, and thus</span>
<a name="l00250"></a>00250 <span class="comment"> * are excellent for use as messages. Indexing is zero based.</span>
<a name="l00251"></a>00251 <span class="comment"> * Access time to an element is O(1).</span>
<a name="l00252"></a>00252 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00253"></a>00253 <span class="comment"> */</span>
<a name="l00254"></a>00254 <span class="comment"></span>
<a name="l00255"></a>00255 <span class="comment">//! Return true if \p x is a tuple, othewise false.</span>
<a name="l00256"></a>00256 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_tuple(pmt_t x);
<a name="l00257"></a>00257
<a name="l00258"></a>00258 pmt_t pmt_make_tuple();
<a name="l00259"></a>00259 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0);
<a name="l00260"></a>00260 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1);
<a name="l00261"></a>00261 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2);
<a name="l00262"></a>00262 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3);
<a name="l00263"></a>00263 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4);
<a name="l00264"></a>00264 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4, <span class="keyword">const</span> pmt_t &e5);
<a name="l00265"></a>00265 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4, <span class="keyword">const</span> pmt_t &e5, <span class="keyword">const</span> pmt_t &e6);
<a name="l00266"></a>00266 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4, <span class="keyword">const</span> pmt_t &e5, <span class="keyword">const</span> pmt_t &e6, <span class="keyword">const</span> pmt_t &e7);
<a name="l00267"></a>00267 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4, <span class="keyword">const</span> pmt_t &e5, <span class="keyword">const</span> pmt_t &e6, <span class="keyword">const</span> pmt_t &e7, <span class="keyword">const</span> pmt_t &e8);
<a name="l00268"></a>00268 pmt_t pmt_make_tuple(<span class="keyword">const</span> pmt_t &e0, <span class="keyword">const</span> pmt_t &e1, <span class="keyword">const</span> pmt_t &e2, <span class="keyword">const</span> pmt_t &e3, <span class="keyword">const</span> pmt_t &e4, <span class="keyword">const</span> pmt_t &e5, <span class="keyword">const</span> pmt_t &e6, <span class="keyword">const</span> pmt_t &e7, <span class="keyword">const</span> pmt_t &e8, <span class="keyword">const</span> pmt_t &e9);
<a name="l00269"></a>00269 <span class="comment"></span>
<a name="l00270"></a>00270 <span class="comment">/*!</span>
<a name="l00271"></a>00271 <span class="comment"> * If \p x is a vector or proper list, return a tuple containing the elements of x</span>
<a name="l00272"></a>00272 <span class="comment"> */</span>
<a name="l00273"></a>00273 pmt_t pmt_to_tuple(<span class="keyword">const</span> pmt_t &x);
<a name="l00274"></a>00274 <span class="comment"></span>
<a name="l00275"></a>00275 <span class="comment">/*!</span>
<a name="l00276"></a>00276 <span class="comment"> * Return the contents of position \p k of \p tuple.</span>
<a name="l00277"></a>00277 <span class="comment"> * \p k must be a valid index of \p tuple.</span>
<a name="l00278"></a>00278 <span class="comment"> */</span>
<a name="l00279"></a>00279 pmt_t pmt_tuple_ref(<span class="keyword">const</span> pmt_t &tuple, <span class="keywordtype">size_t</span> k);
<a name="l00280"></a>00280
<a name="l00281"></a>00281 <span class="comment">/*</span>
<a name="l00282"></a>00282 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00283"></a>00283 <span class="comment"> * Vectors</span>
<a name="l00284"></a>00284 <span class="comment"> *</span>
<a name="l00285"></a>00285 <span class="comment"> * These vectors can hold any kind of objects. Indexing is zero based.</span>
<a name="l00286"></a>00286 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00287"></a>00287 <span class="comment"> */</span>
<a name="l00288"></a>00288 <span class="comment"></span>
<a name="l00289"></a>00289 <span class="comment">//! Return true if \p x is a vector, othewise false.</span>
<a name="l00290"></a>00290 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_vector(pmt_t x);
<a name="l00291"></a>00291 <span class="comment"></span>
<a name="l00292"></a>00292 <span class="comment">//! Make a vector of length \p k, with initial values set to \p fill</span>
<a name="l00293"></a>00293 <span class="comment"></span>pmt_t pmt_make_vector(<span class="keywordtype">size_t</span> k, pmt_t fill);
<a name="l00294"></a>00294 <span class="comment"></span>
<a name="l00295"></a>00295 <span class="comment">/*!</span>
<a name="l00296"></a>00296 <span class="comment"> * Return the contents of position \p k of \p vector.</span>
<a name="l00297"></a>00297 <span class="comment"> * \p k must be a valid index of \p vector.</span>
<a name="l00298"></a>00298 <span class="comment"> */</span>
<a name="l00299"></a>00299 pmt_t pmt_vector_ref(pmt_t vector, <span class="keywordtype">size_t</span> k);
<a name="l00300"></a>00300 <span class="comment"></span>
<a name="l00301"></a>00301 <span class="comment">//! Store \p obj in position \p k.</span>
<a name="l00302"></a>00302 <span class="comment"></span><span class="keywordtype">void</span> pmt_vector_set(pmt_t vector, <span class="keywordtype">size_t</span> k, pmt_t obj);
<a name="l00303"></a>00303 <span class="comment"></span>
<a name="l00304"></a>00304 <span class="comment">//! Store \p fill in every position of \p vector</span>
<a name="l00305"></a>00305 <span class="comment"></span><span class="keywordtype">void</span> pmt_vector_fill(pmt_t vector, pmt_t fill);
<a name="l00306"></a>00306
<a name="l00307"></a>00307 <span class="comment">/*</span>
<a name="l00308"></a>00308 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00309"></a>00309 <span class="comment"> * Binary Large Objects (BLOBs)</span>
<a name="l00310"></a>00310 <span class="comment"> *</span>
<a name="l00311"></a>00311 <span class="comment"> * Handy for passing around uninterpreted chunks of memory.</span>
<a name="l00312"></a>00312 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00313"></a>00313 <span class="comment"> */</span>
<a name="l00314"></a>00314 <span class="comment"></span>
<a name="l00315"></a>00315 <span class="comment">//! Return true if \p x is a blob, othewise false.</span>
<a name="l00316"></a>00316 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_blob(pmt_t x);
<a name="l00317"></a>00317 <span class="comment"></span>
<a name="l00318"></a>00318 <span class="comment">/*!</span>
<a name="l00319"></a>00319 <span class="comment"> * \brief Make a blob given a pointer and length in bytes</span>
<a name="l00320"></a>00320 <span class="comment"> *</span>
<a name="l00321"></a>00321 <span class="comment"> * \param buf is the pointer to data to use to create blob</span>
<a name="l00322"></a>00322 <span class="comment"> * \param len is the size of the data in bytes.</span>
<a name="l00323"></a>00323 <span class="comment"> *</span>
<a name="l00324"></a>00324 <span class="comment"> * The data is copied into the blob.</span>
<a name="l00325"></a>00325 <span class="comment"> */</span>
<a name="l00326"></a>00326 pmt_t pmt_make_blob(<span class="keyword">const</span> <span class="keywordtype">void</span> *buf, <span class="keywordtype">size_t</span> len);
<a name="l00327"></a>00327 <span class="comment"></span>
<a name="l00328"></a>00328 <span class="comment">//! Return a pointer to the blob's data</span>
<a name="l00329"></a>00329 <span class="comment"></span><span class="keyword">const</span> <span class="keywordtype">void</span> *pmt_blob_data(pmt_t blob);
<a name="l00330"></a>00330 <span class="comment"></span>
<a name="l00331"></a>00331 <span class="comment">//! Return the blob's length in bytes</span>
<a name="l00332"></a>00332 <span class="comment"></span><span class="keywordtype">size_t</span> pmt_blob_length(pmt_t blob);
<a name="l00333"></a>00333 <span class="comment"></span>
<a name="l00334"></a>00334 <span class="comment">/*!</span>
<a name="l00335"></a>00335 <span class="comment"> * <pre></span>
<a name="l00336"></a>00336 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00337"></a>00337 <span class="comment"> * Uniform Numeric Vectors</span>
<a name="l00338"></a>00338 <span class="comment"> *</span>
<a name="l00339"></a>00339 <span class="comment"> * A uniform numeric vector is a vector whose elements are all of single</span>
<a name="l00340"></a>00340 <span class="comment"> * numeric type. pmt offers uniform numeric vectors for signed and</span>
<a name="l00341"></a>00341 <span class="comment"> * unsigned 8-bit, 16-bit, 32-bit, and 64-bit integers, two sizes of</span>
<a name="l00342"></a>00342 <span class="comment"> * floating point values, and complex floating-point numbers of these</span>
<a name="l00343"></a>00343 <span class="comment"> * two sizes. Indexing is zero based.</span>
<a name="l00344"></a>00344 <span class="comment"> *</span>
<a name="l00345"></a>00345 <span class="comment"> * The names of the functions include these tags in their names:</span>
<a name="l00346"></a>00346 <span class="comment"> *</span>
<a name="l00347"></a>00347 <span class="comment"> * u8 unsigned 8-bit integers</span>
<a name="l00348"></a>00348 <span class="comment"> * s8 signed 8-bit integers</span>
<a name="l00349"></a>00349 <span class="comment"> * u16 unsigned 16-bit integers</span>
<a name="l00350"></a>00350 <span class="comment"> * s16 signed 16-bit integers</span>
<a name="l00351"></a>00351 <span class="comment"> * u32 unsigned 32-bit integers</span>
<a name="l00352"></a>00352 <span class="comment"> * s32 signed 32-bit integers</span>
<a name="l00353"></a>00353 <span class="comment"> * u64 unsigned 64-bit integers</span>
<a name="l00354"></a>00354 <span class="comment"> * s64 signed 64-bit integers</span>
<a name="l00355"></a>00355 <span class="comment"> * f32 the C++ type float</span>
<a name="l00356"></a>00356 <span class="comment"> * f64 the C++ type double</span>
<a name="l00357"></a>00357 <span class="comment"> * c32 the C++ type complex<float></span>
<a name="l00358"></a>00358 <span class="comment"> * c64 the C++ type complex<double></span>
<a name="l00359"></a>00359 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00360"></a>00360 <span class="comment"> * </pre></span>
<a name="l00361"></a>00361 <span class="comment"> */</span>
<a name="l00362"></a>00362 <span class="comment"></span>
<a name="l00363"></a>00363 <span class="comment">//! true if \p x is any kind of uniform numeric vector</span>
<a name="l00364"></a>00364 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_uniform_vector(pmt_t x);
<a name="l00365"></a>00365
<a name="l00366"></a>00366 <span class="keywordtype">bool</span> pmt_is_u8vector(pmt_t x);
<a name="l00367"></a>00367 <span class="keywordtype">bool</span> pmt_is_s8vector(pmt_t x);
<a name="l00368"></a>00368 <span class="keywordtype">bool</span> pmt_is_u16vector(pmt_t x);
<a name="l00369"></a>00369 <span class="keywordtype">bool</span> pmt_is_s16vector(pmt_t x);
<a name="l00370"></a>00370 <span class="keywordtype">bool</span> pmt_is_u32vector(pmt_t x);
<a name="l00371"></a>00371 <span class="keywordtype">bool</span> pmt_is_s32vector(pmt_t x);
<a name="l00372"></a>00372 <span class="keywordtype">bool</span> pmt_is_u64vector(pmt_t x);
<a name="l00373"></a>00373 <span class="keywordtype">bool</span> pmt_is_s64vector(pmt_t x);
<a name="l00374"></a>00374 <span class="keywordtype">bool</span> pmt_is_f32vector(pmt_t x);
<a name="l00375"></a>00375 <span class="keywordtype">bool</span> pmt_is_f64vector(pmt_t x);
<a name="l00376"></a>00376 <span class="keywordtype">bool</span> pmt_is_c32vector(pmt_t x);
<a name="l00377"></a>00377 <span class="keywordtype">bool</span> pmt_is_c64vector(pmt_t x);
<a name="l00378"></a>00378
<a name="l00379"></a>00379 pmt_t pmt_make_u8vector(<span class="keywordtype">size_t</span> k, uint8_t fill);
<a name="l00380"></a>00380 pmt_t pmt_make_s8vector(<span class="keywordtype">size_t</span> k, int8_t fill);
<a name="l00381"></a>00381 pmt_t pmt_make_u16vector(<span class="keywordtype">size_t</span> k, uint16_t fill);
<a name="l00382"></a>00382 pmt_t pmt_make_s16vector(<span class="keywordtype">size_t</span> k, int16_t fill);
<a name="l00383"></a>00383 pmt_t pmt_make_u32vector(<span class="keywordtype">size_t</span> k, uint32_t fill);
<a name="l00384"></a>00384 pmt_t pmt_make_s32vector(<span class="keywordtype">size_t</span> k, int32_t fill);
<a name="l00385"></a>00385 pmt_t pmt_make_u64vector(<span class="keywordtype">size_t</span> k, uint64_t fill);
<a name="l00386"></a>00386 pmt_t pmt_make_s64vector(<span class="keywordtype">size_t</span> k, int64_t fill);
<a name="l00387"></a>00387 pmt_t pmt_make_f32vector(<span class="keywordtype">size_t</span> k, <span class="keywordtype">float</span> fill);
<a name="l00388"></a>00388 pmt_t pmt_make_f64vector(<span class="keywordtype">size_t</span> k, <span class="keywordtype">double</span> fill);
<a name="l00389"></a>00389 pmt_t pmt_make_c32vector(<span class="keywordtype">size_t</span> k, std::complex<float> fill);
<a name="l00390"></a>00390 pmt_t pmt_make_c64vector(<span class="keywordtype">size_t</span> k, std::complex<double> fill);
<a name="l00391"></a>00391
<a name="l00392"></a>00392 pmt_t pmt_init_u8vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> uint8_t *data);
<a name="l00393"></a>00393 pmt_t pmt_init_s8vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> int8_t *data);
<a name="l00394"></a>00394 pmt_t pmt_init_u16vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> uint16_t *data);
<a name="l00395"></a>00395 pmt_t pmt_init_s16vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> int16_t *data);
<a name="l00396"></a>00396 pmt_t pmt_init_u32vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> uint32_t *data);
<a name="l00397"></a>00397 pmt_t pmt_init_s32vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> int32_t *data);
<a name="l00398"></a>00398 pmt_t pmt_init_u64vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> uint64_t *data);
<a name="l00399"></a>00399 pmt_t pmt_init_s64vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> int64_t *data);
<a name="l00400"></a>00400 pmt_t pmt_init_f32vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> <span class="keywordtype">float</span> *data);
<a name="l00401"></a>00401 pmt_t pmt_init_f64vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> <span class="keywordtype">double</span> *data);
<a name="l00402"></a>00402 pmt_t pmt_init_c32vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> std::complex<float> *data);
<a name="l00403"></a>00403 pmt_t pmt_init_c64vector(<span class="keywordtype">size_t</span> k, <span class="keyword">const</span> std::complex<double> *data);
<a name="l00404"></a>00404
<a name="l00405"></a>00405 uint8_t pmt_u8vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00406"></a>00406 int8_t pmt_s8vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00407"></a>00407 uint16_t pmt_u16vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00408"></a>00408 int16_t pmt_s16vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00409"></a>00409 uint32_t pmt_u32vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00410"></a>00410 int32_t pmt_s32vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00411"></a>00411 uint64_t pmt_u64vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00412"></a>00412 int64_t pmt_s64vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00413"></a>00413 <span class="keywordtype">float</span> pmt_f32vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00414"></a>00414 <span class="keywordtype">double</span> pmt_f64vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00415"></a>00415 std::complex<float> pmt_c32vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00416"></a>00416 std::complex<double> pmt_c64vector_ref(pmt_t v, <span class="keywordtype">size_t</span> k);
<a name="l00417"></a>00417
<a name="l00418"></a>00418 <span class="keywordtype">void</span> pmt_u8vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, uint8_t x); <span class="comment">//< v[k] = x</span>
<a name="l00419"></a>00419 <span class="keywordtype">void</span> pmt_s8vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, int8_t x);
<a name="l00420"></a>00420 <span class="keywordtype">void</span> pmt_u16vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, uint16_t x);
<a name="l00421"></a>00421 <span class="keywordtype">void</span> pmt_s16vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, int16_t x);
<a name="l00422"></a>00422 <span class="keywordtype">void</span> pmt_u32vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, uint32_t x);
<a name="l00423"></a>00423 <span class="keywordtype">void</span> pmt_s32vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, int32_t x);
<a name="l00424"></a>00424 <span class="keywordtype">void</span> pmt_u64vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, uint64_t x);
<a name="l00425"></a>00425 <span class="keywordtype">void</span> pmt_s64vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, int64_t x);
<a name="l00426"></a>00426 <span class="keywordtype">void</span> pmt_f32vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, <span class="keywordtype">float</span> x);
<a name="l00427"></a>00427 <span class="keywordtype">void</span> pmt_f64vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, <span class="keywordtype">double</span> x);
<a name="l00428"></a>00428 <span class="keywordtype">void</span> pmt_c32vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, std::complex<float> x);
<a name="l00429"></a>00429 <span class="keywordtype">void</span> pmt_c64vector_set(pmt_t v, <span class="keywordtype">size_t</span> k, std::complex<double> x);
<a name="l00430"></a>00430
<a name="l00431"></a>00431 <span class="comment">// Return const pointers to the elements</span>
<a name="l00432"></a>00432
<a name="l00433"></a>00433 <span class="keyword">const</span> <span class="keywordtype">void</span> *pmt_uniform_vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< works with any; len is in bytes</span>
<a name="l00434"></a>00434
<a name="l00435"></a>00435 <span class="keyword">const</span> uint8_t *pmt_u8vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00436"></a>00436 <span class="keyword">const</span> int8_t *pmt_s8vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00437"></a>00437 <span class="keyword">const</span> uint16_t *pmt_u16vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00438"></a>00438 <span class="keyword">const</span> int16_t *pmt_s16vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00439"></a>00439 <span class="keyword">const</span> uint32_t *pmt_u32vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00440"></a>00440 <span class="keyword">const</span> int32_t *pmt_s32vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00441"></a>00441 <span class="keyword">const</span> uint64_t *pmt_u64vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00442"></a>00442 <span class="keyword">const</span> int64_t *pmt_s64vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00443"></a>00443 <span class="keyword">const</span> <span class="keywordtype">float</span> *pmt_f32vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00444"></a>00444 <span class="keyword">const</span> <span class="keywordtype">double</span> *pmt_f64vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00445"></a>00445 <span class="keyword">const</span> std::complex<float> *pmt_c32vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00446"></a>00446 <span class="keyword">const</span> std::complex<double> *pmt_c64vector_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00447"></a>00447
<a name="l00448"></a>00448 <span class="comment">// Return non-const pointers to the elements</span>
<a name="l00449"></a>00449
<a name="l00450"></a>00450 <span class="keywordtype">void</span> *pmt_uniform_vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< works with any; len is in bytes</span>
<a name="l00451"></a>00451
<a name="l00452"></a>00452 uint8_t *pmt_u8vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00453"></a>00453 int8_t *pmt_s8vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00454"></a>00454 uint16_t *pmt_u16vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00455"></a>00455 int16_t *pmt_s16vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00456"></a>00456 uint32_t *pmt_u32vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00457"></a>00457 int32_t *pmt_s32vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00458"></a>00458 uint64_t *pmt_u64vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00459"></a>00459 int64_t *pmt_s64vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00460"></a>00460 <span class="keywordtype">float</span> *pmt_f32vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00461"></a>00461 <span class="keywordtype">double</span> *pmt_f64vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00462"></a>00462 std::complex<float> *pmt_c32vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00463"></a>00463 std::complex<double> *pmt_c64vector_writable_elements(pmt_t v, <span class="keywordtype">size_t</span> &len); <span class="comment">//< len is in elements</span>
<a name="l00464"></a>00464
<a name="l00465"></a>00465 <span class="comment">/*</span>
<a name="l00466"></a>00466 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00467"></a>00467 <span class="comment"> * Dictionary (a.k.a associative array, hash, map)</span>
<a name="l00468"></a>00468 <span class="comment"> *</span>
<a name="l00469"></a>00469 <span class="comment"> * This is a functional data structure that is persistent. Updating a</span>
<a name="l00470"></a>00470 <span class="comment"> * functional data structure does not destroy the existing version, but</span>
<a name="l00471"></a>00471 <span class="comment"> * rather creates a new version that coexists with the old.</span>
<a name="l00472"></a>00472 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00473"></a>00473 <span class="comment"> */</span>
<a name="l00474"></a>00474 <span class="comment"></span>
<a name="l00475"></a>00475 <span class="comment">//! Return true if \p obj is a dictionary</span>
<a name="l00476"></a>00476 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_dict(<span class="keyword">const</span> pmt_t &obj);
<a name="l00477"></a>00477 <span class="comment"></span>
<a name="l00478"></a>00478 <span class="comment">//! Make an empty dictionary</span>
<a name="l00479"></a>00479 <span class="comment"></span>pmt_t pmt_make_dict();
<a name="l00480"></a>00480 <span class="comment"></span>
<a name="l00481"></a>00481 <span class="comment">//! Return a new dictionary with \p key associated with \p value.</span>
<a name="l00482"></a>00482 <span class="comment"></span>pmt_t pmt_dict_add(<span class="keyword">const</span> pmt_t &dict, <span class="keyword">const</span> pmt_t &key, <span class="keyword">const</span> pmt_t &value);
<a name="l00483"></a>00483 <span class="comment"></span>
<a name="l00484"></a>00484 <span class="comment">//! Return a new dictionary with \p key removed.</span>
<a name="l00485"></a>00485 <span class="comment"></span>pmt_t pmt_dict_delete(<span class="keyword">const</span> pmt_t &dict, <span class="keyword">const</span> pmt_t &key);
<a name="l00486"></a>00486 <span class="comment"></span>
<a name="l00487"></a>00487 <span class="comment">//! Return true if \p key exists in \p dict</span>
<a name="l00488"></a>00488 <span class="comment"></span><span class="keywordtype">bool</span> pmt_dict_has_key(<span class="keyword">const</span> pmt_t &dict, <span class="keyword">const</span> pmt_t &key);
<a name="l00489"></a>00489 <span class="comment"></span>
<a name="l00490"></a>00490 <span class="comment">//! If \p key exists in \p dict, return associated value; otherwise return \p not_found.</span>
<a name="l00491"></a>00491 <span class="comment"></span>pmt_t pmt_dict_ref(<span class="keyword">const</span> pmt_t &dict, <span class="keyword">const</span> pmt_t &key, <span class="keyword">const</span> pmt_t &not_found);
<a name="l00492"></a>00492 <span class="comment"></span>
<a name="l00493"></a>00493 <span class="comment">//! Return list of (key . value) pairs</span>
<a name="l00494"></a>00494 <span class="comment"></span>pmt_t pmt_dict_items(pmt_t dict);
<a name="l00495"></a>00495 <span class="comment"></span>
<a name="l00496"></a>00496 <span class="comment">//! Return list of keys</span>
<a name="l00497"></a>00497 <span class="comment"></span>pmt_t pmt_dict_keys(pmt_t dict);
<a name="l00498"></a>00498 <span class="comment"></span>
<a name="l00499"></a>00499 <span class="comment">//! Return list of values</span>
<a name="l00500"></a>00500 <span class="comment"></span>pmt_t pmt_dict_values(pmt_t dict);
<a name="l00501"></a>00501
<a name="l00502"></a>00502 <span class="comment">/*</span>
<a name="l00503"></a>00503 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00504"></a>00504 <span class="comment"> * Any (wraps boost::any -- can be used to wrap pretty much anything)</span>
<a name="l00505"></a>00505 <span class="comment"> *</span>
<a name="l00506"></a>00506 <span class="comment"> * Cannot be serialized or used across process boundaries.</span>
<a name="l00507"></a>00507 <span class="comment"> * See http://www.boost.org/doc/html/any.html</span>
<a name="l00508"></a>00508 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00509"></a>00509 <span class="comment"> */</span>
<a name="l00510"></a>00510 <span class="comment"></span>
<a name="l00511"></a>00511 <span class="comment">//! Return true if \p obj is an any</span>
<a name="l00512"></a>00512 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_any(pmt_t obj);
<a name="l00513"></a>00513 <span class="comment"></span>
<a name="l00514"></a>00514 <span class="comment">//! make an any</span>
<a name="l00515"></a>00515 <span class="comment"></span>pmt_t pmt_make_any(<span class="keyword">const</span> boost::any &any);
<a name="l00516"></a>00516 <span class="comment"></span>
<a name="l00517"></a>00517 <span class="comment">//! Return underlying boost::any</span>
<a name="l00518"></a>00518 <span class="comment"></span>boost::any pmt_any_ref(pmt_t obj);
<a name="l00519"></a>00519 <span class="comment"></span>
<a name="l00520"></a>00520 <span class="comment">//! Store \p any in \p obj</span>
<a name="l00521"></a>00521 <span class="comment"></span><span class="keywordtype">void</span> pmt_any_set(pmt_t obj, <span class="keyword">const</span> boost::any &any);
<a name="l00522"></a>00522
<a name="l00523"></a>00523
<a name="l00524"></a>00524 <span class="comment">/*</span>
<a name="l00525"></a>00525 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00526"></a>00526 <span class="comment"> * msg_accepter -- pmt representation of gruel::msg_accepter</span>
<a name="l00527"></a>00527 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00528"></a>00528 <span class="comment"> */</span><span class="comment"></span>
<a name="l00529"></a>00529 <span class="comment">//! Return true if \p obj is a msg_accepter</span>
<a name="l00530"></a>00530 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_msg_accepter(<span class="keyword">const</span> pmt_t &obj);
<a name="l00531"></a>00531 <span class="comment"></span>
<a name="l00532"></a>00532 <span class="comment">//! make a msg_accepter</span>
<a name="l00533"></a>00533 <span class="comment"></span>pmt_t pmt_make_msg_accepter(<a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gruel::msg_accepter></a> ma);
<a name="l00534"></a>00534 <span class="comment"></span>
<a name="l00535"></a>00535 <span class="comment">//! Return underlying msg_accepter</span>
<a name="l00536"></a>00536 <span class="comment"></span><a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">boost::shared_ptr<gruel::msg_accepter></a> pmt_msg_accepter_ref(<span class="keyword">const</span> pmt_t &obj);
<a name="l00537"></a>00537
<a name="l00538"></a>00538 <span class="comment">/*</span>
<a name="l00539"></a>00539 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00540"></a>00540 <span class="comment"> * General functions</span>
<a name="l00541"></a>00541 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00542"></a>00542 <span class="comment"> */</span>
<a name="l00543"></a>00543 <span class="comment"></span>
<a name="l00544"></a>00544 <span class="comment">//! Return true if x and y are the same object; otherwise return false.</span>
<a name="l00545"></a>00545 <span class="comment"></span><span class="keywordtype">bool</span> pmt_eq(<span class="keyword">const</span> pmt_t& x, <span class="keyword">const</span> pmt_t& y);
<a name="l00546"></a>00546 <span class="comment"></span>
<a name="l00547"></a>00547 <span class="comment">/*!</span>
<a name="l00548"></a>00548 <span class="comment"> * \brief Return true if x and y should normally be regarded as the same object, else false.</span>
<a name="l00549"></a>00549 <span class="comment"> *</span>
<a name="l00550"></a>00550 <span class="comment"> * <pre></span>
<a name="l00551"></a>00551 <span class="comment"> * eqv returns true if:</span>
<a name="l00552"></a>00552 <span class="comment"> * x and y are the same object.</span>
<a name="l00553"></a>00553 <span class="comment"> * x and y are both \#t or both \#f.</span>
<a name="l00554"></a>00554 <span class="comment"> * x and y are both symbols and their names are the same.</span>
<a name="l00555"></a>00555 <span class="comment"> * x and y are both numbers, and are numerically equal.</span>
<a name="l00556"></a>00556 <span class="comment"> * x and y are both the empty list (nil).</span>
<a name="l00557"></a>00557 <span class="comment"> * x and y are pairs or vectors that denote same location in store.</span>
<a name="l00558"></a>00558 <span class="comment"> * </pre></span>
<a name="l00559"></a>00559 <span class="comment"> */</span>
<a name="l00560"></a>00560 <span class="keywordtype">bool</span> pmt_eqv(<span class="keyword">const</span> pmt_t& x, <span class="keyword">const</span> pmt_t& y);
<a name="l00561"></a>00561 <span class="comment"></span>
<a name="l00562"></a>00562 <span class="comment">/*!</span>
<a name="l00563"></a>00563 <span class="comment"> * pmt_equal recursively compares the contents of pairs and vectors,</span>
<a name="l00564"></a>00564 <span class="comment"> * applying pmt_eqv on other objects such as numbers and symbols. </span>
<a name="l00565"></a>00565 <span class="comment"> * pmt_equal may fail to terminate if its arguments are circular data</span>
<a name="l00566"></a>00566 <span class="comment"> * structures.</span>
<a name="l00567"></a>00567 <span class="comment"> */</span>
<a name="l00568"></a>00568 <span class="keywordtype">bool</span> pmt_equal(<span class="keyword">const</span> pmt_t& x, <span class="keyword">const</span> pmt_t& y);
<a name="l00569"></a>00569
<a name="l00570"></a>00570 <span class="comment"></span>
<a name="l00571"></a>00571 <span class="comment">//! Return the number of elements in v</span>
<a name="l00572"></a>00572 <span class="comment"></span><span class="keywordtype">size_t</span> pmt_length(<span class="keyword">const</span> pmt_t& v);
<a name="l00573"></a>00573 <span class="comment"></span>
<a name="l00574"></a>00574 <span class="comment">/*!</span>
<a name="l00575"></a>00575 <span class="comment"> * \brief Find the first pair in \p alist whose car field is \p obj</span>
<a name="l00576"></a>00576 <span class="comment"> * and return that pair.</span>
<a name="l00577"></a>00577 <span class="comment"> *</span>
<a name="l00578"></a>00578 <span class="comment"> * \p alist (for "association list") must be a list of pairs. If no pair</span>
<a name="l00579"></a>00579 <span class="comment"> * in \p alist has \p obj as its car then \#f is returned.</span>
<a name="l00580"></a>00580 <span class="comment"> * Uses pmt_eq to compare \p obj with car fields of the pairs in \p alist.</span>
<a name="l00581"></a>00581 <span class="comment"> */</span>
<a name="l00582"></a>00582 pmt_t pmt_assq(pmt_t obj, pmt_t alist);
<a name="l00583"></a>00583 <span class="comment"></span>
<a name="l00584"></a>00584 <span class="comment">/*!</span>
<a name="l00585"></a>00585 <span class="comment"> * \brief Find the first pair in \p alist whose car field is \p obj</span>
<a name="l00586"></a>00586 <span class="comment"> * and return that pair.</span>
<a name="l00587"></a>00587 <span class="comment"> *</span>
<a name="l00588"></a>00588 <span class="comment"> * \p alist (for "association list") must be a list of pairs. If no pair</span>
<a name="l00589"></a>00589 <span class="comment"> * in \p alist has \p obj as its car then \#f is returned.</span>
<a name="l00590"></a>00590 <span class="comment"> * Uses pmt_eqv to compare \p obj with car fields of the pairs in \p alist.</span>
<a name="l00591"></a>00591 <span class="comment"> */</span>
<a name="l00592"></a>00592 pmt_t pmt_assv(pmt_t obj, pmt_t alist);
<a name="l00593"></a>00593 <span class="comment"></span>
<a name="l00594"></a>00594 <span class="comment">/*!</span>
<a name="l00595"></a>00595 <span class="comment"> * \brief Find the first pair in \p alist whose car field is \p obj</span>
<a name="l00596"></a>00596 <span class="comment"> * and return that pair.</span>
<a name="l00597"></a>00597 <span class="comment"> *</span>
<a name="l00598"></a>00598 <span class="comment"> * \p alist (for "association list") must be a list of pairs. If no pair</span>
<a name="l00599"></a>00599 <span class="comment"> * in \p alist has \p obj as its car then \#f is returned.</span>
<a name="l00600"></a>00600 <span class="comment"> * Uses pmt_equal to compare \p obj with car fields of the pairs in \p alist.</span>
<a name="l00601"></a>00601 <span class="comment"> */</span>
<a name="l00602"></a>00602 pmt_t pmt_assoc(pmt_t obj, pmt_t alist);
<a name="l00603"></a>00603 <span class="comment"></span>
<a name="l00604"></a>00604 <span class="comment">/*!</span>
<a name="l00605"></a>00605 <span class="comment"> * \brief Apply \p proc element-wise to the elements of list and returns</span>
<a name="l00606"></a>00606 <span class="comment"> * a list of the results, in order.</span>
<a name="l00607"></a>00607 <span class="comment"> *</span>
<a name="l00608"></a>00608 <span class="comment"> * \p list must be a list. The dynamic order in which \p proc is</span>
<a name="l00609"></a>00609 <span class="comment"> * applied to the elements of \p list is unspecified.</span>
<a name="l00610"></a>00610 <span class="comment"> */</span>
<a name="l00611"></a>00611 pmt_t pmt_map(pmt_t proc(<span class="keyword">const</span> pmt_t&), pmt_t list);
<a name="l00612"></a>00612 <span class="comment"></span>
<a name="l00613"></a>00613 <span class="comment">/*!</span>
<a name="l00614"></a>00614 <span class="comment"> * \brief reverse \p list.</span>
<a name="l00615"></a>00615 <span class="comment"> *</span>
<a name="l00616"></a>00616 <span class="comment"> * \p list must be a proper list.</span>
<a name="l00617"></a>00617 <span class="comment"> */</span>
<a name="l00618"></a>00618 pmt_t pmt_reverse(pmt_t list);
<a name="l00619"></a>00619 <span class="comment"></span>
<a name="l00620"></a>00620 <span class="comment">/*!</span>
<a name="l00621"></a>00621 <span class="comment"> * \brief destructively reverse \p list.</span>
<a name="l00622"></a>00622 <span class="comment"> *</span>
<a name="l00623"></a>00623 <span class="comment"> * \p list must be a proper list.</span>
<a name="l00624"></a>00624 <span class="comment"> */</span>
<a name="l00625"></a>00625 pmt_t pmt_reverse_x(pmt_t list);
<a name="l00626"></a>00626 <span class="comment"></span>
<a name="l00627"></a>00627 <span class="comment">/*!</span>
<a name="l00628"></a>00628 <span class="comment"> * \brief (acons x y a) == (cons (cons x y) a)</span>
<a name="l00629"></a>00629 <span class="comment"> */</span>
<a name="l00630"></a>00630 <span class="keyword">inline</span> <span class="keyword">static</span> pmt_t
<a name="l00631"></a>00631 pmt_acons(pmt_t x, pmt_t y, pmt_t a)
<a name="l00632"></a>00632 {
<a name="l00633"></a>00633 <span class="keywordflow">return</span> pmt_cons(pmt_cons(x, y), a);
<a name="l00634"></a>00634 }
<a name="l00635"></a>00635 <span class="comment"></span>
<a name="l00636"></a>00636 <span class="comment">/*!</span>
<a name="l00637"></a>00637 <span class="comment"> * \brief locates \p nth element of \n list where the car is the 'zeroth' element.</span>
<a name="l00638"></a>00638 <span class="comment"> */</span>
<a name="l00639"></a>00639 pmt_t pmt_nth(<span class="keywordtype">size_t</span> n, pmt_t list);
<a name="l00640"></a>00640 <span class="comment"></span>
<a name="l00641"></a>00641 <span class="comment">/*!</span>
<a name="l00642"></a>00642 <span class="comment"> * \brief returns the tail of \p list that would be obtained by calling</span>
<a name="l00643"></a>00643 <span class="comment"> * cdr \p n times in succession.</span>
<a name="l00644"></a>00644 <span class="comment"> */</span>
<a name="l00645"></a>00645 pmt_t pmt_nthcdr(<span class="keywordtype">size_t</span> n, pmt_t list);
<a name="l00646"></a>00646 <span class="comment"></span>
<a name="l00647"></a>00647 <span class="comment">/*!</span>
<a name="l00648"></a>00648 <span class="comment"> * \brief Return the first sublist of \p list whose car is \p obj.</span>
<a name="l00649"></a>00649 <span class="comment"> * If \p obj does not occur in \p list, then \#f is returned.</span>
<a name="l00650"></a>00650 <span class="comment"> * pmt_memq use pmt_eq to compare \p obj with the elements of \p list.</span>
<a name="l00651"></a>00651 <span class="comment"> */</span>
<a name="l00652"></a>00652 pmt_t pmt_memq(pmt_t obj, pmt_t list);
<a name="l00653"></a>00653 <span class="comment"></span>
<a name="l00654"></a>00654 <span class="comment">/*!</span>
<a name="l00655"></a>00655 <span class="comment"> * \brief Return the first sublist of \p list whose car is \p obj.</span>
<a name="l00656"></a>00656 <span class="comment"> * If \p obj does not occur in \p list, then \#f is returned.</span>
<a name="l00657"></a>00657 <span class="comment"> * pmt_memv use pmt_eqv to compare \p obj with the elements of \p list.</span>
<a name="l00658"></a>00658 <span class="comment"> */</span>
<a name="l00659"></a>00659 pmt_t pmt_memv(pmt_t obj, pmt_t list);
<a name="l00660"></a>00660 <span class="comment"></span>
<a name="l00661"></a>00661 <span class="comment">/*!</span>
<a name="l00662"></a>00662 <span class="comment"> * \brief Return the first sublist of \p list whose car is \p obj.</span>
<a name="l00663"></a>00663 <span class="comment"> * If \p obj does not occur in \p list, then \#f is returned.</span>
<a name="l00664"></a>00664 <span class="comment"> * pmt_member use pmt_equal to compare \p obj with the elements of \p list.</span>
<a name="l00665"></a>00665 <span class="comment"> */</span>
<a name="l00666"></a>00666 pmt_t pmt_member(pmt_t obj, pmt_t list);
<a name="l00667"></a>00667 <span class="comment"></span>
<a name="l00668"></a>00668 <span class="comment">/*!</span>
<a name="l00669"></a>00669 <span class="comment"> * \brief Return true if every element of \p list1 appears in \p list2, and false otherwise.</span>
<a name="l00670"></a>00670 <span class="comment"> * Comparisons are done with pmt_eqv.</span>
<a name="l00671"></a>00671 <span class="comment"> */</span>
<a name="l00672"></a>00672 <span class="keywordtype">bool</span> pmt_subsetp(pmt_t list1, pmt_t list2);
<a name="l00673"></a>00673 <span class="comment"></span>
<a name="l00674"></a>00674 <span class="comment">/*!</span>
<a name="l00675"></a>00675 <span class="comment"> * \brief Return a list of length 1 containing \p x1</span>
<a name="l00676"></a>00676 <span class="comment"> */</span>
<a name="l00677"></a>00677 pmt_t pmt_list1(<span class="keyword">const</span> pmt_t& x1);
<a name="l00678"></a>00678 <span class="comment"></span>
<a name="l00679"></a>00679 <span class="comment">/*!</span>
<a name="l00680"></a>00680 <span class="comment"> * \brief Return a list of length 2 containing \p x1, \p x2</span>
<a name="l00681"></a>00681 <span class="comment"> */</span>
<a name="l00682"></a>00682 pmt_t pmt_list2(<span class="keyword">const</span> pmt_t& x1, <span class="keyword">const</span> pmt_t& x2);
<a name="l00683"></a>00683 <span class="comment"></span>
<a name="l00684"></a>00684 <span class="comment">/*!</span>
<a name="l00685"></a>00685 <span class="comment"> * \brief Return a list of length 3 containing \p x1, \p x2, \p x3</span>
<a name="l00686"></a>00686 <span class="comment"> */</span>
<a name="l00687"></a>00687 pmt_t pmt_list3(<span class="keyword">const</span> pmt_t& x1, <span class="keyword">const</span> pmt_t& x2, <span class="keyword">const</span> pmt_t& x3);
<a name="l00688"></a>00688 <span class="comment"></span>
<a name="l00689"></a>00689 <span class="comment">/*!</span>
<a name="l00690"></a>00690 <span class="comment"> * \brief Return a list of length 4 containing \p x1, \p x2, \p x3, \p x4</span>
<a name="l00691"></a>00691 <span class="comment"> */</span>
<a name="l00692"></a>00692 pmt_t pmt_list4(<span class="keyword">const</span> pmt_t& x1, <span class="keyword">const</span> pmt_t& x2, <span class="keyword">const</span> pmt_t& x3, <span class="keyword">const</span> pmt_t& x4);
<a name="l00693"></a>00693 <span class="comment"></span>
<a name="l00694"></a>00694 <span class="comment">/*!</span>
<a name="l00695"></a>00695 <span class="comment"> * \brief Return a list of length 5 containing \p x1, \p x2, \p x3, \p x4, \p x5</span>
<a name="l00696"></a>00696 <span class="comment"> */</span>
<a name="l00697"></a>00697 pmt_t pmt_list5(<span class="keyword">const</span> pmt_t& x1, <span class="keyword">const</span> pmt_t& x2, <span class="keyword">const</span> pmt_t& x3, <span class="keyword">const</span> pmt_t& x4, <span class="keyword">const</span> pmt_t& x5);
<a name="l00698"></a>00698 <span class="comment"></span>
<a name="l00699"></a>00699 <span class="comment">/*!</span>
<a name="l00700"></a>00700 <span class="comment"> * \brief Return a list of length 6 containing \p x1, \p x2, \p x3, \p x4, \p</span>
<a name="l00701"></a>00701 <span class="comment"> * x5, \p x6</span>
<a name="l00702"></a>00702 <span class="comment"> */</span>
<a name="l00703"></a>00703 pmt_t pmt_list6(<span class="keyword">const</span> pmt_t& x1, <span class="keyword">const</span> pmt_t& x2, <span class="keyword">const</span> pmt_t& x3, <span class="keyword">const</span> pmt_t& x4, <span class="keyword">const</span> pmt_t& x5, <span class="keyword">const</span> pmt_t& x6);
<a name="l00704"></a>00704 <span class="comment"></span>
<a name="l00705"></a>00705 <span class="comment">/*!</span>
<a name="l00706"></a>00706 <span class="comment"> * \brief Return \p list with \p item added to it.</span>
<a name="l00707"></a>00707 <span class="comment"> */</span>
<a name="l00708"></a>00708 pmt_t pmt_list_add(pmt_t list, <span class="keyword">const</span> pmt_t& item);
<a name="l00709"></a>00709
<a name="l00710"></a>00710
<a name="l00711"></a>00711 <span class="comment">/*</span>
<a name="l00712"></a>00712 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00713"></a>00713 <span class="comment"> * read / write</span>
<a name="l00714"></a>00714 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00715"></a>00715 <span class="comment"> */</span>
<a name="l00716"></a>00716 <span class="keyword">extern</span> <span class="keyword">const</span> pmt_t PMT_EOF; <span class="comment">//< The end of file object</span>
<a name="l00717"></a>00717 <span class="comment"></span>
<a name="l00718"></a>00718 <span class="comment">//! return true if obj is the EOF object, otherwise return false.</span>
<a name="l00719"></a>00719 <span class="comment"></span><span class="keywordtype">bool</span> pmt_is_eof_object(pmt_t obj);
<a name="l00720"></a>00720 <span class="comment"></span>
<a name="l00721"></a>00721 <span class="comment">/*!</span>
<a name="l00722"></a>00722 <span class="comment"> * read converts external representations of pmt objects into the</span>
<a name="l00723"></a>00723 <span class="comment"> * objects themselves. Read returns the next object parsable from</span>
<a name="l00724"></a>00724 <span class="comment"> * the given input port, updating port to point to the first</span>
<a name="l00725"></a>00725 <span class="comment"> * character past the end of the external representation of the</span>
<a name="l00726"></a>00726 <span class="comment"> * object.</span>
<a name="l00727"></a>00727 <span class="comment"> *</span>
<a name="l00728"></a>00728 <span class="comment"> * If an end of file is encountered in the input before any</span>
<a name="l00729"></a>00729 <span class="comment"> * characters are found that can begin an object, then an end of file</span>
<a name="l00730"></a>00730 <span class="comment"> * object is returned. The port remains open, and further attempts</span>
<a name="l00731"></a>00731 <span class="comment"> * to read will also return an end of file object. If an end of file</span>
<a name="l00732"></a>00732 <span class="comment"> * is encountered after the beginning of an object's external</span>
<a name="l00733"></a>00733 <span class="comment"> * representation, but the external representation is incomplete and</span>
<a name="l00734"></a>00734 <span class="comment"> * therefore not parsable, an error is signaled.</span>
<a name="l00735"></a>00735 <span class="comment"> */</span>
<a name="l00736"></a>00736 pmt_t pmt_read(std::istream &port);
<a name="l00737"></a>00737 <span class="comment"></span>
<a name="l00738"></a>00738 <span class="comment">/*!</span>
<a name="l00739"></a>00739 <span class="comment"> * Write a written representation of \p obj to the given \p port.</span>
<a name="l00740"></a>00740 <span class="comment"> */</span>
<a name="l00741"></a>00741 <span class="keywordtype">void</span> pmt_write(pmt_t obj, std::ostream &port);
<a name="l00742"></a>00742 <span class="comment"></span>
<a name="l00743"></a>00743 <span class="comment">/*!</span>
<a name="l00744"></a>00744 <span class="comment"> * Return a string representation of \p obj.</span>
<a name="l00745"></a>00745 <span class="comment"> * This is the same output as would be generated by pmt_write.</span>
<a name="l00746"></a>00746 <span class="comment"> */</span>
<a name="l00747"></a>00747 std::string pmt_write_string(pmt_t obj);
<a name="l00748"></a>00748
<a name="l00749"></a>00749
<a name="l00750"></a>00750 std::ostream& <a class="code" href="gr__basic__block_8h.html#acb2f610728a7f3cbd51a9a2eb60f059e">operator<<</a>(std::ostream &os, pmt_t obj);
<a name="l00751"></a>00751
<a name="l00752"></a>00752
<a name="l00753"></a>00753 <span class="comment">/*</span>
<a name="l00754"></a>00754 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00755"></a>00755 <span class="comment"> * portable byte stream representation</span>
<a name="l00756"></a>00756 <span class="comment"> * ------------------------------------------------------------------------</span>
<a name="l00757"></a>00757 <span class="comment"> */</span><span class="comment"></span>
<a name="l00758"></a>00758 <span class="comment">/*!</span>
<a name="l00759"></a>00759 <span class="comment"> * \brief Write portable byte-serial representation of \p obj to \p sink</span>
<a name="l00760"></a>00760 <span class="comment"> */</span>
<a name="l00761"></a>00761 <span class="keywordtype">bool</span> pmt_serialize(pmt_t obj, std::streambuf &sink);
<a name="l00762"></a>00762 <span class="comment"></span>
<a name="l00763"></a>00763 <span class="comment">/*!</span>
<a name="l00764"></a>00764 <span class="comment"> * \brief Create obj from portable byte-serial representation</span>
<a name="l00765"></a>00765 <span class="comment"> */</span>
<a name="l00766"></a>00766 pmt_t pmt_deserialize(std::streambuf &source);
<a name="l00767"></a>00767
<a name="l00768"></a>00768
<a name="l00769"></a>00769 <span class="keywordtype">void</span> pmt_dump_sizeof(); <span class="comment">// debugging</span>
<a name="l00770"></a>00770
<a name="l00771"></a>00771 } <span class="comment">/* namespace pmt */</span>
<a name="l00772"></a>00772
<a name="l00773"></a>00773
<a name="l00774"></a>00774 <span class="preprocessor">#include <<a class="code" href="pmt__sugar_8h.html">gruel/pmt_sugar.h</a>></span>
<a name="l00775"></a>00775
<a name="l00776"></a>00776 <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_PMT_H */</span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:51:01 2010 for GNU Radio 3.3.0 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
