git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/group___matrix_scale.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 Scale</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 Scale<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_scale.html#ga9cb4e385b18c9a0b9cbc940c1067ca12">arm_mat_scale_f32</a> (const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *pSrc, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> scale, <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_scale.html#ga609743821ee81fa8c34c4bcdc1ed9744">arm_mat_scale_q31</a> (const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *pSrc, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> scaleFract, int32_t shift, <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_scale.html#ga7521769e2cf1c3d9c4656138cd2ae2ca">arm_mat_scale_q15</a> (const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *pSrc, <a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a> scaleFract, int32_t shift, <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>Multiplies a matrix by a scalar. This is accomplished by multiplying each element in the matrix by the scalar. For example: </p>
  62 <div align="center">
  63 <img src="MatrixScale.gif" alt="MatrixScale.gif"/>
  64 <p><strong>Matrix Scaling of a 3 x 3 matrix</strong></p></div>
  65 <p>The function checks to make sure that the input and output matrices are of the same size.</p>
  66 <p>In the fixed-point Q15 and Q31 functions, <code>scale</code> is represented by a fractional multiplication <code>scaleFract</code> and an arithmetic shift <code>shift</code>. The shift allows the gain of the scaling operation to exceed 1.0. The overall scale factor applied to the fixed-point data is </p>
  67 <pre>
  68      scale = scaleFract * 2^shift.
  69  </pre> <hr/><h2>Function Documentation</h2>
  70 <a class="anchor" id="ga9cb4e385b18c9a0b9cbc940c1067ca12"></a><!-- doxytag: member="arm_mat_scale_f32.c::arm_mat_scale_f32" ref="ga9cb4e385b18c9a0b9cbc940c1067ca12" args="(const arm_matrix_instance_f32 *pSrc, float32_t scale, arm_matrix_instance_f32 *pDst)" -->
  71 <div class="memitem">
  72 <div class="memproto">
  73       <table class="memname">
  74         <tr>
  75           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_scale_f32 </td>
  76           <td>(</td>
  77           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
  78           <td class="paramname"> <em>pSrc</em>, </td>
  79         </tr>
  80         <tr>
  81           <td class="paramkey"></td>
  82           <td></td>
  83           <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
  84           <td class="paramname"> <em>scale</em>, </td>
  85         </tr>
  86         <tr>
  87           <td class="paramkey"></td>
  88           <td></td>
  89           <td class="paramtype"><a class="el" href="structarm__matrix__instance__f32.html">arm_matrix_instance_f32</a> *&#160;</td>
  90           <td class="paramname"> <em>pDst</em>&#160;</td>
  91         </tr>
  92         <tr>
  93           <td></td>
  94           <td>)</td>
  95           <td></td><td></td>
  96         </tr>
  97       </table>
  98 </div>
  99 <div class="memdoc">
 100
 101 <p>Floating-point matrix scaling. </p>
 102 <dl><dt><b>Parameters:</b></dt><dd>
 103   <table class="params">
 104     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to input matrix structure </td></tr>
 105     <tr><td class="paramdir">[in]</td><td class="paramname">scale</td><td>scale factor to be applied </td></tr>
 106     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 107   </table>
 108   </dd>
 109 </dl>
 110 <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>
 111
 112 <p>Definition at line <a class="el" href="arm__mat__scale__f32_8c_source.html#l00075">75</a> of file <a class="el" href="arm__mat__scale__f32_8c_source.html">arm_mat_scale_f32.c</a>.</p>
 113
 114 </div>
 115 </div>
 116 <a class="anchor" id="ga609743821ee81fa8c34c4bcdc1ed9744"></a><!-- doxytag: member="arm_mat_scale_q31.c::arm_mat_scale_q31" ref="ga609743821ee81fa8c34c4bcdc1ed9744" args="(const arm_matrix_instance_q31 *pSrc, q31_t scaleFract, int32_t shift, arm_matrix_instance_q31 *pDst)" -->
 117 <div class="memitem">
 118 <div class="memproto">
 119       <table class="memname">
 120         <tr>
 121           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_scale_q31 </td>
 122           <td>(</td>
 123           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
 124           <td class="paramname"> <em>pSrc</em>, </td>
 125         </tr>
 126         <tr>
 127           <td class="paramkey"></td>
 128           <td></td>
 129           <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
 130           <td class="paramname"> <em>scaleFract</em>, </td>
 131         </tr>
 132         <tr>
 133           <td class="paramkey"></td>
 134           <td></td>
 135           <td class="paramtype">int32_t&#160;</td>
 136           <td class="paramname"> <em>shift</em>, </td>
 137         </tr>
 138         <tr>
 139           <td class="paramkey"></td>
 140           <td></td>
 141           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q31.html">arm_matrix_instance_q31</a> *&#160;</td>
 142           <td class="paramname"> <em>pDst</em>&#160;</td>
 143         </tr>
 144         <tr>
 145           <td></td>
 146           <td>)</td>
 147           <td></td><td></td>
 148         </tr>
 149       </table>
 150 </div>
 151 <div class="memdoc">
 152
 153 <p>Q31 matrix scaling. </p>
 154 <dl><dt><b>Parameters:</b></dt><dd>
 155   <table class="params">
 156     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to input matrix </td></tr>
 157     <tr><td class="paramdir">[in]</td><td class="paramname">scaleFract</td><td>fractional portion of the scale factor </td></tr>
 158     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>number of bits to shift the result by </td></tr>
 159     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 160   </table>
 161   </dd>
 162 </dl>
 163 <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>
 164 <p><b>Scaling and Overflow Behavior:</b> </p>
 165 <dl class="user"><dt><b></b></dt><dd>The input data <code>*pSrc</code> and <code>scaleFract</code> are in 1.31 format. These are multiplied to yield a 2.62 intermediate result and this is shifted with saturation to 1.31 format. </dd></dl>
 166
 167 <p>Definition at line <a class="el" href="arm__mat__scale__q31_8c_source.html#l00063">63</a> of file <a class="el" href="arm__mat__scale__q31_8c_source.html">arm_mat_scale_q31.c</a>.</p>
 168
 169 </div>
 170 </div>
 171 <a class="anchor" id="ga7521769e2cf1c3d9c4656138cd2ae2ca"></a><!-- doxytag: member="arm_mat_scale_q15.c::arm_mat_scale_q15" ref="ga7521769e2cf1c3d9c4656138cd2ae2ca" args="(const arm_matrix_instance_q15 *pSrc, q15_t scaleFract, int32_t shift, arm_matrix_instance_q15 *pDst)" -->
 172 <div class="memitem">
 173 <div class="memproto">
 174       <table class="memname">
 175         <tr>
 176           <td class="memname"><a class="el" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6">arm_status</a> arm_mat_scale_q15 </td>
 177           <td>(</td>
 178           <td class="paramtype">const <a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
 179           <td class="paramname"> <em>pSrc</em>, </td>
 180         </tr>
 181         <tr>
 182           <td class="paramkey"></td>
 183           <td></td>
 184           <td class="paramtype"><a class="el" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea">q15_t</a>&#160;</td>
 185           <td class="paramname"> <em>scaleFract</em>, </td>
 186         </tr>
 187         <tr>
 188           <td class="paramkey"></td>
 189           <td></td>
 190           <td class="paramtype">int32_t&#160;</td>
 191           <td class="paramname"> <em>shift</em>, </td>
 192         </tr>
 193         <tr>
 194           <td class="paramkey"></td>
 195           <td></td>
 196           <td class="paramtype"><a class="el" href="structarm__matrix__instance__q15.html">arm_matrix_instance_q15</a> *&#160;</td>
 197           <td class="paramname"> <em>pDst</em>&#160;</td>
 198         </tr>
 199         <tr>
 200           <td></td>
 201           <td>)</td>
 202           <td></td><td></td>
 203         </tr>
 204       </table>
 205 </div>
 206 <div class="memdoc">
 207
 208 <p>Q15 matrix scaling. </p>
 209 <dl><dt><b>Parameters:</b></dt><dd>
 210   <table class="params">
 211     <tr><td class="paramdir">[in]</td><td class="paramname">*pSrc</td><td>points to input matrix </td></tr>
 212     <tr><td class="paramdir">[in]</td><td class="paramname">scaleFract</td><td>fractional portion of the scale factor </td></tr>
 213     <tr><td class="paramdir">[in]</td><td class="paramname">shift</td><td>number of bits to shift the result by </td></tr>
 214     <tr><td class="paramdir">[out]</td><td class="paramname">*pDst</td><td>points to output matrix structure </td></tr>
 215   </table>
 216   </dd>
 217 </dl>
 218 <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>
 219 <p><b>Scaling and Overflow Behavior:</b> </p>
 220 <dl class="user"><dt><b></b></dt><dd>The input data <code>*pSrc</code> and <code>scaleFract</code> are in 1.15 format. These are multiplied to yield a 2.30 intermediate result and this is shifted with saturation to 1.15 format. </dd></dl>
 221
 222 <p>Definition at line <a class="el" href="arm__mat__scale__q15_8c_source.html#l00063">63</a> of file <a class="el" href="arm__mat__scale__q15_8c_source.html">arm_mat_scale_q15.c</a>.</p>
 223
 224 </div>
 225 </div>
 226 </div>
 227 <!--- window showing the filter options -->
 228 <div id="MSearchSelectWindow"
 229      onmouseover="return searchBox.OnSearchSelectShow()"
 230      onmouseout="return searchBox.OnSearchSelectHide()"
 231      onkeydown="return searchBox.OnSearchSelectKey(event)">
 232 <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>
 233
 234 <!-- iframe showing the search results (closed by default) -->
 235 <div id="MSearchResultsWindow">
 236 <iframe src="" frameborder="0"
 237         name="MSearchResults" id="MSearchResults">
 238 </iframe>
 239 </div>
 240
 241 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:21 for CMSIS DSP Software Library by&#160;
 242 <a href="http://www.doxygen.org/index.html">
 243 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 244 </body>
 245 </html>