PageRenderTime 33ms CodeModel.GetById 8ms RepoModel.GetById 0ms app.codeStats 0ms

/trunc/src/STM32F4-Discovery-Firmware-Makefile/Libraries/CMSIS/Documentation/DSP_Lib/html/group___matrix_sub.html

https://bitbucket.org/trottagio/stm32f4-discovery-firmware-makefile
HTML | 228 lines | 213 code | 11 blank | 4 comment | 0 complexity | 9071eb50a69f640173b8d772aee4089f MD5 | raw file
    

  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    2. 

  2. <html xmlns="http://www.w3.org/1999/xhtml">
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
    5. 

  5. <title>CMSIS DSP Software Library: Matrix Subtraction</title>
    6. 

  6. <link href="tabs.css" rel="stylesheet" type="text/css"/>
    7. 

  7. <link href="search/search.css" rel="stylesheet" type="text/css"/>
    8. 

  8. <script type="text/javaScript" src="search/search.js"></script>
    9. 

  9. <link href="doxygen.css" rel="stylesheet" type="text/css"/>
    10. 

  10. </head>
    11. 

  11. <body onload='searchBox.OnSelectItem(0);'>
    12. 

  12. <!-- Generated by Doxygen 1.7.2 -->
    13. 

  13. <script type="text/javascript"><!--
    14. 

  14. var searchBox = new SearchBox("searchBox", "search",false,'Search');
    15. 

  15. --></script>
    16. 

  16. <div class="navigation" id="top">
    17. 

  17.   <div class="tabs">
    18. 

  18.     <ul class="tablist">
    19. 

  19.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
    20. 

  20.       <li><a href="modules.html"><span>Modules</span></a></li>
    21. 

  21.       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
    22. 

  22.       <li><a href="files.html"><span>Files</span></a></li>
    23. 

  23.       <li><a href="examples.html"><span>Examples</span></a></li>
    24. 

  24.       <li id="searchli">
    25. 

  25.         <div id="MSearchBox" class="MSearchBoxInactive">
    26. 

  26.         <span class="left">
    27. 

  27.           <img id="MSearchSelect" src="search/mag_sel.png"
    28. 

  28.                onmouseover="return searchBox.OnSearchSelectShow()"
    29. 

  29.                onmouseout="return searchBox.OnSearchSelectHide()"
    30. 

  30.                alt=""/>
    31. 

  31.           <input type="text" id="MSearchField" value="Search" accesskey="S"
    32. 

  32.                onfocus="searchBox.OnSearchFieldFocus(true)" 
    33. 

  33.                onblur="searchBox.OnSearchFieldFocus(false)" 
    34. 

  34.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
    35. 

  35.           </span><span class="right">
    36. 

  36.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
    37. 

  37.           </span>
    38. 

  38.         </div>
    39. 

  39.       </li>
    40. 

  40.     </ul>
    41. 

  41.   </div>
    42. 

  42. </div>
    43. 

  43. <div class="header">
    44. 

  44.   <div class="summary">
    45. 

  45. <a href="#func-members">Functions</a>  </div>
    46. 

  46.   <div class="headertitle">
    47. 

  47. <h1>Matrix Subtraction<br/>
    48. 

  48. <small>
    49. 

  49. [<a class="el" href="group__group_matrix.html">Matrix Functions</a>]</small>
    50. 

  50. </h1>  </div>
    51. 

  51. </div>
    52. 

  52. <div class="contents">
    53. 

  53. <table class="memberdecls">
    54. 

  54. <tr><td colspan="2"><h2><a name="func-members"></a>
    55. 

  55. Functions</h2></td></tr>
    56. 

  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_sub.html#gac8b72fb70246ccfee3b372002345732c">arm_mat_sub_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. 

  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_sub.html#ga39f42e0e3b7f115fbb909d6ff4e1329d">arm_mat_sub_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. 

  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_sub.html#gaf647776a425b7f9dd0aca3e11d81f02f">arm_mat_sub_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. 

  59. </table>
    60. 

  60. <hr/><a name="_details"></a><h2>Detailed Description</h2>
    61. 

  61. <p>Subtract two matrices. </p>
    62. 

  62. <div align="center">
    63. 

  63. <img src="MatrixSubtraction.gif" alt="MatrixSubtraction.gif"/>
    64. 

  64. <p><strong>Subraction of two 3 x 3 matrices</strong></p></div>
    65. 

  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. 

  66. <hr/><h2>Function Documentation</h2>
    67. 

  67. <a class="anchor" id="gac8b72fb70246ccfee3b372002345732c"></a><!-- doxytag: member="arm_mat_sub_f32.c::arm_mat_sub_f32" ref="gac8b72fb70246ccfee3b372002345732c" args="(const arm_matrix_instance_f32 *pSrcA, const arm_matrix_instance_f32 *pSrcB, arm_matrix_instance_f32 *pDst)" -->
    68. 

  68. <div class="memitem">
    69. 

  69. <div class="memproto">
    70. 

  70.       <table class="memname">
    71. 

  71.         <tr>
    72. 

  72.           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_sub_f32 </td>
    73. 

  73.           <td>(</td>
    74. 

  74.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
    75. 

  75.           <td class="paramname"> <em>pSrcA</em>, </td>
    76. 

  76.         </tr>
    77. 

  77.         <tr>
    78. 

  78.           <td class="paramkey"></td>
    79. 

  79.           <td></td>
    80. 

  80.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
    81. 

  81.           <td class="paramname"> <em>pSrcB</em>, </td>
    82. 

  82.         </tr>
    83. 

  83.         <tr>
    84. 

  84.           <td class="paramkey"></td>
    85. 

  85.           <td></td>
    86. 

  86.           <td class="paramtype"><a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
    87. 

  87.           <td class="paramname"> <em>pDst</em>&#160;</td>
    88. 

  88.         </tr>
    89. 

  89.         <tr>
    90. 

  90.           <td></td>
    91. 

  91.           <td>)</td>
    92. 

  92.           <td></td><td></td>
    93. 

  93.         </tr>
    94. 

  94.       </table>
    95. 

  95. </div>
    96. 

  96. <div class="memdoc">
    97. 

  97. 

  98. <p>Floating-point matrix subtraction. </p>
    99. 

  99. <dl><dt><b>Parameters:</b></dt><dd>
    100. 

  100.   <table class="params">
    101. 

  101.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
    102. 

  102.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
    103. 

  103.     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
    104. 

  104.   </table>
    105. 

  105.   </dd>
    106. 

  106. </dl>
    107. 

  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. 

  108. 

  109. <p>Definition at line <a class="el" href="arm__mat__sub__f32_8c_source.html#l00067">67</a> of file <a class="el" href="arm__mat__sub__f32_8c_source.html">arm_mat_sub_f32.c</a>.</p>
    110. 

  110. 

  111. </div>
    112. 

  112. </div>
    113. 

  113. <a class="anchor" id="ga39f42e0e3b7f115fbb909d6ff4e1329d"></a><!-- doxytag: member="arm_mat_sub_q31.c::arm_mat_sub_q31" ref="ga39f42e0e3b7f115fbb909d6ff4e1329d" args="(const arm_matrix_instance_q31 *pSrcA, const arm_matrix_instance_q31 *pSrcB, arm_matrix_instance_q31 *pDst)" -->
    114. 

  114. <div class="memitem">
    115. 

  115. <div class="memproto">
    116. 

  116.       <table class="memname">
    117. 

  117.         <tr>
    118. 

  118.           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_sub_q31 </td>
    119. 

  119.           <td>(</td>
    120. 

  120.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
    121. 

  121.           <td class="paramname"> <em>pSrcA</em>, </td>
    122. 

  122.         </tr>
    123. 

  123.         <tr>
    124. 

  124.           <td class="paramkey"></td>
    125. 

  125.           <td></td>
    126. 

  126.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
    127. 

  127.           <td class="paramname"> <em>pSrcB</em>, </td>
    128. 

  128.         </tr>
    129. 

  129.         <tr>
    130. 

  130.           <td class="paramkey"></td>
    131. 

  131.           <td></td>
    132. 

  132.           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
    133. 

  133.           <td class="paramname"> <em>pDst</em>&#160;</td>
    134. 

  134.         </tr>
    135. 

  135.         <tr>
    136. 

  136.           <td></td>
    137. 

  137.           <td>)</td>
    138. 

  138.           <td></td><td></td>
    139. 

  139.         </tr>
    140. 

  140.       </table>
    141. 

  141. </div>
    142. 

  142. <div class="memdoc">
    143. 

  143. 

  144. <p>Q31 matrix subtraction. </p>
    145. 

  145. <dl><dt><b>Parameters:</b></dt><dd>
    146. 

  146.   <table class="params">
    147. 

  147.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
    148. 

  148.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
    149. 

  149.     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
    150. 

  150.   </table>
    151. 

  151.   </dd>
    152. 

  152. </dl>
    153. 

  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. 

  154. <p><b>Scaling and Overflow Behavior:</b> </p>
    155. 

  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. 

  156. 

  157. <p>Definition at line <a class="el" href="arm__mat__sub__q31_8c_source.html#l00062">62</a> of file <a class="el" href="arm__mat__sub__q31_8c_source.html">arm_mat_sub_q31.c</a>.</p>
    158. 

  158. 

  159. </div>
    160. 

  160. </div>
    161. 

  161. <a class="anchor" id="gaf647776a425b7f9dd0aca3e11d81f02f"></a><!-- doxytag: member="arm_mat_sub_q15.c::arm_mat_sub_q15" ref="gaf647776a425b7f9dd0aca3e11d81f02f" args="(const arm_matrix_instance_q15 *pSrcA, const arm_matrix_instance_q15 *pSrcB, arm_matrix_instance_q15 *pDst)" -->
    162. 

  162. <div class="memitem">
    163. 

  163. <div class="memproto">
    164. 

  164.       <table class="memname">
    165. 

  165.         <tr>
    166. 

  166.           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_sub_q15 </td>
    167. 

  167.           <td>(</td>
    168. 

  168.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
    169. 

  169.           <td class="paramname"> <em>pSrcA</em>, </td>
    170. 

  170.         </tr>
    171. 

  171.         <tr>
    172. 

  172.           <td class="paramkey"></td>
    173. 

  173.           <td></td>
    174. 

  174.           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
    175. 

  175.           <td class="paramname"> <em>pSrcB</em>, </td>
    176. 

  176.         </tr>
    177. 

  177.         <tr>
    178. 

  178.           <td class="paramkey"></td>
    179. 

  179.           <td></td>
    180. 

  180.           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
    181. 

  181.           <td class="paramname"> <em>pDst</em>&#160;</td>
    182. 

  182.         </tr>
    183. 

  183.         <tr>
    184. 

  184.           <td></td>
    185. 

  185.           <td>)</td>
    186. 

  186.           <td></td><td></td>
    187. 

  187.         </tr>
    188. 

  188.       </table>
    189. 

  189. </div>
    190. 

  190. <div class="memdoc">
    191. 

  191. 

  192. <p>Q15 matrix subtraction. </p>
    193. 

  193. <dl><dt><b>Parameters:</b></dt><dd>
    194. 

  194.   <table class="params">
    195. 

  195.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcA</td><td>points to the first input matrix structure </td></tr>
    196. 

  196.     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrcB</td><td>points to the second input matrix structure </td></tr>
    197. 

  197.     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
    198. 

  198.   </table>
    199. 

  199.   </dd>
    200. 

  200. </dl>
    201. 

  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. 

  202. <p><b>Scaling and Overflow Behavior:</b> </p>
    203. 

  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. 

  204. 

  205. <p>Definition at line <a class="el" href="arm__mat__sub__q15_8c_source.html#l00061">61</a> of file <a class="el" href="arm__mat__sub__q15_8c_source.html">arm_mat_sub_q15.c</a>.</p>
    206. 

  206. 

  207. </div>
    208. 

  208. </div>
    209. 

  209. </div>
    210. 

  210. <!--- window showing the filter options -->
    211. 

  211. <div id="MSearchSelectWindow"
    212. 

  212.      onmouseover="return searchBox.OnSearchSelectShow()"
    213. 

  213.      onmouseout="return searchBox.OnSearchSelectHide()"
    214. 

  214.      onkeydown="return searchBox.OnSearchSelectKey(event)">
    215. 

  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. 

  216. 

  217. <!-- iframe showing the search results (closed by default) -->
    218. 

  218. <div id="MSearchResultsWindow">
    219. 

  219. <iframe src="" frameborder="0" 
    220. 

  220.         name="MSearchResults" id="MSearchResults">
    221. 

  221. </iframe>
    222. 

  222. </div>
    223. 

  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. 

  225. <a href="http://www.doxygen.org/index.html">
    226. 

  226. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
    227. 

  227. </body>
    228. 

  228. </html>
    229. 

  229.