diff options
Diffstat (limited to 'Drivers/CMSIS/docs/DSP/html/group__clarke.html')
| -rw-r--r-- | Drivers/CMSIS/docs/DSP/html/group__clarke.html | 33 |
1 files changed, 16 insertions, 17 deletions
diff --git a/Drivers/CMSIS/docs/DSP/html/group__clarke.html b/Drivers/CMSIS/docs/DSP/html/group__clarke.html index 75c2cbf5a..edb1f942e 100644 --- a/Drivers/CMSIS/docs/DSP/html/group__clarke.html +++ b/Drivers/CMSIS/docs/DSP/html/group__clarke.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-DSP -  <span id="projectnumber">Version 1.5.2</span> +  <span id="projectnumber">Version 1.7.0</span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> @@ -116,12 +116,12 @@ $(document).ready(function(){initNavTree('group__clarke.html','');}); <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> -<tr class="memitem:gabbfa27c68837d22f03d6c6259569caa8"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#gabbfa27c68837d22f03d6c6259569caa8">arm_clarke_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ia, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ib, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIbeta)</td></tr> -<tr class="memdesc:gabbfa27c68837d22f03d6c6259569caa8"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Clarke transform. <a href="#gabbfa27c68837d22f03d6c6259569caa8">More...</a><br/></td></tr> -<tr class="separator:gabbfa27c68837d22f03d6c6259569caa8"><td class="memSeparator" colspan="2"> </td></tr> -<tr class="memitem:ga0c69ebd2855ce6d34008eff808881e78"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#ga0c69ebd2855ce6d34008eff808881e78">arm_clarke_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ia, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ib, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIbeta)</td></tr> -<tr class="memdesc:ga0c69ebd2855ce6d34008eff808881e78"><td class="mdescLeft"> </td><td class="mdescRight">Clarke transform for Q31 version. <a href="#ga0c69ebd2855ce6d34008eff808881e78">More...</a><br/></td></tr> -<tr class="separator:ga0c69ebd2855ce6d34008eff808881e78"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga82d40c62bb48ef4d613f1f2f685b4084"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#ga82d40c62bb48ef4d613f1f2f685b4084">arm_clarke_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ia, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ib, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIbeta)</td></tr> +<tr class="memdesc:ga82d40c62bb48ef4d613f1f2f685b4084"><td class="mdescLeft"> </td><td class="mdescRight">Floating-point Clarke transform. <a href="#ga82d40c62bb48ef4d613f1f2f685b4084">More...</a><br/></td></tr> +<tr class="separator:ga82d40c62bb48ef4d613f1f2f685b4084"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8d68db2a6e26e1caab677f5ab293c068"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__clarke.html#ga8d68db2a6e26e1caab677f5ab293c068">arm_clarke_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ia, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ib, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIalpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIbeta)</td></tr> +<tr class="memdesc:ga8d68db2a6e26e1caab677f5ab293c068"><td class="mdescLeft"> </td><td class="mdescRight">Clarke transform for Q31 version. <a href="#ga8d68db2a6e26e1caab677f5ab293c068">More...</a><br/></td></tr> +<tr class="separator:ga8d68db2a6e26e1caab677f5ab293c068"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Description</h2> <p>Forward Clarke transform converts the instantaneous stator phases into a two-coordinate time invariant vector. Generally the Clarke transform uses three-phase currents <code>Ia, Ib and Ic</code> to calculate currents in the two-phase orthogonal stator axis <code>Ialpha</code> and <code>Ibeta</code>. When <code>Ialpha</code> is superposed with <code>Ia</code> as shown in the figure below </p> @@ -137,12 +137,12 @@ Stator current space vector and its components in (a,b).</div></div> where <code>Ia</code> and <code>Ib</code> are the instantaneous stator phases and <code>pIalpha</code> and <code>pIbeta</code> are the two coordinates of time invariant vector. </dd></dl> <dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the Q31 version of the Clarke transform. In particular, the overflow and saturation behavior of the accumulator used must be considered. Refer to the function specific documentation below for usage guidelines. </dd></dl> <h2 class="groupheader">Function Documentation</h2> -<a class="anchor" id="gabbfa27c68837d22f03d6c6259569caa8"></a> +<a class="anchor" id="ga82d40c62bb48ef4d613f1f2f685b4084"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_clarke_f32 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_clarke_f32 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> </td> <td class="paramname"><em>Ia</em>, </td> @@ -181,15 +181,16 @@ Stator current space vector and its components in (a,b).</div></div> </table> </dd> </dl> +<dl class="section return"><dt>Returns</dt><dd>none </dd></dl> </div> </div> -<a class="anchor" id="ga0c69ebd2855ce6d34008eff808881e78"></a> +<a class="anchor" id="ga8d68db2a6e26e1caab677f5ab293c068"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> - <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_clarke_q31 </td> + <td class="memname">__STATIC_FORCEINLINE void arm_clarke_q31 </td> <td>(</td> <td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> </td> <td class="paramname"><em>Ia</em>, </td> @@ -224,14 +225,12 @@ Stator current space vector and its components in (a,b).</div></div> <tr><td class="paramdir">[in]</td><td class="paramname">Ia</td><td>input three-phase coordinate <code>a</code> </td></tr> <tr><td class="paramdir">[in]</td><td class="paramname">Ib</td><td>input three-phase coordinate <code>b</code> </td></tr> <tr><td class="paramdir">[out]</td><td class="paramname">pIalpha</td><td>points to output two-phase orthogonal vector axis alpha </td></tr> - <tr><td class="paramdir">[out]</td><td class="paramname">pIbeta</td><td>points to output two-phase orthogonal vector axis beta</td></tr> + <tr><td class="paramdir">[out]</td><td class="paramname">pIbeta</td><td>points to output two-phase orthogonal vector axis beta </td></tr> </table> </dd> </dl> -<p><b>Scaling and Overflow Behavior:</b> </p> -<dl class="section user"><dt></dt><dd>The function is implemented using an internal 32-bit accumulator. The accumulator maintains 1.31 format by truncating lower 31 bits of the intermediate multiplication in 2.62 format. There is saturation on the addition, hence there is no risk of overflow. </dd></dl> - -<p>References <a class="el" href="arm__math_8h.html#ab9f3cfbfb0f12975ab91ddb179160dcb">__QADD()</a>.</p> +<dl class="section return"><dt>Returns</dt><dd>none</dd></dl> +<dl class="section user"><dt>Scaling and Overflow Behavior</dt><dd>The function is implemented using an internal 32-bit accumulator. The accumulator maintains 1.31 format by truncating lower 31 bits of the intermediate multiplication in 2.62 format. There is saturation on the addition, hence there is no risk of overflow. </dd></dl> </div> </div> @@ -240,7 +239,7 @@ Stator current space vector and its components in (a,b).</div></div> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:21 for CMSIS-DSP by Arm Ltd. All rights reserved. + <li class="footer">Generated on Wed Jul 10 2019 15:20:39 for CMSIS-DSP Version 1.7.0 by Arm Ltd. All rights reserved. <!-- <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 |