GNU Radio 3.7.3 C++ API
pmt.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2006,2009,2010,2013 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3, or (at your option)
10  * any later version.
11  *
12  * GNU Radio is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_PMT_H
24 #define INCLUDED_PMT_H
25 
26 #include <pmt/api.h>
27 #include <boost/intrusive_ptr.hpp>
28 #include <boost/shared_ptr.hpp>
29 #include <boost/any.hpp>
30 #include <complex>
31 #include <string>
32 #include <stdint.h>
33 #include <iosfwd>
34 #include <stdexcept>
35 #include <vector>
36 
37 namespace gr {
38  namespace messages {
39  class msg_accepter;
40  }
41 }
42 
43 /*!
44  * This file defines a polymorphic type and the operations on it.
45  *
46  * It draws heavily on the idea of scheme and lisp data types.
47  * The interface parallels that in Guile 1.8, with the notable
48  * exception that these objects are transparently reference counted.
49  */
50 
51 namespace pmt {
52 
53 /*!
54  * \brief base class of all pmt types
55  */
56 class pmt_base;
57 
58 /*!
59  * \brief typedef for shared pointer (transparent reference counting).
60  * See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
61  */
62 typedef boost::intrusive_ptr<pmt_base> pmt_t;
63 
64 extern PMT_API void intrusive_ptr_add_ref(pmt_base*);
65 extern PMT_API void intrusive_ptr_release(pmt_base*);
66 
67 class PMT_API exception : public std::logic_error
68 {
69 public:
70  exception(const std::string &msg, pmt_t obj);
71 };
72 
74 {
75 public:
76  wrong_type(const std::string &msg, pmt_t obj);
77 };
78 
80 {
81 public:
82  out_of_range(const std::string &msg, pmt_t obj);
83 };
84 
86 {
87 public:
88  notimplemented(const std::string &msg, pmt_t obj);
89 };
90 
91 /*
92  * ------------------------------------------------------------------------
93  * Booleans. Two constants, #t and #f.
94  *
95  * In predicates, anything that is not #f is considered true.
96  * I.e., there is a single false value, #f.
97  * ------------------------------------------------------------------------
98  */
99 extern PMT_API const pmt_t PMT_T; //< \#t : boolean true constant
100 extern PMT_API const pmt_t PMT_F; //< \#f : boolean false constant
101 
102 //! Return true if obj is \#t or \#f, else return false.
103 PMT_API bool is_bool(pmt_t obj);
104 
105 //! Return false if obj is \#f, else return true.
106 PMT_API bool is_true(pmt_t obj);
107 
108 //! Return true if obj is \#f, else return true.
109 PMT_API bool is_false(pmt_t obj);
110 
111 //! Return \#f is val is false, else return \#t.
112 PMT_API pmt_t from_bool(bool val);
113 
114 //! Return true if val is pmt::True, return false when val is pmt::PMT_F,
115 // else raise wrong_type exception.
116 PMT_API bool to_bool(pmt_t val);
117 
118 /*
119  * ------------------------------------------------------------------------
120  * Symbols
121  * ------------------------------------------------------------------------
122  */
123 
124 //! Return true if obj is a symbol, else false.
125 PMT_API bool is_symbol(const pmt_t& obj);
126 
127 //! Return the symbol whose name is \p s.
128 PMT_API pmt_t string_to_symbol(const std::string &s);
129 
130 //! Alias for pmt_string_to_symbol
131 PMT_API pmt_t intern(const std::string &s);
132 
133 
134 /*!
135  * If \p is a symbol, return the name of the symbol as a string.
136  * Otherwise, raise the wrong_type exception.
137  */
138 PMT_API const std::string symbol_to_string(const pmt_t& sym);
139 
140 /*
141  * ------------------------------------------------------------------------
142  * Numbers: we support integer, real and complex
143  * ------------------------------------------------------------------------
144  */
145 
146 //! Return true if obj is any kind of number, else false.
147 PMT_API bool is_number(pmt_t obj);
148 
149 /*
150  * ------------------------------------------------------------------------
151  * Integers
152  * ------------------------------------------------------------------------
153  */
154 
155 //! Return true if \p x is an integer number, else false
156 PMT_API bool is_integer(pmt_t x);
157 
158 //! Return the pmt value that represents the integer \p x.
159 PMT_API pmt_t from_long(long x);
160 
161 /*!
162  * \brief Convert pmt to long if possible.
163  *
164  * When \p x represents an exact integer that fits in a long,
165  * return that integer. Else raise an exception, either wrong_type
166  * when x is not an exact integer, or out_of_range when it doesn't fit.
167  */
168 PMT_API long to_long(pmt_t x);
169 
170 /*
171  * ------------------------------------------------------------------------
172  * uint64_t
173  * ------------------------------------------------------------------------
174  */
175 
176 //! Return true if \p x is an uint64 number, else false
177 PMT_API bool is_uint64(pmt_t x);
178 
179 //! Return the pmt value that represents the uint64 \p x.
181 
182 /*!
183  * \brief Convert pmt to uint64 if possible.
184  *
185  * When \p x represents an exact integer that fits in a uint64,
186  * return that uint64. Else raise an exception, either wrong_type
187  * when x is not an exact uint64, or out_of_range when it doesn't fit.
188  */
190 
191 /*
192  * ------------------------------------------------------------------------
193  * Reals
194  * ------------------------------------------------------------------------
195  */
196 
197 /*
198  * \brief Return true if \p obj is a real number, else false.
199  */
200 PMT_API bool is_real(pmt_t obj);
201 
202 //! Return the pmt value that represents double \p x.
203 PMT_API pmt_t from_double(double x);
204 
205 /*!
206  * \brief Convert pmt to double if possible.
207  *
208  * Returns the number closest to \p val that is representable
209  * as a double. The argument \p val must be a real or integer, otherwise
210  * a wrong_type exception is raised.
211  */
212 PMT_API double to_double(pmt_t x);
213 
214 /*
215  * ------------------------------------------------------------------------
216  * Complex
217  * ------------------------------------------------------------------------
218  */
219 
220 /*!
221  * \brief return true if \p obj is a complex number, false otherwise.
222  */
223 PMT_API bool is_complex(pmt_t obj);
224 
225 //! Return a complex number constructed of the given real and imaginary parts.
226 PMT_API pmt_t make_rectangular(double re, double im);
227 
228 //! Return a complex number constructed of the given real and imaginary parts.
229 PMT_API pmt_t from_complex(double re, double im);
230 
231 //! Return a complex number constructed of the given a complex number.
232 PMT_API pmt_t from_complex(const std::complex<double> &z);
233 
234 //! Return a complex number constructed of the given real and imaginary parts.
235 PMT_API pmt_t pmt_from_complex(double re, double im);
236 
237 //! Return a complex number constructed of the given a complex number.
238 PMT_API pmt_t pmt_from_complex(const std::complex<double> &z);
239 
240 /*!
241  * If \p z is complex, real or integer, return the closest complex<double>.
242  * Otherwise, raise the wrong_type exception.
243  */
244 PMT_API std::complex<double> to_complex(pmt_t z);
245 
246 /*
247  * ------------------------------------------------------------------------
248  * Pairs
249  * ------------------------------------------------------------------------
250  */
251 
252 extern PMT_API const pmt_t PMT_NIL; //< the empty list
253 
254 //! Return true if \p x is the empty list, otherwise return false.
255 PMT_API bool is_null(const pmt_t& x);
256 
257 //! Return true if \p obj is a pair, else false.
258 PMT_API bool is_pair(const pmt_t& obj);
259 
260 //! Return a newly allocated pair whose car is \p x and whose cdr is \p y.
261 PMT_API pmt_t cons(const pmt_t& x, const pmt_t& y);
262 
263 //! If \p pair is a pair, return the car of the \p pair, otherwise raise wrong_type.
264 PMT_API pmt_t car(const pmt_t& pair);
265 
266 //! If \p pair is a pair, return the cdr of the \p pair, otherwise raise wrong_type.
267 PMT_API pmt_t cdr(const pmt_t& pair);
268 
269 //! Stores \p value in the car field of \p pair.
270 PMT_API void set_car(pmt_t pair, pmt_t value);
271 
272 //! Stores \p value in the cdr field of \p pair.
273 PMT_API void set_cdr(pmt_t pair, pmt_t value);
274 
275 PMT_API pmt_t caar(pmt_t pair);
276 PMT_API pmt_t cadr(pmt_t pair);
277 PMT_API pmt_t cdar(pmt_t pair);
278 PMT_API pmt_t cddr(pmt_t pair);
279 PMT_API pmt_t caddr(pmt_t pair);
280 PMT_API pmt_t cadddr(pmt_t pair);
281 
282 /*
283  * ------------------------------------------------------------------------
284  * Tuples
285  *
286  * Store a fixed number of objects. Tuples are not modifiable, and thus
287  * are excellent for use as messages. Indexing is zero based.
288  * Access time to an element is O(1).
289  * ------------------------------------------------------------------------
290  */
291 
292 //! Return true if \p x is a tuple, othewise false.
293 PMT_API bool is_tuple(pmt_t x);
294 
296 PMT_API pmt_t make_tuple(const pmt_t &e0);
297 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1);
298 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2);
299 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3);
300 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4);
301 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5);
302 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6);
303 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7);
304 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7, const pmt_t &e8);
305 PMT_API pmt_t make_tuple(const pmt_t &e0, const pmt_t &e1, const pmt_t &e2, const pmt_t &e3, const pmt_t &e4, const pmt_t &e5, const pmt_t &e6, const pmt_t &e7, const pmt_t &e8, const pmt_t &e9);
306 
307 /*!
308  * If \p x is a vector or proper list, return a tuple containing the elements of x
309  */
310 PMT_API pmt_t to_tuple(const pmt_t &x);
311 
312 /*!
313  * Return the contents of position \p k of \p tuple.
314  * \p k must be a valid index of \p tuple.
315  */
316 PMT_API pmt_t tuple_ref(const pmt_t &tuple, size_t k);
317 
318 /*
319  * ------------------------------------------------------------------------
320  * Vectors
321  *
322  * These vectors can hold any kind of objects. Indexing is zero based.
323  * ------------------------------------------------------------------------
324  */
325 
326 //! Return true if \p x is a vector, othewise false.
327 PMT_API bool is_vector(pmt_t x);
328 
329 //! Make a vector of length \p k, with initial values set to \p fill
330 PMT_API pmt_t make_vector(size_t k, pmt_t fill);
331 
332 /*!
333  * Return the contents of position \p k of \p vector.
334  * \p k must be a valid index of \p vector.
335  */
336 PMT_API pmt_t vector_ref(pmt_t vector, size_t k);
337 
338 //! Store \p obj in position \p k.
339 PMT_API void vector_set(pmt_t vector, size_t k, pmt_t obj);
340 
341 //! Store \p fill in every position of \p vector
342 PMT_API void vector_fill(pmt_t vector, pmt_t fill);
343 
344 /*
345  * ------------------------------------------------------------------------
346  * Binary Large Objects (BLOBs)
347  *
348  * Handy for passing around uninterpreted chunks of memory.
349  * ------------------------------------------------------------------------
350  */
351 
352 //! Return true if \p x is a blob, othewise false.
353 PMT_API bool is_blob(pmt_t x);
354 
355 /*!
356  * \brief Make a blob given a pointer and length in bytes
357  *
358  * \param buf is the pointer to data to use to create blob
359  * \param len is the size of the data in bytes.
360  *
361  * The data is copied into the blob.
362  */
363 PMT_API pmt_t make_blob(const void *buf, size_t len);
364 
365 //! Return a pointer to the blob's data
366 PMT_API const void *blob_data(pmt_t blob);
367 
368 //! Return the blob's length in bytes
369 PMT_API size_t blob_length(pmt_t blob);
370 
371 /*!
372  * <pre>
373  * Uniform Numeric Vectors
374  *
375  * A uniform numeric vector is a vector whose elements are all of single
376  * numeric type. pmt offers uniform numeric vectors for signed and
377  * unsigned 8-bit, 16-bit, 32-bit, and 64-bit integers, two sizes of
378  * floating point values, and complex floating-point numbers of these
379  * two sizes. Indexing is zero based.
380  *
381  * The names of the functions include these tags in their names:
382  *
383  * u8 unsigned 8-bit integers
384  * s8 signed 8-bit integers
385  * u16 unsigned 16-bit integers
386  * s16 signed 16-bit integers
387  * u32 unsigned 32-bit integers
388  * s32 signed 32-bit integers
389  * u64 unsigned 64-bit integers
390  * s64 signed 64-bit integers
391  * f32 the C++ type float
392  * f64 the C++ type double
393  * c32 the C++ type complex<float>
394  * c64 the C++ type complex<double>
395  * </pre>
396  */
397 
398 //! true if \p x is any kind of uniform numeric vector
400 
401 PMT_API bool is_u8vector(pmt_t x);
402 PMT_API bool is_s8vector(pmt_t x);
403 PMT_API bool is_u16vector(pmt_t x);
404 PMT_API bool is_s16vector(pmt_t x);
405 PMT_API bool is_u32vector(pmt_t x);
406 PMT_API bool is_s32vector(pmt_t x);
407 PMT_API bool is_u64vector(pmt_t x);
408 PMT_API bool is_s64vector(pmt_t x);
409 PMT_API bool is_f32vector(pmt_t x);
410 PMT_API bool is_f64vector(pmt_t x);
411 PMT_API bool is_c32vector(pmt_t x);
412 PMT_API bool is_c64vector(pmt_t x);
413 
414 PMT_API pmt_t make_u8vector(size_t k, uint8_t fill);
415 PMT_API pmt_t make_s8vector(size_t k, int8_t fill);
416 PMT_API pmt_t make_u16vector(size_t k, uint16_t fill);
417 PMT_API pmt_t make_s16vector(size_t k, int16_t fill);
418 PMT_API pmt_t make_u32vector(size_t k, uint32_t fill);
419 PMT_API pmt_t make_s32vector(size_t k, int32_t fill);
420 PMT_API pmt_t make_u64vector(size_t k, uint64_t fill);
421 PMT_API pmt_t make_s64vector(size_t k, int64_t fill);
422 PMT_API pmt_t make_f32vector(size_t k, float fill);
423 PMT_API pmt_t make_f64vector(size_t k, double fill);
424 PMT_API pmt_t make_c32vector(size_t k, std::complex<float> fill);
425 PMT_API pmt_t make_c64vector(size_t k, std::complex<double> fill);
426 
427 PMT_API pmt_t init_u8vector(size_t k, const uint8_t *data);
428 PMT_API pmt_t init_u8vector(size_t k, const std::vector<uint8_t> &data);
429 PMT_API pmt_t init_s8vector(size_t k, const int8_t *data);
430 PMT_API pmt_t init_s8vector(size_t k, const std::vector<int8_t> &data);
431 PMT_API pmt_t init_u16vector(size_t k, const uint16_t *data);
432 PMT_API pmt_t init_u16vector(size_t k, const std::vector<uint16_t> &data);
433 PMT_API pmt_t init_s16vector(size_t k, const int16_t *data);
434 PMT_API pmt_t init_s16vector(size_t k, const std::vector<int16_t> &data);
435 PMT_API pmt_t init_u32vector(size_t k, const uint32_t *data);
436 PMT_API pmt_t init_u32vector(size_t k, const std::vector<uint32_t> &data);
437 PMT_API pmt_t init_s32vector(size_t k, const int32_t *data);
438 PMT_API pmt_t init_s32vector(size_t k, const std::vector<int32_t> &data);
439 PMT_API pmt_t init_u64vector(size_t k, const uint64_t *data);
440 PMT_API pmt_t init_u64vector(size_t k, const std::vector<uint64_t> &data);
441 PMT_API pmt_t init_s64vector(size_t k, const int64_t *data);
442 PMT_API pmt_t init_s64vector(size_t k, const std::vector<int64_t> &data);
443 PMT_API pmt_t init_f32vector(size_t k, const float *data);
444 PMT_API pmt_t init_f32vector(size_t k, const std::vector<float> &data);
445 PMT_API pmt_t init_f64vector(size_t k, const double *data);
446 PMT_API pmt_t init_f64vector(size_t k, const std::vector<double> &data);
447 PMT_API pmt_t init_c32vector(size_t k, const std::complex<float> *data);
448 PMT_API pmt_t init_c32vector(size_t k, const std::vector<std::complex<float> > &data);
449 PMT_API pmt_t init_c64vector(size_t k, const std::complex<double> *data);
450 PMT_API pmt_t init_c64vector(size_t k, const std::vector<std::complex<double> > &data);
451 
452 PMT_API uint8_t u8vector_ref(pmt_t v, size_t k);
453 PMT_API int8_t s8vector_ref(pmt_t v, size_t k);
454 PMT_API uint16_t u16vector_ref(pmt_t v, size_t k);
455 PMT_API int16_t s16vector_ref(pmt_t v, size_t k);
456 PMT_API uint32_t u32vector_ref(pmt_t v, size_t k);
457 PMT_API int32_t s32vector_ref(pmt_t v, size_t k);
458 PMT_API uint64_t u64vector_ref(pmt_t v, size_t k);
459 PMT_API int64_t s64vector_ref(pmt_t v, size_t k);
460 PMT_API float f32vector_ref(pmt_t v, size_t k);
461 PMT_API double f64vector_ref(pmt_t v, size_t k);
462 PMT_API std::complex<float> c32vector_ref(pmt_t v, size_t k);
463 PMT_API std::complex<double> c64vector_ref(pmt_t v, size_t k);
464 
465 PMT_API void u8vector_set(pmt_t v, size_t k, uint8_t x); //< v[k] = x
466 PMT_API void s8vector_set(pmt_t v, size_t k, int8_t x);
467 PMT_API void u16vector_set(pmt_t v, size_t k, uint16_t x);
468 PMT_API void s16vector_set(pmt_t v, size_t k, int16_t x);
469 PMT_API void u32vector_set(pmt_t v, size_t k, uint32_t x);
470 PMT_API void s32vector_set(pmt_t v, size_t k, int32_t x);
471 PMT_API void u64vector_set(pmt_t v, size_t k, uint64_t x);
472 PMT_API void s64vector_set(pmt_t v, size_t k, int64_t x);
473 PMT_API void f32vector_set(pmt_t v, size_t k, float x);
474 PMT_API void f64vector_set(pmt_t v, size_t k, double x);
475 PMT_API void c32vector_set(pmt_t v, size_t k, std::complex<float> x);
476 PMT_API void c64vector_set(pmt_t v, size_t k, std::complex<double> x);
477 
478 // Return const pointers to the elements
479 
480 PMT_API const void *uniform_vector_elements(pmt_t v, size_t &len); //< works with any; len is in bytes
481 
482 PMT_API const uint8_t *u8vector_elements(pmt_t v, size_t &len); //< len is in elements
483 PMT_API const int8_t *s8vector_elements(pmt_t v, size_t &len); //< len is in elements
484 PMT_API const uint16_t *u16vector_elements(pmt_t v, size_t &len); //< len is in elements
485 PMT_API const int16_t *s16vector_elements(pmt_t v, size_t &len); //< len is in elements
486 PMT_API const uint32_t *u32vector_elements(pmt_t v, size_t &len); //< len is in elements
487 PMT_API const int32_t *s32vector_elements(pmt_t v, size_t &len); //< len is in elements
488 PMT_API const uint64_t *u64vector_elements(pmt_t v, size_t &len); //< len is in elements
489 PMT_API const int64_t *s64vector_elements(pmt_t v, size_t &len); //< len is in elements
490 PMT_API const float *f32vector_elements(pmt_t v, size_t &len); //< len is in elements
491 PMT_API const double *f64vector_elements(pmt_t v, size_t &len); //< len is in elements
492 PMT_API const std::complex<float> *c32vector_elements(pmt_t v, size_t &len); //< len is in elements
493 PMT_API const std::complex<double> *c64vector_elements(pmt_t v, size_t &len); //< len is in elements
494 
495 // len is in elements
496 PMT_API const std::vector<uint8_t> u8vector_elements(pmt_t v);
497 PMT_API const std::vector<int8_t> s8vector_elements(pmt_t v);
498 PMT_API const std::vector<uint16_t> u16vector_elements(pmt_t v);
499 PMT_API const std::vector<int16_t> s16vector_elements(pmt_t v);
500 PMT_API const std::vector<uint32_t> u32vector_elements(pmt_t v);
501 PMT_API const std::vector<int32_t> s32vector_elements(pmt_t v);
502 PMT_API const std::vector<uint64_t> u64vector_elements(pmt_t v);
503 PMT_API const std::vector<int64_t> s64vector_elements(pmt_t v);
504 PMT_API const std::vector<float> f32vector_elements(pmt_t v);
505 PMT_API const std::vector<double> f64vector_elements(pmt_t v);
506 PMT_API const std::vector<std::complex<float> > c32vector_elements(pmt_t v);
507 PMT_API const std::vector<std::complex<double> > c64vector_elements(pmt_t v);
508 
509 // len is in elements
510 PMT_API const std::vector<uint8_t> pmt_u8vector_elements(pmt_t v);
511 PMT_API const std::vector<int8_t> pmt_s8vector_elements(pmt_t v);
512 PMT_API const std::vector<uint16_t> pmt_u16vector_elements(pmt_t v);
513 PMT_API const std::vector<int16_t> pmt_s16vector_elements(pmt_t v);
514 PMT_API const std::vector<uint32_t> pmt_u32vector_elements(pmt_t v);
515 PMT_API const std::vector<int32_t> pmt_s32vector_elements(pmt_t v);
516 PMT_API const std::vector<uint64_t> pmt_u64vector_elements(pmt_t v);
517 PMT_API const std::vector<int64_t> pmt_s64vector_elements(pmt_t v);
518 PMT_API const std::vector<float> pmt_f32vector_elements(pmt_t v);
519 PMT_API const std::vector<double> pmt_f64vector_elements(pmt_t v);
520 PMT_API const std::vector<std::complex<float> > pmt_c32vector_elements(pmt_t v);
521 PMT_API const std::vector<std::complex<double> > pmt_c64vector_elements(pmt_t v);
522 
523 // Return non-const pointers to the elements
524 
525 PMT_API void *uniform_vector_writable_elements(pmt_t v, size_t &len); //< works with any; len is in bytes
526 
527 PMT_API uint8_t *u8vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
528 PMT_API int8_t *s8vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
529 PMT_API uint16_t *u16vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
530 PMT_API int16_t *s16vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
531 PMT_API uint32_t *u32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
532 PMT_API int32_t *s32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
533 PMT_API uint64_t *u64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
534 PMT_API int64_t *s64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
535 PMT_API float *f32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
536 PMT_API double *f64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
537 PMT_API std::complex<float> *c32vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
538 PMT_API std::complex<double> *c64vector_writable_elements(pmt_t v, size_t &len); //< len is in elements
539 
540 /*
541  * ------------------------------------------------------------------------
542  * Dictionary (a.k.a associative array, hash, map)
543  *
544  * This is a functional data structure that is persistent. Updating a
545  * functional data structure does not destroy the existing version, but
546  * rather creates a new version that coexists with the old.
547  * ------------------------------------------------------------------------
548  */
549 
550 //! Return true if \p obj is a dictionary
551 PMT_API bool is_dict(const pmt_t &obj);
552 
553 //! Make an empty dictionary
555 
556 //! Return a new dictionary with \p key associated with \p value.
557 PMT_API pmt_t dict_add(const pmt_t &dict, const pmt_t &key, const pmt_t &value);
558 
559 //! Return a new dictionary with \p key removed.
560 PMT_API pmt_t dict_delete(const pmt_t &dict, const pmt_t &key);
561 
562 //! Return true if \p key exists in \p dict
563 PMT_API bool dict_has_key(const pmt_t &dict, const pmt_t &key);
564 
565 //! If \p key exists in \p dict, return associated value; otherwise return \p not_found.
566 PMT_API pmt_t dict_ref(const pmt_t &dict, const pmt_t &key, const pmt_t &not_found);
567 
568 //! Return list of (key . value) pairs
570 
571 //! Return list of keys
573 
574 //! Return list of values
576 
577 /*
578  * ------------------------------------------------------------------------
579  * Any (wraps boost::any -- can be used to wrap pretty much anything)
580  *
581  * Cannot be serialized or used across process boundaries.
582  * See http://www.boost.org/doc/html/any.html
583  * ------------------------------------------------------------------------
584  */
585 
586 //! Return true if \p obj is an any
587 PMT_API bool is_any(pmt_t obj);
588 
589 //! make an any
590 PMT_API pmt_t make_any(const boost::any &any);
591 
592 //! Return underlying boost::any
593 PMT_API boost::any any_ref(pmt_t obj);
594 
595 //! Store \p any in \p obj
596 PMT_API void any_set(pmt_t obj, const boost::any &any);
597 
598 
599 /*
600  * ------------------------------------------------------------------------
601  * msg_accepter -- pmt representation of pmt::msg_accepter
602  * ------------------------------------------------------------------------
603  */
604 //! Return true if \p obj is a msg_accepter
605 PMT_API bool is_msg_accepter(const pmt_t &obj);
606 
607 //! make a msg_accepter
609 
610 //! Return underlying msg_accepter
612 
613 /*
614  * ------------------------------------------------------------------------
615  * General functions
616  * ------------------------------------------------------------------------
617  */
618 
619 //! Return true if x and y are the same object; otherwise return false.
620 PMT_API bool eq(const pmt_t& x, const pmt_t& y);
621 
622 /*!
623  * \brief Return true if x and y should normally be regarded as the same object, else false.
624  *
625  * <pre>
626  * eqv returns true if:
627  * x and y are the same object.
628  * x and y are both \#t or both \#f.
629  * x and y are both symbols and their names are the same.
630  * x and y are both numbers, and are numerically equal.
631  * x and y are both the empty list (nil).
632  * x and y are pairs or vectors that denote same location in store.
633  * </pre>
634  */
635 PMT_API bool eqv(const pmt_t& x, const pmt_t& y);
636 
637 /*!
638  * pmt::equal recursively compares the contents of pairs and vectors,
639  * applying pmt::eqv on other objects such as numbers and symbols.
640  * pmt::equal may fail to terminate if its arguments are circular data
641  * structures.
642  */
643 PMT_API bool equal(const pmt_t& x, const pmt_t& y);
644 
645 
646 //! Return the number of elements in v
647 PMT_API size_t length(const pmt_t& v);
648 
649 /*!
650  * \brief Find the first pair in \p alist whose car field is \p obj
651  * and return that pair.
652  *
653  * \p alist (for "association list") must be a list of pairs. If no pair
654  * in \p alist has \p obj as its car then \#f is returned.
655  * Uses pmt::eq to compare \p obj with car fields of the pairs in \p alist.
656  */
657 PMT_API pmt_t assq(pmt_t obj, pmt_t alist);
658 
659 /*!
660  * \brief Find the first pair in \p alist whose car field is \p obj
661  * and return that pair.
662  *
663  * \p alist (for "association list") must be a list of pairs. If no pair
664  * in \p alist has \p obj as its car then \#f is returned.
665  * Uses pmt::eqv to compare \p obj with car fields of the pairs in \p alist.
666  */
667 PMT_API pmt_t assv(pmt_t obj, pmt_t alist);
668 
669 /*!
670  * \brief Find the first pair in \p alist whose car field is \p obj
671  * and return that pair.
672  *
673  * \p alist (for "association list") must be a list of pairs. If no pair
674  * in \p alist has \p obj as its car then \#f is returned.
675  * Uses pmt::equal to compare \p obj with car fields of the pairs in \p alist.
676  */
677 PMT_API pmt_t assoc(pmt_t obj, pmt_t alist);
678 
679 /*!
680  * \brief Apply \p proc element-wise to the elements of list and returns
681  * a list of the results, in order.
682  *
683  * \p list must be a list. The dynamic order in which \p proc is
684  * applied to the elements of \p list is unspecified.
685  */
686 PMT_API pmt_t map(pmt_t proc(const pmt_t&), pmt_t list);
687 
688 /*!
689  * \brief reverse \p list.
690  *
691  * \p list must be a proper list.
692  */
693 PMT_API pmt_t reverse(pmt_t list);
694 
695 /*!
696  * \brief destructively reverse \p list.
697  *
698  * \p list must be a proper list.
699  */
701 
702 /*!
703  * \brief (acons x y a) == (cons (cons x y) a)
704  */
705 inline static pmt_t
707 {
708  return cons(cons(x, y), a);
709 }
710 
711 /*!
712  * \brief locates \p nth element of \n list where the car is the 'zeroth' element.
713  */
714 PMT_API pmt_t nth(size_t n, pmt_t list);
715 
716 /*!
717  * \brief returns the tail of \p list that would be obtained by calling
718  * cdr \p n times in succession.
719  */
720 PMT_API pmt_t nthcdr(size_t n, pmt_t list);
721 
722 /*!
723  * \brief Return the first sublist of \p list whose car is \p obj.
724  * If \p obj does not occur in \p list, then \#f is returned.
725  * pmt::memq use pmt::eq to compare \p obj with the elements of \p list.
726  */
727 PMT_API pmt_t memq(pmt_t obj, pmt_t list);
728 
729 /*!
730  * \brief Return the first sublist of \p list whose car is \p obj.
731  * If \p obj does not occur in \p list, then \#f is returned.
732  * pmt::memv use pmt::eqv to compare \p obj with the elements of \p list.
733  */
734 PMT_API pmt_t memv(pmt_t obj, pmt_t list);
735 
736 /*!
737  * \brief Return the first sublist of \p list whose car is \p obj.
738  * If \p obj does not occur in \p list, then \#f is returned.
739  * pmt::member use pmt::equal to compare \p obj with the elements of \p list.
740  */
741 PMT_API pmt_t member(pmt_t obj, pmt_t list);
742 
743 /*!
744  * \brief Return true if every element of \p list1 appears in \p list2, and false otherwise.
745  * Comparisons are done with pmt::eqv.
746  */
748 
749 /*!
750  * \brief Return a list of length 1 containing \p x1
751  */
752 PMT_API pmt_t list1(const pmt_t& x1);
753 
754 /*!
755  * \brief Return a list of length 2 containing \p x1, \p x2
756  */
757 PMT_API pmt_t list2(const pmt_t& x1, const pmt_t& x2);
758 
759 /*!
760  * \brief Return a list of length 3 containing \p x1, \p x2, \p x3
761  */
762 PMT_API pmt_t list3(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3);
763 
764 /*!
765  * \brief Return a list of length 4 containing \p x1, \p x2, \p x3, \p x4
766  */
767 PMT_API pmt_t list4(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4);
768 
769 /*!
770  * \brief Return a list of length 5 containing \p x1, \p x2, \p x3, \p x4, \p x5
771  */
772 PMT_API pmt_t list5(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4, const pmt_t& x5);
773 
774 /*!
775  * \brief Return a list of length 6 containing \p x1, \p x2, \p x3, \p x4, \p
776  * x5, \p x6
777  */
778 PMT_API pmt_t list6(const pmt_t& x1, const pmt_t& x2, const pmt_t& x3, const pmt_t& x4, const pmt_t& x5, const pmt_t& x6);
779 
780 /*!
781  * \brief Return \p list with \p item added to it.
782  */
783 PMT_API pmt_t list_add(pmt_t list, const pmt_t& item);
784 
785 /*!
786  * \brief Return \p list with \p item removed from it.
787  */
788 PMT_API pmt_t list_rm(pmt_t list, const pmt_t& item);
789 
790 /*!
791  * \brief Return bool of \p list contains \p item
792  */
793 PMT_API bool list_has(pmt_t list, const pmt_t& item);
794 
795 
796 /*
797  * ------------------------------------------------------------------------
798  * read / write
799  * ------------------------------------------------------------------------
800  */
801 extern PMT_API const pmt_t PMT_EOF; //< The end of file object
802 
803 //! return true if obj is the EOF object, otherwise return false.
804 PMT_API bool is_eof_object(pmt_t obj);
805 
806 /*!
807  * read converts external representations of pmt objects into the
808  * objects themselves. Read returns the next object parsable from
809  * the given input port, updating port to point to the first
810  * character past the end of the external representation of the
811  * object.
812  *
813  * If an end of file is encountered in the input before any
814  * characters are found that can begin an object, then an end of file
815  * object is returned. The port remains open, and further attempts
816  * to read will also return an end of file object. If an end of file
817  * is encountered after the beginning of an object's external
818  * representation, but the external representation is incomplete and
819  * therefore not parsable, an error is signaled.
820  */
821 PMT_API pmt_t read(std::istream &port);
822 
823 /*!
824  * Write a written representation of \p obj to the given \p port.
825  */
826 PMT_API void write(pmt_t obj, std::ostream &port);
827 
828 /*!
829  * Return a string representation of \p obj.
830  * This is the same output as would be generated by pmt::write.
831  */
832 PMT_API std::string write_string(pmt_t obj);
833 
834 
835 PMT_API std::ostream& operator<<(std::ostream &os, pmt_t obj);
836 
837 /*!
838  * \brief Write pmt string representation to stdout.
839  */
840 PMT_API void print(pmt_t v);
841 
842 
843 /*
844  * ------------------------------------------------------------------------
845  * portable byte stream representation
846  * ------------------------------------------------------------------------
847  */
848 /*!
849  * \brief Write portable byte-serial representation of \p obj to \p sink
850  */
851 PMT_API bool serialize(pmt_t obj, std::streambuf &sink);
852 
853 /*!
854  * \brief Create obj from portable byte-serial representation
855  */
856 PMT_API pmt_t deserialize(std::streambuf &source);
857 
858 
859 PMT_API void dump_sizeof(); // debugging
860 
861 /*!
862  * \brief Provide a simple string generating interface to pmt's serialize function
863  */
864 PMT_API std::string serialize_str(pmt_t obj);
865 
866 /*!
867  * \brief Provide a simple string generating interface to pmt's deserialize function
868  */
869 PMT_API pmt_t deserialize_str(std::string str);
870 
871 /*!
872  * \brief Provide a comparator function object to allow pmt use in stl types
873  */
874 class comparator {
875  public:
876  bool operator()(pmt::pmt_t const& p1, pmt::pmt_t const& p2) const
877  { return pmt::eqv(p1,p2)?false:p1.get()>p2.get(); }
878 };
879 
880 // FIXME: Remove in 3.8.
881 class comperator {
882  public:
883  bool operator()(pmt::pmt_t const& p1, pmt::pmt_t const& p2) const
884  { return pmt::eqv(p1,p2)?false:p1.get()>p2.get(); }
885 };
886 
887 } /* namespace pmt */
888 
889 #include <pmt/pmt_sugar.h>
890 
891 #endif /* INCLUDED_PMT_H */
PMT_API pmt_t cdr(const pmt_t &pair)
If pair is a pair, return the cdr of the pair, otherwise raise wrong_type.
PMT_API pmt_t vector_ref(pmt_t vector, size_t k)
Provide a comparator function object to allow pmt use in stl types.
Definition: pmt.h:874
PMT_API pmt_t tuple_ref(const pmt_t &tuple, size_t k)
PMT_API pmt_t from_complex(double re, double im)
Return a complex number constructed of the given real and imaginary parts.
PMT_API pmt_t reverse(pmt_t list)
reverse list.
PMT_API pmt_t nthcdr(size_t n, pmt_t list)
returns the tail of list that would be obtained by calling cdr n times in succession.
PMT_API pmt_t list1(const pmt_t &x1)
Return a list of length 1 containing x1.
PMT_API bool is_uniform_vector(pmt_t x)
true if x is any kind of uniform numeric vector
PMT_API pmt_t init_s32vector(size_t k, const int32_t *data)
PMT_API uint16_t u16vector_ref(pmt_t v, size_t k)
PMT_API bool is_u64vector(pmt_t x)
PMT_API bool eqv(const pmt_t &x, const pmt_t &y)
Return true if x and y should normally be regarded as the same object, else false.
PMT_API pmt_t init_u64vector(size_t k, const uint64_t *data)
PMT_API float * f32vector_writable_elements(pmt_t v, size_t &len)
PMT_API void u8vector_set(pmt_t v, size_t k, uint8_t x)
PMT_API bool subsetp(pmt_t list1, pmt_t list2)
Return true if every element of list1 appears in list2, and false otherwise. Comparisons are done wit...
PMT_API pmt_t car(const pmt_t &pair)
If pair is a pair, return the car of the pair, otherwise raise wrong_type.
PMT_API std::complex< double > to_complex(pmt_t z)
PMT_API pmt_t read(std::istream &port)
PMT_API const uint64_t * u64vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t make_u8vector(size_t k, uint8_t fill)
PMT_API bool is_f32vector(pmt_t x)
PMT_API bool list_has(pmt_t list, const pmt_t &item)
Return bool of list contains item.
PMT_API pmt_t from_long(long x)
Return the pmt value that represents the integer x.
PMT_API void c32vector_set(pmt_t v, size_t k, std::complex< float > x)
PMT_API pmt_t caar(pmt_t pair)
PMT_API bool is_f64vector(pmt_t x)
PMT_API pmt_t assv(pmt_t obj, pmt_t alist)
Find the first pair in alist whose car field is obj and return that pair.
PMT_API void u64vector_set(pmt_t v, size_t k, uint64_t x)
PMT_API bool is_u8vector(pmt_t x)
PMT_API const int8_t * s8vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t init_u8vector(size_t k, const uint8_t *data)
PMT_API bool is_any(pmt_t obj)
Return true if obj is an any.
PMT_API const std::vector< std::complex< double > > pmt_c64vector_elements(pmt_t v)
PMT_API pmt_t list3(const pmt_t &x1, const pmt_t &x2, const pmt_t &x3)
Return a list of length 3 containing x1, x2, x3.
PMT_API void s8vector_set(pmt_t v, size_t k, int8_t x)
PMT_API uint8_t * u8vector_writable_elements(pmt_t v, size_t &len)
PMT_API pmt_t cddr(pmt_t pair)
PMT_API pmt_t memq(pmt_t obj, pmt_t list)
Return the first sublist of list whose car is obj. If obj does not occur in list, then #f is returned...
PMT_API const pmt_t PMT_T
PMT_API uint64_t u64vector_ref(pmt_t v, size_t k)
PMT_API pmt_t init_s8vector(size_t k, const int8_t *data)
PMT_API void set_cdr(pmt_t pair, pmt_t value)
Stores value in the cdr field of pair.
PMT_API const std::vector< uint64_t > pmt_u64vector_elements(pmt_t v)
PMT_API pmt_t dict_ref(const pmt_t &dict, const pmt_t &key, const pmt_t &not_found)
If key exists in dict, return associated value; otherwise return not_found.
PMT_API pmt_t make_u64vector(size_t k, uint64_t fill)
PMT_API bool is_dict(const pmt_t &obj)
Return true if obj is a dictionary.
PMT_API int8_t * s8vector_writable_elements(pmt_t v, size_t &len)
PMT_API void u16vector_set(pmt_t v, size_t k, uint16_t x)
PMT_API pmt_t cadddr(pmt_t pair)
PMT_API void s64vector_set(pmt_t v, size_t k, int64_t x)
PMT_API pmt_t list6(const pmt_t &x1, const pmt_t &x2, const pmt_t &x3, const pmt_t &x4, const pmt_t &x5, const pmt_t &x6)
Return a list of length 6 containing x1, x2, x3, x4, x5, x6.
unsigned short uint16_t
Definition: stdint.h:79
bool operator()(pmt::pmt_t const &p1, pmt::pmt_t const &p2) const
Definition: pmt.h:883
PMT_API int32_t * s32vector_writable_elements(pmt_t v, size_t &len)
PMT_API void vector_set(pmt_t vector, size_t k, pmt_t obj)
Store obj in position k.
PMT_API std::complex< double > * c64vector_writable_elements(pmt_t v, size_t &len)
PMT_API pmt_t member(pmt_t obj, pmt_t list)
Return the first sublist of list whose car is obj. If obj does not occur in list, then #f is returned...
PMT_API bool is_symbol(const pmt_t &obj)
Return true if obj is a symbol, else false.
unsigned char uint8_t
Definition: stdint.h:78
PMT_API uint32_t * u32vector_writable_elements(pmt_t v, size_t &len)
PMT_API int64_t * s64vector_writable_elements(pmt_t v, size_t &len)
PMT_API const std::vector< int16_t > pmt_s16vector_elements(pmt_t v)
PMT_API pmt_t dict_delete(const pmt_t &dict, const pmt_t &key)
Return a new dictionary with key removed.
PMT_API pmt_t make_s32vector(size_t k, int32_t fill)
PMT_API uint64_t * u64vector_writable_elements(pmt_t v, size_t &len)
PMT_API const std::vector< uint16_t > pmt_u16vector_elements(pmt_t v)
PMT_API pmt_t intern(const std::string &s)
Alias for pmt_string_to_symbol.
PMT_API bool eq(const pmt_t &x, const pmt_t &y)
Return true if x and y are the same object; otherwise return false.
PMT_API std::string serialize_str(pmt_t obj)
Provide a simple string generating interface to pmt's serialize function.
PMT_API pmt_t init_u32vector(size_t k, const uint32_t *data)
PMT_API pmt_t make_f64vector(size_t k, double fill)
PMT_API const std::string symbol_to_string(const pmt_t &sym)
PMT_API int8_t s8vector_ref(pmt_t v, size_t k)
PMT_API pmt_t make_dict()
Make an empty dictionary.
PMT_API bool is_s32vector(pmt_t x)
PMT_API void intrusive_ptr_release(pmt_base *)
PMT_API const void * uniform_vector_elements(pmt_t v, size_t &len)
PMT_API double * f64vector_writable_elements(pmt_t v, size_t &len)
PMT_API pmt_t init_f64vector(size_t k, const double *data)
PMT_API bool to_bool(pmt_t val)
Return true if val is pmt::True, return false when val is pmt::PMT_F,.
Definition: pmt.h:85
shared_ptr documentation stub
Definition: shared_ptr_docstub.h:15
PMT_API pmt_t dict_add(const pmt_t &dict, const pmt_t &key, const pmt_t &value)
Return a new dictionary with key associated with value.
PMT_API bool serialize(pmt_t obj, std::streambuf &sink)
Write portable byte-serial representation of obj to sink.
PMT_API const std::vector< int64_t > pmt_s64vector_elements(pmt_t v)
PMT_API pmt_t string_to_symbol(const std::string &s)
Return the symbol whose name is s.
PMT_API bool is_eof_object(pmt_t obj)
return true if obj is the EOF object, otherwise return false.
PMT_API const float * f32vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t make_vector(size_t k, pmt_t fill)
Make a vector of length k, with initial values set to fill.
PMT_API uint8_t u8vector_ref(pmt_t v, size_t k)
PMT_API size_t blob_length(pmt_t blob)
Return the blob's length in bytes.
PMT_API void s32vector_set(pmt_t v, size_t k, int32_t x)
PMT_API pmt_t dict_keys(pmt_t dict)
Return list of keys.
PMT_API void f64vector_set(pmt_t v, size_t k, double x)
PMT_API void set_car(pmt_t pair, pmt_t value)
Stores value in the car field of pair.
PMT_API pmt_t list5(const pmt_t &x1, const pmt_t &x2, const pmt_t &x3, const pmt_t &x4, const pmt_t &x5)
Return a list of length 5 containing x1, x2, x3, x4, x5.
PMT_API pmt_t from_uint64(uint64_t x)
Return the pmt value that represents the uint64 x.
PMT_API const uint16_t * u16vector_elements(pmt_t v, size_t &len)
PMT_API const uint32_t * u32vector_elements(pmt_t v, size_t &len)
PMT_API bool is_false(pmt_t obj)
Return true if obj is #f, else return true.
PMT_API pmt_t reverse_x(pmt_t list)
destructively reverse list.
PMT_API std::complex< float > c32vector_ref(pmt_t v, size_t k)
PMT_API uint64_t to_uint64(pmt_t x)
Convert pmt to uint64 if possible.
PMT_API bool is_integer(pmt_t x)
Return true if x is an integer number, else false.
PMT_API void u32vector_set(pmt_t v, size_t k, uint32_t x)
unsigned int uint32_t
Definition: stdint.h:80
PMT_API void intrusive_ptr_add_ref(pmt_base *)
PMT_API const int32_t * s32vector_elements(pmt_t v, size_t &len)
signed short int16_t
Definition: stdint.h:76
PMT_API float f32vector_ref(pmt_t v, size_t k)
PMT_API void any_set(pmt_t obj, const boost::any &any)
Store any in obj.
PMT_API uint16_t * u16vector_writable_elements(pmt_t v, size_t &len)
PMT_API const double * f64vector_elements(pmt_t v, size_t &len)
PMT_API bool equal(const pmt_t &x, const pmt_t &y)
PMT_API bool is_s64vector(pmt_t x)
unsigned __int64 uint64_t
Definition: stdint.h:90
PMT_API pmt_t make_c32vector(size_t k, std::complex< float > fill)
PMT_API const std::vector< int8_t > pmt_s8vector_elements(pmt_t v)
PMT_API int32_t s32vector_ref(pmt_t v, size_t k)
PMT_API long to_long(pmt_t x)
Convert pmt to long if possible.
Definition: pmt.h:67
PMT_API pmt_t make_s64vector(size_t k, int64_t fill)
PMT_API void vector_fill(pmt_t vector, pmt_t fill)
Store fill in every position of vector.
PMT_API bool is_uint64(pmt_t x)
Return true if x is an uint64 number, else false.
PMT_API int64_t s64vector_ref(pmt_t v, size_t k)
PMT_API bool is_true(pmt_t obj)
Return false if obj is #f, else return true.
PMT_API double to_double(pmt_t x)
Convert pmt to double if possible.
PMT_API pmt_t map(pmt_t proc(const pmt_t &), pmt_t list)
Apply proc element-wise to the elements of list and returns a list of the results, in order.
signed char int8_t
Definition: stdint.h:75
PMT_API pmt_t make_tuple()
PMT_API bool is_msg_accepter(const pmt_t &obj)
Return true if obj is a msg_accepter.
PMT_API size_t length(const pmt_t &v)
Return the number of elements in v.
PMT_API pmt_t cons(const pmt_t &x, const pmt_t &y)
Return a newly allocated pair whose car is x and whose cdr is y.
PMT_API pmt_t init_s64vector(size_t k, const int64_t *data)
PMT_API pmt_t deserialize(std::streambuf &source)
Create obj from portable byte-serial representation.
PMT_API void f32vector_set(pmt_t v, size_t k, float x)
PMT_API pmt_t init_c64vector(size_t k, const std::complex< double > *data)
PMT_API bool is_null(const pmt_t &x)
Return true if x is the empty list, otherwise return false.
PMT_API pmt_t list_rm(pmt_t list, const pmt_t &item)
Return list with item removed from it.
PMT_API pmt_t make_rectangular(double re, double im)
Return a complex number constructed of the given real and imaginary parts.
PMT_API pmt_t make_s8vector(size_t k, int8_t fill)
PMT_API pmt_t init_f32vector(size_t k, const float *data)
PMT_API pmt_t pmt_from_complex(double re, double im)
Return a complex number constructed of the given real and imaginary parts.
#define PMT_API
Definition: gnuradio-runtime/include/pmt/api.h:30
PMT_API pmt_t assq(pmt_t obj, pmt_t alist)
Find the first pair in alist whose car field is obj and return that pair.
Definition: pmt.h:79
PMT_API void write(pmt_t obj, std::ostream &port)
PMT_API const int16_t * s16vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t make_blob(const void *buf, size_t len)
Make a blob given a pointer and length in bytes.
PMT_API void s16vector_set(pmt_t v, size_t k, int16_t x)
PMT_API const pmt_t PMT_F
PMT_API bool is_bool(pmt_t obj)
Return true if obj is #t or #f, else return false.
PMT_API bool is_u16vector(pmt_t x)
PMT_API void dump_sizeof()
PMT_API pmt_t make_any(const boost::any &any)
make an any
PMT_API const uint8_t * u8vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t cadr(pmt_t pair)
PMT_API pmt_t list2(const pmt_t &x1, const pmt_t &x2)
Return a list of length 2 containing x1, x2.
PMT_API const std::vector< std::complex< float > > pmt_c32vector_elements(pmt_t v)
PMT_API bool is_c32vector(pmt_t x)
PMT_API pmt_t to_tuple(const pmt_t &x)
PMT_API const std::complex< double > * c64vector_elements(pmt_t v, size_t &len)
PMT_API pmt_t memv(pmt_t obj, pmt_t list)
Return the first sublist of list whose car is obj. If obj does not occur in list, then #f is returned...
PMT_API pmt_t list4(const pmt_t &x1, const pmt_t &x2, const pmt_t &x3, const pmt_t &x4)
Return a list of length 4 containing x1, x2, x3, x4.
PMT_API pmt_t init_u16vector(size_t k, const uint16_t *data)
PMT_API pmt_t dict_items(pmt_t dict)
Return list of (key . value) pairs.
PMT_API pmt_t cdar(pmt_t pair)
PMT_API pmt_t list_add(pmt_t list, const pmt_t &item)
Return list with item added to it.
PMT_API pmt_t init_c32vector(size_t k, const std::complex< float > *data)
PMT_API boost::any any_ref(pmt_t obj)
Return underlying boost::any.
signed __int64 int64_t
Definition: stdint.h:89
PMT_API pmt_t deserialize_str(std::string str)
Provide a simple string generating interface to pmt's deserialize function.
PMT_API pmt_t make_u32vector(size_t k, uint32_t fill)
PMT_API pmt_t dict_values(pmt_t dict)
Return list of values.
PMT_API const pmt_t PMT_EOF
PMT_API pmt_t nth(size_t n, pmt_t list)
locates nth element of list where the car is the 'zeroth' element.
PMT_API bool is_blob(pmt_t x)
Return true if x is a blob, othewise false.
PMT_API bool dict_has_key(const pmt_t &dict, const pmt_t &key)
Return true if key exists in dict.
PMT_API pmt_t caddr(pmt_t pair)
PMT_API void c64vector_set(pmt_t v, size_t k, std::complex< double > x)
PMT_API bool is_pair(const pmt_t &obj)
Return true if obj is a pair, else false.
PMT_API bool is_c64vector(pmt_t x)
PMT_API pmt_t assoc(pmt_t obj, pmt_t alist)
Find the first pair in alist whose car field is obj and return that pair.
PMT_API void * uniform_vector_writable_elements(pmt_t v, size_t &len)
Definition: pmt.h:881
PMT_API pmt_t from_bool(bool val)
Return #f is val is false, else return #t.
PMT_API pmt_t from_double(double x)
Return the pmt value that represents double x.
PMT_API std::ostream & operator<<(std::ostream &os, pmt_t obj)
PMT_API pmt_t make_s16vector(size_t k, int16_t fill)
Definition: pmt.h:73
PMT_API const std::vector< double > pmt_f64vector_elements(pmt_t v)
PMT_API bool is_complex(pmt_t obj)
return true if obj is a complex number, false otherwise.
boost::intrusive_ptr< pmt_base > pmt_t
typedef for shared pointer (transparent reference counting). See http://www.boost.org/libs/smart_ptr/smart_ptr.htm
Definition: pmt.h:56
signed int int32_t
Definition: stdint.h:77
PMT_API const std::complex< float > * c32vector_elements(pmt_t v, size_t &len)
PMT_API bool is_s8vector(pmt_t x)
PMT_API const std::vector< uint32_t > pmt_u32vector_elements(pmt_t v)
PMT_API pmt_t init_s16vector(size_t k, const int16_t *data)
PMT_API double f64vector_ref(pmt_t v, size_t k)
PMT_API const int64_t * s64vector_elements(pmt_t v, size_t &len)
PMT_API boost::shared_ptr< gr::messages::msg_accepter > msg_accepter_ref(const pmt_t &obj)
Return underlying msg_accepter.
PMT_API bool is_u32vector(pmt_t x)
PMT_API std::complex< float > * c32vector_writable_elements(pmt_t v, size_t &len)
bool operator()(pmt::pmt_t const &p1, pmt::pmt_t const &p2) const
Definition: pmt.h:876
PMT_API void print(pmt_t v)
Write pmt string representation to stdout.
static pmt_t acons(pmt_t x, pmt_t y, pmt_t a)
(acons x y a) == (cons (cons x y) a)
Definition: pmt.h:706
PMT_API pmt_t make_msg_accepter(boost::shared_ptr< gr::messages::msg_accepter > ma)
make a msg_accepter
PMT_API bool is_real(pmt_t obj)
PMT_API const std::vector< int32_t > pmt_s32vector_elements(pmt_t v)
PMT_API pmt_t make_u16vector(size_t k, uint16_t fill)
PMT_API bool is_number(pmt_t obj)
Return true if obj is any kind of number, else false.
PMT_API uint32_t u32vector_ref(pmt_t v, size_t k)
PMT_API std::complex< double > c64vector_ref(pmt_t v, size_t k)
PMT_API bool is_tuple(pmt_t x)
Return true if x is a tuple, othewise false.
PMT_API const void * blob_data(pmt_t blob)
Return a pointer to the blob's data.
PMT_API bool is_vector(pmt_t x)
Return true if x is a vector, othewise false.
PMT_API int16_t s16vector_ref(pmt_t v, size_t k)
PMT_API std::string write_string(pmt_t obj)
PMT_API int16_t * s16vector_writable_elements(pmt_t v, size_t &len)
PMT_API bool is_s16vector(pmt_t x)
PMT_API const std::vector< float > pmt_f32vector_elements(pmt_t v)
PMT_API const std::vector< uint8_t > pmt_u8vector_elements(pmt_t v)
PMT_API pmt_t make_f32vector(size_t k, float fill)
PMT_API pmt_t make_c64vector(size_t k, std::complex< double > fill)
PMT_API const pmt_t PMT_NIL