Update documentation

pull/40/head
Silfurion 3 years ago
parent 4417982e8b
commit 34f661bdcd

@ -36,7 +36,7 @@
*/ */
/** /**
@addtogroup f64_to_x @addtogroup float_to_x
@{ @{
*/ */
@ -77,7 +77,7 @@ void arm_float_to_f64(
/** /**
@} end of f64_to_x group @} end of float_to_x group
*/ */

@ -51,7 +51,7 @@
@par Details @par Details
The equation used for the conversion process is: The equation used for the conversion process is:
<pre> <pre>
pDst[n] = (float32_t) pSrc[n] / 32768; 0 <= n < blockSize. pDst[n] = (float64_t) pSrc[n] / 32768; 0 <= n < blockSize.
</pre> </pre>
*/ */
@ -70,7 +70,7 @@ void arm_q15_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 32768 */ /* C = (float64_t) A / 32768 */
/* Convert from q15 to float and store result in destination buffer */ /* Convert from q15 to float and store result in destination buffer */
*pDst++ = ((float64_t) * pIn++ / 32768.0f); *pDst++ = ((float64_t) * pIn++ / 32768.0f);
@ -94,7 +94,7 @@ void arm_q15_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 32768 */ /* C = (float64_t) A / 32768 */
/* Convert from q15 to float and store result in destination buffer */ /* Convert from q15 to float and store result in destination buffer */
*pDst++ = ((float64_t) *pIn++ / 32768.0f); *pDst++ = ((float64_t) *pIn++ / 32768.0f);

@ -51,7 +51,7 @@
@par Details @par Details
The equation used for the conversion process is: The equation used for the conversion process is:
<pre> <pre>
pDst[n] = (float32_t) pSrc[n] / 2147483648; 0 <= n < blockSize. pDst[n] = (float64_t) pSrc[n] / 2147483648; 0 <= n < blockSize.
</pre> </pre>
*/ */
@ -70,7 +70,7 @@ void arm_q31_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 2147483648 */ /* C = (float64_t) A / 2147483648 */
/* Convert from q31 to float and store result in destination buffer */ /* Convert from q31 to float and store result in destination buffer */
*pDst++ = ((float64_t) *pIn++ / 2147483648.0f); *pDst++ = ((float64_t) *pIn++ / 2147483648.0f);
@ -94,7 +94,7 @@ void arm_q31_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 2147483648 */ /* C = (float64_t) A / 2147483648 */
/* Convert from q31 to float and store result in destination buffer */ /* Convert from q31 to float and store result in destination buffer */
*pDst++ = ((float64_t) *pIn++ / 2147483648.0f); *pDst++ = ((float64_t) *pIn++ / 2147483648.0f);

@ -51,7 +51,7 @@
@par Details @par Details
The equation used for the conversion process is: The equation used for the conversion process is:
<pre> <pre>
pDst[n] = (float32_t) pSrc[n] / 128; 0 <= n < blockSize. pDst[n] = (float64_t) pSrc[n] / 128; 0 <= n < blockSize.
</pre> </pre>
*/ */
void arm_q7_to_f64( void arm_q7_to_f64(
@ -69,7 +69,7 @@ void arm_q7_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 128 */ /* C = (float64_t) A / 128 */
/* Convert from q7 to float and store result in destination buffer */ /* Convert from q7 to float and store result in destination buffer */
*pDst++ = ((float64_t) * pIn++ / 128.0f); *pDst++ = ((float64_t) * pIn++ / 128.0f);
@ -93,7 +93,7 @@ void arm_q7_to_f64(
while (blkCnt > 0U) while (blkCnt > 0U)
{ {
/* C = (float32_t) A / 128 */ /* C = (float64_t) A / 128 */
/* Convert from q7 to float and store result in destination buffer */ /* Convert from q7 to float and store result in destination buffer */
*pDst++ = ((float64_t) * pIn++ / 128.0f); *pDst++ = ((float64_t) * pIn++ / 128.0f);

Loading…
Cancel
Save