Added all the F4 libraries to the project
[fw/stlink] / exampleF4 / CMSIS / Documentation / DSP_Lib / html / arm__mat__scale__q15_8c_source.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: arm_mat_scale_q15.c Source File</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 class="current"><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 class="tabs2">
43     <ul class="tablist">
44       <li><a href="files.html"><span>File&#160;List</span></a></li>
45       <li><a href="globals.html"><span>Globals</span></a></li>
46     </ul>
47   </div>
48 <div class="header">
49   <div class="headertitle">
50 <h1>arm_mat_scale_q15.c</h1>  </div>
51 </div>
52 <div class="contents">
53 <a href="arm__mat__scale__q15_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* ----------------------------------------------------------------------   </span>
54 <a name="l00002"></a>00002 <span class="comment">* Copyright (C) 2010 ARM Limited. All rights reserved.   </span>
55 <a name="l00003"></a>00003 <span class="comment">*   </span>
56 <a name="l00004"></a>00004 <span class="comment">* $Date:        15. July 2011  </span>
57 <a name="l00005"></a>00005 <span class="comment">* $Revision:    V1.0.10  </span>
58 <a name="l00006"></a>00006 <span class="comment">*   </span>
59 <a name="l00007"></a>00007 <span class="comment">* Project:      CMSIS DSP Library   </span>
60 <a name="l00008"></a>00008 <span class="comment">* Title:        arm_mat_scale_q15.c   </span>
61 <a name="l00009"></a>00009 <span class="comment">*   </span>
62 <a name="l00010"></a>00010 <span class="comment">* Description:  Multiplies a Q15 matrix by a scalar.   </span>
63 <a name="l00011"></a>00011 <span class="comment">*   </span>
64 <a name="l00012"></a>00012 <span class="comment">* Target Processor: Cortex-M4/Cortex-M3/Cortex-M0</span>
65 <a name="l00013"></a>00013 <span class="comment">*  </span>
66 <a name="l00014"></a>00014 <span class="comment">* Version 1.0.10 2011/7/15 </span>
67 <a name="l00015"></a>00015 <span class="comment">*    Big Endian support added and Merged M0 and M3/M4 Source code.  </span>
68 <a name="l00016"></a>00016 <span class="comment">*   </span>
69 <a name="l00017"></a>00017 <span class="comment">* Version 1.0.3 2010/11/29  </span>
70 <a name="l00018"></a>00018 <span class="comment">*    Re-organized the CMSIS folders and updated documentation.   </span>
71 <a name="l00019"></a>00019 <span class="comment">*    </span>
72 <a name="l00020"></a>00020 <span class="comment">* Version 1.0.2 2010/11/11   </span>
73 <a name="l00021"></a>00021 <span class="comment">*    Documentation updated.    </span>
74 <a name="l00022"></a>00022 <span class="comment">*   </span>
75 <a name="l00023"></a>00023 <span class="comment">* Version 1.0.1 2010/10/05    </span>
76 <a name="l00024"></a>00024 <span class="comment">*    Production release and review comments incorporated.   </span>
77 <a name="l00025"></a>00025 <span class="comment">*   </span>
78 <a name="l00026"></a>00026 <span class="comment">* Version 1.0.0 2010/09/20    </span>
79 <a name="l00027"></a>00027 <span class="comment">*    Production release and review comments incorporated.   </span>
80 <a name="l00028"></a>00028 <span class="comment">*   </span>
81 <a name="l00029"></a>00029 <span class="comment">* Version 0.0.5  2010/04/26    </span>
82 <a name="l00030"></a>00030 <span class="comment">*    incorporated review comments and updated with latest CMSIS layer   </span>
83 <a name="l00031"></a>00031 <span class="comment">*   </span>
84 <a name="l00032"></a>00032 <span class="comment">* Version 0.0.3  2010/03/10    </span>
85 <a name="l00033"></a>00033 <span class="comment">*    Initial version   </span>
86 <a name="l00034"></a>00034 <span class="comment">* -------------------------------------------------------------------- */</span>
87 <a name="l00035"></a>00035 
88 <a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="arm__math_8h.html">arm_math.h</a>&quot;</span>
89 <a name="l00037"></a>00037 
90 <a name="l00063"></a><a class="code" href="group___matrix_scale.html#ga7521769e2cf1c3d9c4656138cd2ae2ca">00063</a> <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> <a class="code" href="group___matrix_scale.html#ga7521769e2cf1c3d9c4656138cd2ae2ca" title="Q15 matrix scaling.">arm_mat_scale_q15</a>(
91 <a name="l00064"></a>00064   <span class="keyword">const</span> <a class="code" href="structarm__matrix__instance__q15.html" title="Instance structure for the Q15 matrix structure.">arm_matrix_instance_q15</a> * pSrc,
92 <a name="l00065"></a>00065   <a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a> scaleFract,
93 <a name="l00066"></a>00066   int32_t shift,
94 <a name="l00067"></a>00067   <a class="code" href="structarm__matrix__instance__q15.html" title="Instance structure for the Q15 matrix structure.">arm_matrix_instance_q15</a> * pDst)
95 <a name="l00068"></a>00068 {
96 <a name="l00069"></a>00069   <a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a> *pIn = pSrc-&gt;<a class="code" href="structarm__matrix__instance__q15.html#a6da33a5553e634787d0f515cf8d724af">pData</a>;                      <span class="comment">/* input data matrix pointer */</span>
97 <a name="l00070"></a>00070   <a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a> *pOut = pDst-&gt;<a class="code" href="structarm__matrix__instance__q15.html#a6da33a5553e634787d0f515cf8d724af">pData</a>;                     <span class="comment">/* output data matrix pointer */</span>
98 <a name="l00071"></a>00071   uint32_t numSamples;                           <span class="comment">/* total number of elements in the matrix */</span>
99 <a name="l00072"></a>00072   int32_t totShift = 15 - shift;                 <span class="comment">/* total shift to apply after scaling */</span>
100 <a name="l00073"></a>00073   uint32_t blkCnt;                               <span class="comment">/* loop counters */</span>
101 <a name="l00074"></a>00074   <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> <a class="code" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>;                             <span class="comment">/* status of matrix scaling     */</span>
102 <a name="l00075"></a>00075 
103 <a name="l00076"></a>00076 <span class="preprocessor">#ifdef ARM_MATH_MATRIX_CHECK</span>
104 <a name="l00077"></a>00077 <span class="preprocessor"></span>
105 <a name="l00078"></a>00078 
106 <a name="l00079"></a>00079   <span class="comment">/* Check for matrix mismatch */</span>
107 <a name="l00080"></a>00080   <span class="keywordflow">if</span>((pSrc-&gt;<a class="code" href="structarm__matrix__instance__q15.html#a9bac6ed54be287c4d4f01a1a28be65f5">numRows</a> != pDst-&gt;<a class="code" href="structarm__matrix__instance__q15.html#a9bac6ed54be287c4d4f01a1a28be65f5">numRows</a>) || (pSrc-&gt;<a class="code" href="structarm__matrix__instance__q15.html#acbbce67ba058d8e1c867c71d57288c97">numCols</a> != pDst-&gt;<a class="code" href="structarm__matrix__instance__q15.html#acbbce67ba058d8e1c867c71d57288c97">numCols</a>))
108 <a name="l00081"></a>00081   {
109 <a name="l00082"></a>00082     <span class="comment">/* Set status as ARM_MATH_SIZE_MISMATCH */</span>
110 <a name="l00083"></a>00083     status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a7071b92f1f6bc3c5c312a237ea91105b">ARM_MATH_SIZE_MISMATCH</a>;
111 <a name="l00084"></a>00084   }
112 <a name="l00085"></a>00085   <span class="keywordflow">else</span>
113 <a name="l00086"></a>00086 <span class="preprocessor">#endif </span><span class="comment">/*    #ifdef ARM_MATH_MATRIX_CHECK    */</span>
114 <a name="l00087"></a>00087 
115 <a name="l00088"></a>00088   {
116 <a name="l00089"></a>00089     <span class="comment">/* Total number of samples in the input matrix */</span>
117 <a name="l00090"></a>00090     numSamples = (uint32_t) pSrc-&gt;<a class="code" href="structarm__matrix__instance__q15.html#a9bac6ed54be287c4d4f01a1a28be65f5">numRows</a> * pSrc-&gt;<a class="code" href="structarm__matrix__instance__q15.html#acbbce67ba058d8e1c867c71d57288c97">numCols</a>;
118 <a name="l00091"></a>00091 
119 <a name="l00092"></a>00092 #ifndef ARM_MATH_CM0
120 <a name="l00093"></a>00093 
121 <a name="l00094"></a>00094     <span class="comment">/* Run the below code for Cortex-M4 and Cortex-M3 */</span>
122 <a name="l00095"></a>00095     <span class="comment">/* Loop Unrolling */</span>
123 <a name="l00096"></a>00096     blkCnt = numSamples &gt;&gt; 2;
124 <a name="l00097"></a>00097 
125 <a name="l00098"></a>00098     <span class="comment">/* First part of the processing with loop unrolling.  Compute 4 outputs at a time.   </span>
126 <a name="l00099"></a>00099 <span class="comment">     ** a second loop below computes the remaining 1 to 3 samples. */</span>
127 <a name="l00100"></a>00100     <span class="keywordflow">while</span>(blkCnt &gt; 0u)
128 <a name="l00101"></a>00101     {
129 <a name="l00102"></a>00102       <span class="comment">/* C(m,n) = A(m,n) * k */</span>
130 <a name="l00103"></a>00103       <span class="comment">/* Scale, saturate and then store the results in the destination buffer. */</span>
131 <a name="l00104"></a>00104       *pOut++ =
132 <a name="l00105"></a>00105         (<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>) (__SSAT(((<a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a>) (*pIn++) * scaleFract) &gt;&gt; totShift, 16));
133 <a name="l00106"></a>00106       *pOut++ =
134 <a name="l00107"></a>00107         (<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>) (__SSAT(((<a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a>) (*pIn++) * scaleFract) &gt;&gt; totShift, 16));
135 <a name="l00108"></a>00108       *pOut++ =
136 <a name="l00109"></a>00109         (<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>) (__SSAT(((<a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a>) (*pIn++) * scaleFract) &gt;&gt; totShift, 16));
137 <a name="l00110"></a>00110       *pOut++ =
138 <a name="l00111"></a>00111         (<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>) (__SSAT(((<a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a>) (*pIn++) * scaleFract) &gt;&gt; totShift, 16));
139 <a name="l00112"></a>00112 
140 <a name="l00113"></a>00113       <span class="comment">/* Decrement the numSamples loop counter */</span>
141 <a name="l00114"></a>00114       blkCnt--;
142 <a name="l00115"></a>00115     }
143 <a name="l00116"></a>00116 
144 <a name="l00117"></a>00117     <span class="comment">/* If the numSamples is not a multiple of 4, compute any remaining output samples here.   </span>
145 <a name="l00118"></a>00118 <span class="comment">     ** No loop unrolling is used. */</span>
146 <a name="l00119"></a>00119     blkCnt = numSamples % 0x4u;
147 <a name="l00120"></a>00120 
148 <a name="l00121"></a>00121 <span class="preprocessor">#else</span>
149 <a name="l00122"></a>00122 <span class="preprocessor"></span>
150 <a name="l00123"></a>00123     <span class="comment">/* Run the below code for Cortex-M0 */</span>
151 <a name="l00124"></a>00124 
152 <a name="l00125"></a>00125     <span class="comment">/* Initialize blkCnt with number of samples */</span>
153 <a name="l00126"></a>00126     blkCnt = numSamples;
154 <a name="l00127"></a>00127 
155 <a name="l00128"></a>00128 <span class="preprocessor">#endif </span><span class="comment">/* #ifndef ARM_MATH_CM0 */</span>
156 <a name="l00129"></a>00129 
157 <a name="l00130"></a>00130     <span class="keywordflow">while</span>(blkCnt &gt; 0u)
158 <a name="l00131"></a>00131     {
159 <a name="l00132"></a>00132       <span class="comment">/* C(m,n) = A(m,n) * k */</span>
160 <a name="l00133"></a>00133       <span class="comment">/* Scale, saturate and then store the results in the destination buffer. */</span>
161 <a name="l00134"></a>00134       *pOut++ =
162 <a name="l00135"></a>00135         (<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>) (__SSAT(((<a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a>) (*pIn++) * scaleFract) &gt;&gt; totShift, 16));
163 <a name="l00136"></a>00136 
164 <a name="l00137"></a>00137       <span class="comment">/* Decrement the numSamples loop counter */</span>
165 <a name="l00138"></a>00138       blkCnt--;
166 <a name="l00139"></a>00139     }
167 <a name="l00140"></a>00140     <span class="comment">/* Set status as ARM_MATH_SUCCESS */</span>
168 <a name="l00141"></a>00141     status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>;
169 <a name="l00142"></a>00142   }
170 <a name="l00143"></a>00143 
171 <a name="l00144"></a>00144   <span class="comment">/* Return to application */</span>
172 <a name="l00145"></a>00145   <span class="keywordflow">return</span> (status);
173 <a name="l00146"></a>00146 }
174 <a name="l00147"></a>00147 
175 </pre></div></div>
176 </div>
177 <!--- window showing the filter options -->
178 <div id="MSearchSelectWindow"
179      onmouseover="return searchBox.OnSearchSelectShow()"
180      onmouseout="return searchBox.OnSearchSelectHide()"
181      onkeydown="return searchBox.OnSearchSelectKey(event)">
182 <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>
183
184 <!-- iframe showing the search results (closed by default) -->
185 <div id="MSearchResultsWindow">
186 <iframe src="" frameborder="0" 
187         name="MSearchResults" id="MSearchResults">
188 </iframe>
189 </div>
190
191 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:16 for CMSIS DSP Software Library by&#160;
192 <a href="http://www.doxygen.org/index.html">
193 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
194 </body>
195 </html>