summaryrefslogtreecommitdiff
path: root/docs/DSP/html/group__park.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/DSP/html/group__park.html')
-rw-r--r--docs/DSP/html/group__park.html36
1 files changed, 18 insertions, 18 deletions
diff --git a/docs/DSP/html/group__park.html b/docs/DSP/html/group__park.html
index e8330b5..a2b6a48 100644
--- a/docs/DSP/html/group__park.html
+++ b/docs/DSP/html/group__park.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
- &#160;<span id="projectnumber">Version 1.5.2</span>
+ &#160;<span id="projectnumber">Version 1.7.0</span>
</div>
<div id="projectbrief">CMSIS DSP Software Library</div>
</td>
@@ -116,14 +116,15 @@ $(document).ready(function(){initNavTree('group__park.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:gae24bf07174d3b8dddcf30d8c8d8e7fbb"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__park.html#gae24bf07174d3b8dddcf30d8c8d8e7fbb">arm_park_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ialpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ibeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pId, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIq, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> sinVal, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> cosVal)</td></tr>
-<tr class="memdesc:gae24bf07174d3b8dddcf30d8c8d8e7fbb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point Park transform. <a href="#gae24bf07174d3b8dddcf30d8c8d8e7fbb">More...</a><br/></td></tr>
-<tr class="separator:gae24bf07174d3b8dddcf30d8c8d8e7fbb"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga5630ed3715091f2795ee10df34672523"><td class="memItemLeft" align="right" valign="top">CMSIS_INLINE __STATIC_INLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__park.html#ga5630ed3715091f2795ee10df34672523">arm_park_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ialpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ibeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pId, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIq, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> sinVal, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> cosVal)</td></tr>
-<tr class="memdesc:ga5630ed3715091f2795ee10df34672523"><td class="mdescLeft">&#160;</td><td class="mdescRight">Park transform for Q31 version. <a href="#ga5630ed3715091f2795ee10df34672523">More...</a><br/></td></tr>
-<tr class="separator:ga5630ed3715091f2795ee10df34672523"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga18f92d09e080edc98a00c01886b56b5d"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__park.html#ga18f92d09e080edc98a00c01886b56b5d">arm_park_f32</a> (<a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ialpha, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> Ibeta, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pId, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> *pIq, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> sinVal, <a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a> cosVal)</td></tr>
+<tr class="memdesc:ga18f92d09e080edc98a00c01886b56b5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Floating-point Park transform. <a href="#ga18f92d09e080edc98a00c01886b56b5d">More...</a><br/></td></tr>
+<tr class="separator:ga18f92d09e080edc98a00c01886b56b5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga69be76685149b18f345f705aa8efaad0"><td class="memItemLeft" align="right" valign="top">__STATIC_FORCEINLINE void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__park.html#ga69be76685149b18f345f705aa8efaad0">arm_park_q31</a> (<a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ialpha, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> Ibeta, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pId, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> *pIq, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> sinVal, <a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a> cosVal)</td></tr>
+<tr class="memdesc:ga69be76685149b18f345f705aa8efaad0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Park transform for Q31 version. <a href="#ga69be76685149b18f345f705aa8efaad0">More...</a><br/></td></tr>
+<tr class="separator:ga69be76685149b18f345f705aa8efaad0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
+<p>end of inv_clarke group</p>
<p>Forward Park transform converts the input two-coordinate vector to flux and torque components. The Park transform can be used to realize the transformation of the <code>Ialpha</code> and the <code>Ibeta</code> currents from the stationary to the moving reference frame and control the spatial relationship between the stator vector current and rotor flux vector. If we consider the d axis aligned with the rotor flux, the diagram below shows the current vector and the relationship from the two reference frames: </p>
<div class="image">
<img src="park.gif" alt="park.gif"/>
@@ -136,12 +137,12 @@ Stator current space vector and its component in (a,b) and in the d,q rotating r
where <code>Ialpha</code> and <code>Ibeta</code> are the stator vector components, <code>pId</code> and <code>pIq</code> are rotor vector components and <code>cosVal</code> and <code>sinVal</code> are the cosine and sine values of theta (rotor flux position). </dd></dl>
<dl class="section user"><dt>Fixed-Point Behavior</dt><dd>Care must be taken when using the Q31 version of the Park 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="gae24bf07174d3b8dddcf30d8c8d8e7fbb"></a>
+<a class="anchor" id="ga18f92d09e080edc98a00c01886b56b5d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_park_f32 </td>
+ <td class="memname">__STATIC_FORCEINLINE void arm_park_f32 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="arm__math_8h.html#a4611b605e45ab401f02cab15c5e38715">float32_t</a>&#160;</td>
<td class="paramname"><em>Ialpha</em>, </td>
@@ -190,20 +191,21 @@ Stator current space vector and its component in (a,b) and in the d,q rotating r
<tr><td class="paramdir">[out]</td><td class="paramname">pId</td><td>points to output rotor reference frame d </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pIq</td><td>points to output rotor reference frame q </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sinVal</td><td>sine value of rotation angle theta </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta</td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta </td></tr>
</table>
</dd>
</dl>
+<dl class="section return"><dt>Returns</dt><dd>none</dd></dl>
<p>The function implements the forward Park transform. </p>
</div>
</div>
-<a class="anchor" id="ga5630ed3715091f2795ee10df34672523"></a>
+<a class="anchor" id="ga69be76685149b18f345f705aa8efaad0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
- <td class="memname">CMSIS_INLINE __STATIC_INLINE void arm_park_q31 </td>
+ <td class="memname">__STATIC_FORCEINLINE void arm_park_q31 </td>
<td>(</td>
<td class="paramtype"><a class="el" href="arm__math_8h.html#adc89a3547f5324b7b3b95adec3806bc0">q31_t</a>&#160;</td>
<td class="paramname"><em>Ialpha</em>, </td>
@@ -252,14 +254,12 @@ Stator current space vector and its component in (a,b) and in the d,q rotating r
<tr><td class="paramdir">[out]</td><td class="paramname">pId</td><td>points to output rotor reference frame d </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">pIq</td><td>points to output rotor reference frame q </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">sinVal</td><td>sine value of rotation angle theta </td></tr>
- <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta</td></tr>
+ <tr><td class="paramdir">[in]</td><td class="paramname">cosVal</td><td>cosine value of rotation angle theta </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 and subtraction, hence there is no risk of overflow. </dd></dl>
-
-<p>References <a class="el" href="arm__math_8h.html#ab9f3cfbfb0f12975ab91ddb179160dcb">__QADD()</a>, and <a class="el" href="arm__math_8h.html#a15e896d0146c280e600d00f609832350">__QSUB()</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 and subtraction, hence there is no risk of overflow. </dd></dl>
</div>
</div>
@@ -268,7 +268,7 @@ Stator current space vector and its component in (a,b) and in the d,q rotating r
<!-- 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