blob: 887007ed6d67c3d08eb9a9f4046fa58a0f359cbc [file] [log] [blame]
<!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"/>
<title>CMSIS DSP Software Library: arm_mat_scale_q31.c Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javaScript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.2 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>arm_mat_scale_q31.c</h1> </div>
</div>
<div class="contents">
<a href="arm__mat__scale__q31_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>
<a name="l00002"></a>00002 <span class="comment">* Copyright (C) 2010 ARM Limited. All rights reserved. </span>
<a name="l00003"></a>00003 <span class="comment">* </span>
<a name="l00004"></a>00004 <span class="comment">* $Date: 15. July 2011 </span>
<a name="l00005"></a>00005 <span class="comment">* $Revision: V1.0.10 </span>
<a name="l00006"></a>00006 <span class="comment">* </span>
<a name="l00007"></a>00007 <span class="comment">* Project: CMSIS DSP Library </span>
<a name="l00008"></a>00008 <span class="comment">* Title: arm_mat_scale_q31.c </span>
<a name="l00009"></a>00009 <span class="comment">* </span>
<a name="l00010"></a>00010 <span class="comment">* Description: Multiplies a Q31 matrix by a scalar. </span>
<a name="l00011"></a>00011 <span class="comment">* </span>
<a name="l00012"></a>00012 <span class="comment">* Target Processor: Cortex-M4/Cortex-M3/Cortex-M0</span>
<a name="l00013"></a>00013 <span class="comment">* </span>
<a name="l00014"></a>00014 <span class="comment">* Version 1.0.10 2011/7/15 </span>
<a name="l00015"></a>00015 <span class="comment">* Big Endian support added and Merged M0 and M3/M4 Source code. </span>
<a name="l00016"></a>00016 <span class="comment">* </span>
<a name="l00017"></a>00017 <span class="comment">* Version 1.0.3 2010/11/29 </span>
<a name="l00018"></a>00018 <span class="comment">* Re-organized the CMSIS folders and updated documentation. </span>
<a name="l00019"></a>00019 <span class="comment">* </span>
<a name="l00020"></a>00020 <span class="comment">* Version 1.0.2 2010/11/11 </span>
<a name="l00021"></a>00021 <span class="comment">* Documentation updated. </span>
<a name="l00022"></a>00022 <span class="comment">* </span>
<a name="l00023"></a>00023 <span class="comment">* Version 1.0.1 2010/10/05 </span>
<a name="l00024"></a>00024 <span class="comment">* Production release and review comments incorporated. </span>
<a name="l00025"></a>00025 <span class="comment">* </span>
<a name="l00026"></a>00026 <span class="comment">* Version 1.0.0 2010/09/20 </span>
<a name="l00027"></a>00027 <span class="comment">* Production release and review comments incorporated. </span>
<a name="l00028"></a>00028 <span class="comment">* </span>
<a name="l00029"></a>00029 <span class="comment">* Version 0.0.5 2010/04/26 </span>
<a name="l00030"></a>00030 <span class="comment">* incorporated review comments and updated with latest CMSIS layer </span>
<a name="l00031"></a>00031 <span class="comment">* </span>
<a name="l00032"></a>00032 <span class="comment">* Version 0.0.3 2010/03/10 </span>
<a name="l00033"></a>00033 <span class="comment">* Initial version </span>
<a name="l00034"></a>00034 <span class="comment">* -------------------------------------------------------------------- */</span>
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="preprocessor">#include &quot;<a class="code" href="arm__math_8h.html">arm_math.h</a>&quot;</span>
<a name="l00037"></a>00037
<a name="l00063"></a><a class="code" href="group___matrix_scale.html#ga609743821ee81fa8c34c4bcdc1ed9744">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#ga609743821ee81fa8c34c4bcdc1ed9744" title="Q31 matrix scaling.">arm_mat_scale_q31</a>(
<a name="l00064"></a>00064 <span class="keyword">const</span> <a class="code" href="structarm__matrix__instance__q31.html" title="Instance structure for the Q31 matrix structure.">arm_matrix_instance_q31</a> * pSrc,
<a name="l00065"></a>00065 <a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a> scaleFract,
<a name="l00066"></a>00066 int32_t shift,
<a name="l00067"></a>00067 <a class="code" href="structarm__matrix__instance__q31.html" title="Instance structure for the Q31 matrix structure.">arm_matrix_instance_q31</a> * pDst)
<a name="l00068"></a>00068 {
<a name="l00069"></a>00069 <a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a> *pIn = pSrc-&gt;<a class="code" href="structarm__matrix__instance__q31.html#a09a64267c0579fef086efc9059741e56">pData</a>; <span class="comment">/* input data matrix pointer */</span>
<a name="l00070"></a>00070 <a class="code" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0" title="32-bit fractional data type in 1.31 format.">q31_t</a> *pOut = pDst-&gt;<a class="code" href="structarm__matrix__instance__q31.html#a09a64267c0579fef086efc9059741e56">pData</a>; <span class="comment">/* output data matrix pointer */</span>
<a name="l00071"></a>00071 <a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a> out; <span class="comment">/* temporary variable to hold output value */</span>
<a name="l00072"></a>00072 uint32_t numSamples; <span class="comment">/* total number of elements in the matrix */</span>
<a name="l00073"></a>00073 int32_t totShift = 31 - shift; <span class="comment">/* shift to apply after scaling */</span>
<a name="l00074"></a>00074 uint32_t blkCnt; <span class="comment">/* loop counters */</span>
<a name="l00075"></a>00075 <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>
<a name="l00076"></a>00076
<a name="l00077"></a>00077 <span class="preprocessor">#ifdef ARM_MATH_MATRIX_CHECK</span>
<a name="l00078"></a>00078 <span class="preprocessor"></span>
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">/* Check for matrix mismatch */</span>
<a name="l00081"></a>00081 <span class="keywordflow">if</span>((pSrc-&gt;<a class="code" href="structarm__matrix__instance__q31.html#a63bacac158a821c8cfc06088d251598c">numRows</a> != pDst-&gt;<a class="code" href="structarm__matrix__instance__q31.html#a63bacac158a821c8cfc06088d251598c">numRows</a>) || (pSrc-&gt;<a class="code" href="structarm__matrix__instance__q31.html#abd161da7614eda927157f18b698074b1">numCols</a> != pDst-&gt;<a class="code" href="structarm__matrix__instance__q31.html#abd161da7614eda927157f18b698074b1">numCols</a>))
<a name="l00082"></a>00082 {
<a name="l00083"></a>00083 <span class="comment">/* Set status as ARM_MATH_SIZE_MISMATCH */</span>
<a name="l00084"></a>00084 status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a7071b92f1f6bc3c5c312a237ea91105b">ARM_MATH_SIZE_MISMATCH</a>;
<a name="l00085"></a>00085 }
<a name="l00086"></a>00086 <span class="keywordflow">else</span>
<a name="l00087"></a>00087 <span class="preprocessor">#endif </span><span class="comment">/* #ifdef ARM_MATH_MATRIX_CHECK */</span>
<a name="l00088"></a>00088
<a name="l00089"></a>00089 {
<a name="l00090"></a>00090 <span class="comment">/* Total number of samples in the input matrix */</span>
<a name="l00091"></a>00091 numSamples = (uint32_t) pSrc-&gt;<a class="code" href="structarm__matrix__instance__q31.html#a63bacac158a821c8cfc06088d251598c">numRows</a> * pSrc-&gt;<a class="code" href="structarm__matrix__instance__q31.html#abd161da7614eda927157f18b698074b1">numCols</a>;
<a name="l00092"></a>00092
<a name="l00093"></a>00093 #ifndef ARM_MATH_CM0
<a name="l00094"></a>00094
<a name="l00095"></a>00095 <span class="comment">/* Run the below code for Cortex-M4 and Cortex-M3 */</span>
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="comment">/* Loop Unrolling */</span>
<a name="l00098"></a>00098 blkCnt = numSamples &gt;&gt; 2u;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">/* First part of the processing with loop unrolling. Compute 4 outputs at a time. </span>
<a name="l00101"></a>00101 <span class="comment"> ** a second loop below computes the remaining 1 to 3 samples. */</span>
<a name="l00102"></a>00102 <span class="keywordflow">while</span>(blkCnt &gt; 0u)
<a name="l00103"></a>00103 {
<a name="l00104"></a>00104 <span class="comment">/* C(m,n) = A(m,n) * k */</span>
<a name="l00105"></a>00105 <span class="comment">/* Scale, saturate and then store the results in the destination buffer. */</span>
<a name="l00106"></a>00106 out = ((<a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a>) * pIn++ * scaleFract) &gt;&gt; totShift;
<a name="l00107"></a>00107 *pOut++ = <a class="code" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c" title="Clips Q63 to Q31 values.">clip_q63_to_q31</a>(out);
<a name="l00108"></a>00108 out = ((<a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a>) * pIn++ * scaleFract) &gt;&gt; totShift;
<a name="l00109"></a>00109 *pOut++ = <a class="code" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c" title="Clips Q63 to Q31 values.">clip_q63_to_q31</a>(out);
<a name="l00110"></a>00110 out = ((<a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a>) * pIn++ * scaleFract) &gt;&gt; totShift;
<a name="l00111"></a>00111 *pOut++ = <a class="code" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c" title="Clips Q63 to Q31 values.">clip_q63_to_q31</a>(out);
<a name="l00112"></a>00112 out = ((<a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a>) * pIn++ * scaleFract) &gt;&gt; totShift;
<a name="l00113"></a>00113 *pOut++ = <a class="code" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c" title="Clips Q63 to Q31 values.">clip_q63_to_q31</a>(out);
<a name="l00114"></a>00114
<a name="l00115"></a>00115 <span class="comment">/* Decrement the numSamples loop counter */</span>
<a name="l00116"></a>00116 blkCnt--;
<a name="l00117"></a>00117 }
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">/* If the numSamples is not a multiple of 4, compute any remaining output samples here. </span>
<a name="l00120"></a>00120 <span class="comment"> ** No loop unrolling is used. */</span>
<a name="l00121"></a>00121 blkCnt = numSamples % 0x4u;
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="preprocessor">#else</span>
<a name="l00124"></a>00124 <span class="preprocessor"></span>
<a name="l00125"></a>00125 <span class="comment">/* Run the below code for Cortex-M0 */</span>
<a name="l00126"></a>00126
<a name="l00127"></a>00127 <span class="comment">/* Initialize blkCnt with number of samples */</span>
<a name="l00128"></a>00128 blkCnt = numSamples;
<a name="l00129"></a>00129
<a name="l00130"></a>00130 <span class="preprocessor">#endif </span><span class="comment">/* #ifndef ARM_MATH_CM0 */</span>
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keywordflow">while</span>(blkCnt &gt; 0u)
<a name="l00133"></a>00133 {
<a name="l00134"></a>00134 <span class="comment">/* C(m,n) = A(m,n) * k */</span>
<a name="l00135"></a>00135 <span class="comment">/* Scale, saturate and then store the results in the destination buffer. */</span>
<a name="l00136"></a>00136 out = ((<a class="code" href="arm__math_8h.html#a5aea1cb12fc02d9d44c8abf217eaa5c6" title="64-bit fractional data type in 1.63 format.">q63_t</a>) * pIn++ * scaleFract) &gt;&gt; totShift;
<a name="l00137"></a>00137 *pOut++ = <a class="code" href="arm__math_8h.html#ad7373e53d3c2e1adfeafc8c2e9720b5c" title="Clips Q63 to Q31 values.">clip_q63_to_q31</a>(out);
<a name="l00138"></a>00138
<a name="l00139"></a>00139 <span class="comment">/* Decrement the numSamples loop counter */</span>
<a name="l00140"></a>00140 blkCnt--;
<a name="l00141"></a>00141 }
<a name="l00142"></a>00142 <span class="comment">/* Set status as ARM_MATH_SUCCESS */</span>
<a name="l00143"></a>00143 status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>;
<a name="l00144"></a>00144 }
<a name="l00145"></a>00145
<a name="l00146"></a>00146 <span class="comment">/* Return to application */</span>
<a name="l00147"></a>00147 <span class="keywordflow">return</span> (status);
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149
</pre></div></div>
</div>
<!--- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<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>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:16 for CMSIS DSP Software Library by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
</body>
</html>