<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.8"/>
<title>libosmodsp: Complex vectors</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">libosmodsp
 <span id="projectnumber">UNKNOWN</span>
</div>
<div id="projectbrief">Osmocom DSP library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.8 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__cxvec.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#files">Files</a> |
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Complex vectors</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cxvec__math"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec__math.html">Complex vectors math and signal processing</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="files"></a>
Files</h2></td></tr>
<tr class="memitem:cxvec_8h"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="cxvec_8h.html">cxvec.h</a></td></tr>
<tr class="memdesc:cxvec_8h"><td class="mdescLeft"> </td><td class="mdescRight">Osmocom Complex vectors header. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:cxvec_8c"><td class="memItemLeft" align="right" valign="top">file  </td><td class="memItemRight" valign="bottom"><a class="el" href="cxvec_8c.html">cxvec.c</a></td></tr>
<tr class="memdesc:cxvec_8c"><td class="mdescLeft"> </td><td class="mdescRight">Osmocom Complex vectors implementation. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structosmo__cxvec.html">osmo_cxvec</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Complex vector. <a href="structosmo__cxvec.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gaa03ae6bbc24d094b8955d905832f0c36"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec.html#gaa03ae6bbc24d094b8955d905832f0c36">osmo_cxvec_init_from_data</a> (struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> *cv, float complex *data, int len)</td></tr>
<tr class="memdesc:gaa03ae6bbc24d094b8955d905832f0c36"><td class="mdescLeft"> </td><td class="mdescRight">Initialize a vector structure with a given data array. <a href="#gaa03ae6bbc24d094b8955d905832f0c36">More...</a><br /></td></tr>
<tr class="separator:gaa03ae6bbc24d094b8955d905832f0c36"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga4edecda809e91f11cf88b53a1db8d62a"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec.html#ga4edecda809e91f11cf88b53a1db8d62a">osmo_cxvec_alloc_from_data</a> (float complex *data, int len)</td></tr>
<tr class="memdesc:ga4edecda809e91f11cf88b53a1db8d62a"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a complex vector referencing a given data array. <a href="#ga4edecda809e91f11cf88b53a1db8d62a">More...</a><br /></td></tr>
<tr class="separator:ga4edecda809e91f11cf88b53a1db8d62a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9461ac13f1d77ca832b140461e599caa"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec.html#ga9461ac13f1d77ca832b140461e599caa">osmo_cxvec_alloc</a> (int max_len)</td></tr>
<tr class="memdesc:ga9461ac13f1d77ca832b140461e599caa"><td class="mdescLeft"> </td><td class="mdescRight">Allocate a complex vector of a given maximum length. <a href="#ga9461ac13f1d77ca832b140461e599caa">More...</a><br /></td></tr>
<tr class="separator:ga9461ac13f1d77ca832b140461e599caa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaa57240ff2299122f9375e901b9700e7d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec.html#gaa57240ff2299122f9375e901b9700e7d">osmo_cxvec_free</a> (struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> *cv)</td></tr>
<tr class="memdesc:gaa57240ff2299122f9375e901b9700e7d"><td class="mdescLeft"> </td><td class="mdescRight">Free a complex vector (and possibly associated data) <a href="#gaa57240ff2299122f9375e901b9700e7d">More...</a><br /></td></tr>
<tr class="separator:gaa57240ff2299122f9375e901b9700e7d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga69e6d1ea3d468954cedf7d6f8d44f825"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cxvec.html#ga69e6d1ea3d468954cedf7d6f8d44f825">osmo_cxvec_dbg_dump</a> (struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> *cv, const char *fname)</td></tr>
<tr class="memdesc:ga69e6d1ea3d468954cedf7d6f8d44f825"><td class="mdescLeft"> </td><td class="mdescRight">Save the data contained of a vector into a .cfile for debug. <a href="#ga69e6d1ea3d468954cedf7d6f8d44f825">More...</a><br /></td></tr>
<tr class="separator:ga69e6d1ea3d468954cedf7d6f8d44f825"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga9461ac13f1d77ca832b140461e599caa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * osmo_cxvec_alloc </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>max_len</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a complex vector of a given maximum length. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">max_len</td><td>Maximum length of data</td></tr>
</table>
</dd>
</dl>
<p>Data array is allocated along with the structure, but is uninitialized. Length is set to 0. </p>
<p>References <a class="el" href="structosmo__cxvec.html#aa8a9de0ef88d44caa1c07bc91b99bffd">osmo_cxvec::_data</a>, <a class="el" href="structosmo__cxvec.html#aec620e4391a60de801eb23dec73e4d12">osmo_cxvec::data</a>, <a class="el" href="structosmo__cxvec.html#ab3bd5fac3c3a84df65bc82d1cae223ab">osmo_cxvec::flags</a>, <a class="el" href="structosmo__cxvec.html#a03722af5764b41c9151a7542546e3739">osmo_cxvec::len</a>, and <a class="el" href="structosmo__cxvec.html#a42469c5c904c26c45af3ff557ccd203f">osmo_cxvec::max_len</a>.</p>
<p>Referenced by <a class="el" href="group__cxvec__math.html#ga2ebadb16e25768896013420a98ec666f">osmo_cxvec_convolve()</a>, <a class="el" href="group__cxvec__math.html#ga99ff6e3baec3253f4e431b156f042a0f">osmo_cxvec_correlate()</a>, <a class="el" href="group__cxvec__math.html#ga9fa20d926f9d313a4751cef1eff740ba">osmo_cxvec_delay()</a>, <a class="el" href="group__cxvec__math.html#ga49125f3c259da9d7eec7fa4d98d609d4">osmo_cxvec_rotate()</a>, <a class="el" href="group__cxvec__math.html#ga5ac0adb49726087258381582582ef654">osmo_cxvec_scale()</a>, <a class="el" href="group__cxvec__math.html#ga4579583a658fc33afd24a1d8508b212f">osmo_cxvec_sig_normalize()</a>, <a class="el" href="group__iqbal.html#ga978fbf1c9f01694852c561c95d5ceb9d">osmo_iqbal_cxvec_fix()</a>, and <a class="el" href="group__iqbal.html#gac74f9d37e2153fdf954e592b36f7c7c0">osmo_iqbal_cxvec_optimize()</a>.</p>
</div>
</div>
<a class="anchor" id="ga4edecda809e91f11cf88b53a1db8d62a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * osmo_cxvec_alloc_from_data </td>
<td>(</td>
<td class="paramtype">float complex * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate a complex vector referencing a given data array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to the complex data array </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Number of complex samples</td></tr>
</table>
</dd>
</dl>
<p>The data is not copied, it is just referenced. </p>
<p>References <a class="el" href="group__cxvec.html#gaa03ae6bbc24d094b8955d905832f0c36">osmo_cxvec_init_from_data()</a>.</p>
</div>
</div>
<a class="anchor" id="ga69e6d1ea3d468954cedf7d6f8d44f825"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osmo_cxvec_dbg_dump </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * </td>
<td class="paramname"><em>cv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>fname</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Save the data contained of a vector into a .cfile for debug. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cv</td><td>Complex vector to save </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">fname</td><td>Filename to save the data to </td></tr>
</table>
</dd>
</dl>
<p>References <a class="el" href="structosmo__cxvec.html#aec620e4391a60de801eb23dec73e4d12">osmo_cxvec::data</a>, and <a class="el" href="structosmo__cxvec.html#a03722af5764b41c9151a7542546e3739">osmo_cxvec::len</a>.</p>
</div>
</div>
<a class="anchor" id="gaa57240ff2299122f9375e901b9700e7d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osmo_cxvec_free </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * </td>
<td class="paramname"><em>cv</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a complex vector (and possibly associated data) </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">cv</td><td>Complex vector to free</td></tr>
</table>
</dd>
</dl>
<p>Notes: - Can be safely called with NULL</p><ul>
<li>If the data was allocated with the vector using <a class="el" href="group__cxvec.html#ga9461ac13f1d77ca832b140461e599caa">osmo_cxvec_alloc</a> , it will be free as well. If the data was pre-existing ( <a class="el" href="group__cxvec.html#gaa03ae6bbc24d094b8955d905832f0c36">osmo_cxvec_init_from_data</a> or <a class="el" href="group__cxvec.html#ga4edecda809e91f11cf88b53a1db8d62a">osmo_cxvec_alloc_from_data</a> ) it will not be free'd. </li>
</ul>
<p>Referenced by <a class="el" href="group__cxvec__math.html#ga9fa20d926f9d313a4751cef1eff740ba">osmo_cxvec_delay()</a>, and <a class="el" href="group__iqbal.html#gac74f9d37e2153fdf954e592b36f7c7c0">osmo_iqbal_cxvec_optimize()</a>.</p>
</div>
</div>
<a class="anchor" id="gaa03ae6bbc24d094b8955d905832f0c36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void osmo_cxvec_init_from_data </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structosmo__cxvec.html">osmo_cxvec</a> * </td>
<td class="paramname"><em>cv</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">float complex * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>len</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize a vector structure with a given data array. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">cv</td><td>The vector to be initialized </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">data</td><td>Pointer to the complex data array </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">len</td><td>Number of complex samples</td></tr>
</table>
</dd>
</dl>
<p>The data is not copied, it is just referenced. </p>
<p>References <a class="el" href="structosmo__cxvec.html#aec620e4391a60de801eb23dec73e4d12">osmo_cxvec::data</a>, <a class="el" href="structosmo__cxvec.html#ab3bd5fac3c3a84df65bc82d1cae223ab">osmo_cxvec::flags</a>, <a class="el" href="structosmo__cxvec.html#a03722af5764b41c9151a7542546e3739">osmo_cxvec::len</a>, and <a class="el" href="structosmo__cxvec.html#a42469c5c904c26c45af3ff557ccd203f">osmo_cxvec::max_len</a>.</p>
<p>Referenced by <a class="el" href="group__cxvec.html#ga4edecda809e91f11cf88b53a1db8d62a">osmo_cxvec_alloc_from_data()</a>, and <a class="el" href="group__cxvec__math.html#ga9fa20d926f9d313a4751cef1eff740ba">osmo_cxvec_delay()</a>.</p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="footer">Generated on Fri Jan 16 2015 21:29:20 for libosmodsp by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.8 </li>
</ul>
</div>
</body>
</html>
distrib
>
Mageia
>
5
>
x86_64
>
media
>
core-release
>
by-pkgid
>
bd1d7acf4abd8e5b4772def1c4c77c48
>
files
>
60
