git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group___matrix_add.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: Matrix Addition</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42 </div>
  43 <div class="header">
  44   <div class="summary">
  45 <a href="#func-members">Functions</a>  </div>
  46   <div class="headertitle">
  47 <h1>Matrix Addition<br/>
  48 <small>
  49 [<a class="el" href="group__group_matrix.html">Matrix Functions</a>]</small>
  50 </h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <table class="memberdecls">
  54 <tr><td colspan="2"><h2><a name="func-members"></a>
  55 Functions</h2></td></tr>
  56 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___matrix_add.html#ga04bbf64a5f9c9e57dd1efb26a768aba1">arm_mat_add_f32</a> (const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pSrcA, const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pSrcB, <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pDst)</td></tr>
  57 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___matrix_add.html#ga7d9d7d81a0832a17b831aad1e4a5dc16">arm_mat_add_q31</a> (const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *pSrcA, const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *pSrcB, <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *pDst)</td></tr>
  58 <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___matrix_add.html#ga147e90b7c12a162735ab8824127a33ee">arm_mat_add_q15</a> (const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *pSrcA, const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *pSrcB, <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *pDst)</td></tr>
  59 </table>
  60 <hr/><a name="_details"></a><h2>Detailed Description</h2>
  61 <p>Adds two matrices. </p>
  62 <div align="center">
  63 <img src="MatrixAddition.gif" alt="MatrixAddition.gif"/>
  64 <p><strong>Addition of two 3 x 3 matrices</strong></p></div>
  65 <p>The functions check to make sure that <code>pSrcA</code>, <code>pSrcB</code>, and <code>pDst</code> have the same number of rows and columns. </p>
  66 <hr/><h2>Function Documentation</h2>
  67 <a class="anchor" id="ga04bbf64a5f9c9e57dd1efb26a768aba1"></a><!-- doxytag: member="arm_mat_add_f32.c::arm_mat_add_f32" ref="ga04bbf64a5f9c9e57dd1efb26a768aba1" args="(const arm_matrix_instance_f32 *pSrcA, const arm_matrix_instance_f32 *pSrcB, arm_matrix_instance_f32 *pDst)" -->
  68 <div class="memitem">
  69 <div class="memproto">
  70       <table class="memname">
  71         <tr>
  72           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_add_f32 </td>
  73           <td>(</td>
  74           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
  75           <td class="paramname"> <em>pSrcA</em>, </td>
  76         </tr>
  77         <tr>
  78           <td class="paramkey"></td>
  79           <td></td>
  80           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
  81           <td class="paramname"> <em>pSrcB</em>, </td>
  82         </tr>
  83         <tr>
  84           <td class="paramkey"></td>
  85           <td></td>
  86           <td class="paramtype"><a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
  87           <td class="paramname"> <em>pDst</em>&#160;</td>
  88         </tr>
  89         <tr>
  90           <td></td>
  91           <td>)</td>
  92           <td></td><td></td>
  93         </tr>
  94       </table>
  95 </div>
  96 <div class="memdoc">
  97
  98 <p>Floating-point matrix addition. </p>
  99 <dl><dt><b>Parameters:</b></dt><dd>
 100   <table class="params">
 101     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
 102     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
 103     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 104   </table>
 105   </dd>
 106 </dl>
 107 <dl class="return"><dt><b>Returns:</b></dt><dd>The function returns either <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking. </dd></dl>
 108
 109 <p>Definition at line <a class="el" href="arm__mat__add__f32_8c_source.html#l00068">68</a> of file <a class="el" href="arm__mat__add__f32_8c_source.html">arm_mat_add_f32.c</a>.</p>
 110
 111 </div>
 112 </div>
 113 <a class="anchor" id="ga7d9d7d81a0832a17b831aad1e4a5dc16"></a><!-- doxytag: member="arm_mat_add_q31.c::arm_mat_add_q31" ref="ga7d9d7d81a0832a17b831aad1e4a5dc16" args="(const arm_matrix_instance_q31 *pSrcA, const arm_matrix_instance_q31 *pSrcB, arm_matrix_instance_q31 *pDst)" -->
 114 <div class="memitem">
 115 <div class="memproto">
 116       <table class="memname">
 117         <tr>
 118           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_add_q31 </td>
 119           <td>(</td>
 120           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
 121           <td class="paramname"> <em>pSrcA</em>, </td>
 122         </tr>
 123         <tr>
 124           <td class="paramkey"></td>
 125           <td></td>
 126           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
 127           <td class="paramname"> <em>pSrcB</em>, </td>
 128         </tr>
 129         <tr>
 130           <td class="paramkey"></td>
 131           <td></td>
 132           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
 133           <td class="paramname"> <em>pDst</em>&#160;</td>
 134         </tr>
 135         <tr>
 136           <td></td>
 137           <td>)</td>
 138           <td></td><td></td>
 139         </tr>
 140       </table>
 141 </div>
 142 <div class="memdoc">
 143
 144 <p>Q31 matrix addition. </p>
 145 <dl><dt><b>Parameters:</b></dt><dd>
 146   <table class="params">
 147     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
 148     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
 149     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 150   </table>
 151   </dd>
 152 </dl>
 153 <dl class="return"><dt><b>Returns:</b></dt><dd>The function returns either <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.</dd></dl>
 154 <p><b>Scaling and Overflow Behavior:</b> </p>
 155 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] will be saturated. </dd></dl>
 156
 157 <p>Definition at line <a class="el" href="arm__mat__add__q31_8c_source.html#l00061">61</a> of file <a class="el" href="arm__mat__add__q31_8c_source.html">arm_mat_add_q31.c</a>.</p>
 158
 159 </div>
 160 </div>
 161 <a class="anchor" id="ga147e90b7c12a162735ab8824127a33ee"></a><!-- doxytag: member="arm_mat_add_q15.c::arm_mat_add_q15" ref="ga147e90b7c12a162735ab8824127a33ee" args="(const arm_matrix_instance_q15 *pSrcA, const arm_matrix_instance_q15 *pSrcB, arm_matrix_instance_q15 *pDst)" -->
 162 <div class="memitem">
 163 <div class="memproto">
 164       <table class="memname">
 165         <tr>
 166           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_add_q15 </td>
 167           <td>(</td>
 168           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
 169           <td class="paramname"> <em>pSrcA</em>, </td>
 170         </tr>
 171         <tr>
 172           <td class="paramkey"></td>
 173           <td></td>
 174           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
 175           <td class="paramname"> <em>pSrcB</em>, </td>
 176         </tr>
 177         <tr>
 178           <td class="paramkey"></td>
 179           <td></td>
 180           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
 181           <td class="paramname"> <em>pDst</em>&#160;</td>
 182         </tr>
 183         <tr>
 184           <td></td>
 185           <td>)</td>
 186           <td></td><td></td>
 187         </tr>
 188       </table>
 189 </div>
 190 <div class="memdoc">
 191
 192 <p>Q15 matrix addition. </p>
 193 <dl><dt><b>Parameters:</b></dt><dd>
 194   <table class="params">
 195     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
 196     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
 197     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 198   </table>
 199   </dd>
 200 </dl>
 201 <dl class="return"><dt><b>Returns:</b></dt><dd>The function returns either <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.</dd></dl>
 202 <p><b>Scaling and Overflow Behavior:</b> </p>
 203 <dl class="user"><dt><b></b></dt><dd>The function uses saturating arithmetic. Results outside of the allowable Q15 range [0x8000 0x7FFF] will be saturated. </dd></dl>
 204
 205 <p>Definition at line <a class="el" href="arm__mat__add__q15_8c_source.html#l00061">61</a> of file <a class="el" href="arm__mat__add__q15_8c_source.html">arm_mat_add_q15.c</a>.</p>
 206
 207 </div>
 208 </div>
 209 </div>
 210 <!--- window showing the filter options -->
 211 <div id="MSearchSelectWindow"
 212      onmouseover="return searchBox.OnSearchSelectShow()"
 213      onmouseout="return searchBox.OnSearchSelectHide()"
 214      onkeydown="return searchBox.OnSearchSelectKey(event)">
 215 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 216
 217 <!-- iframe showing the search results (closed by default) -->
 218 <div id="MSearchResultsWindow">
 219 <iframe src="" frameborder="0"
 220         name="MSearchResults" id="MSearchResults">
 221 </iframe>
 222 </div>
 223
 224 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:21 for CMSIS DSP Software Library by&#160;
 225 <a href="http://www.doxygen.org/index.html">
 226 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 227 </body>
 228 </html>