|
|
/* ----------------------------------------------------------------------
|
|
|
* Copyright (C) 2010 ARM Limited. All rights reserved.
|
|
|
*
|
|
|
* $Date: 29. November 2010
|
|
|
* $Revision: V1.0.3
|
|
|
*
|
|
|
* Project: CMSIS DSP Library
|
|
|
* Title: arm_mat_scale_q31.c
|
|
|
*
|
|
|
* Description: Multiplies a Q31 matrix by a scalar.
|
|
|
*
|
|
|
* Target Processor: Cortex-M4/Cortex-M3
|
|
|
*
|
|
|
* Version 1.0.3 2010/11/29
|
|
|
* Re-organized the CMSIS folders and updated documentation.
|
|
|
*
|
|
|
* Version 1.0.2 2010/11/11
|
|
|
* Documentation updated.
|
|
|
*
|
|
|
* Version 1.0.1 2010/10/05
|
|
|
* Production release and review comments incorporated.
|
|
|
*
|
|
|
* Version 1.0.0 2010/09/20
|
|
|
* Production release and review comments incorporated.
|
|
|
*
|
|
|
* Version 0.0.5 2010/04/26
|
|
|
* incorporated review comments and updated with latest CMSIS layer
|
|
|
*
|
|
|
* Version 0.0.3 2010/03/10
|
|
|
* Initial version
|
|
|
* -------------------------------------------------------------------- */
|
|
|
|
|
|
#include "arm_math.h"
|
|
|
|
|
|
/**
|
|
|
* @ingroup groupMatrix
|
|
|
*/
|
|
|
|
|
|
/**
|
|
|
* @addtogroup MatrixScale
|
|
|
* @{
|
|
|
*/
|
|
|
|
|
|
/**
|
|
|
* @brief Q31 matrix scaling.
|
|
|
* @param[in] *pSrc points to input matrix
|
|
|
* @param[in] scaleFract fractional portion of the scale factor
|
|
|
* @param[in] shift number of bits to shift the result by
|
|
|
* @param[out] *pDst points to output matrix structure
|
|
|
* @return The function returns either
|
|
|
* <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.
|
|
|
*
|
|
|
* @details
|
|
|
* <b>Scaling and Overflow Behavior:</b>
|
|
|
* \par
|
|
|
* The input data <code>*pSrc</code> and <code>scaleFract</code> are in 1.31 format.
|
|
|
* These are multiplied to yield a 2.62 intermediate result and this is shifted with saturation to 1.31 format.
|
|
|
*/
|
|
|
|
|
|
arm_status arm_mat_scale_q31(
|
|
|
const arm_matrix_instance_q31 * pSrc,
|
|
|
q31_t scaleFract,
|
|
|
int32_t shift,
|
|
|
arm_matrix_instance_q31 * pDst)
|
|
|
{
|
|
|
q31_t *pIn = pSrc->pData; /* input data matrix pointer */
|
|
|
q31_t *pOut = pDst->pData; /* output data matrix pointer */
|
|
|
q63_t out; /* temporary variable to hold output value */
|
|
|
uint32_t numSamples; /* total number of elements in the matrix */
|
|
|
int32_t totShift = 31 - shift; /* shift to apply after scaling */
|
|
|
uint32_t blkCnt; /* loop counters */
|
|
|
arm_status status; /* status of matrix scaling */
|
|
|
|
|
|
#ifdef ARM_MATH_MATRIX_CHECK
|
|
|
/* Check for matrix mismatch */
|
|
|
if((pSrc->numRows != pDst->numRows) || (pSrc->numCols != pDst->numCols))
|
|
|
{
|
|
|
/* Set status as ARM_MATH_SIZE_MISMATCH */
|
|
|
status = ARM_MATH_SIZE_MISMATCH;
|
|
|
}
|
|
|
else
|
|
|
#endif
|
|
|
{
|
|
|
/* Total number of samples in the input matrix */
|
|
|
numSamples = (uint32_t) pSrc->numRows * pSrc->numCols;
|
|
|
|
|
|
/* Loop Unrolling */
|
|
|
blkCnt = numSamples >> 2u;
|
|
|
|
|
|
/* First part of the processing with loop unrolling. Compute 4 outputs at a time.
|
|
|
** a second loop below computes the remaining 1 to 3 samples. */
|
|
|
while(blkCnt > 0u)
|
|
|
{
|
|
|
/* C(m,n) = A(m,n) * k */
|
|
|
/* Scale, saturate and then store the results in the destination buffer. */
|
|
|
out = ((q63_t) * pIn++ * scaleFract) >> totShift;
|
|
|
*pOut++ = clip_q63_to_q31(out);
|
|
|
out = ((q63_t) * pIn++ * scaleFract) >> totShift;
|
|
|
*pOut++ = clip_q63_to_q31(out);
|
|
|
out = ((q63_t) * pIn++ * scaleFract) >> totShift;
|
|
|
*pOut++ = clip_q63_to_q31(out);
|
|
|
out = ((q63_t) * pIn++ * scaleFract) >> totShift;
|
|
|
*pOut++ = clip_q63_to_q31(out);
|
|
|
|
|
|
/* Decrement the numSamples loop counter */
|
|
|
blkCnt--;
|
|
|
}
|
|
|
|
|
|
/* If the numSamples is not a multiple of 4, compute any remaining output samples here.
|
|
|
** No loop unrolling is used. */
|
|
|
blkCnt = numSamples % 0x4u;
|
|
|
|
|
|
while(blkCnt > 0u)
|
|
|
{
|
|
|
/* C(m,n) = A(m,n) * k */
|
|
|
/* Scale, saturate and then store the results in the destination buffer. */
|
|
|
out = ((q63_t) * pIn++ * scaleFract) >> totShift;
|
|
|
*pOut++ = clip_q63_to_q31(out);
|
|
|
|
|
|
/* Decrement the numSamples loop counter */
|
|
|
blkCnt--;
|
|
|
}
|
|
|
|
|
|
/* Set status as ARM_MATH_SUCCESS */
|
|
|
status = ARM_MATH_SUCCESS;
|
|
|
}
|
|
|
|
|
|
/* Return to application */
|
|
|
return (status);
|
|
|
}
|
|
|
|
|
|
/**
|
|
|
* @} end of MatrixScale group
|
|
|
*/
|
|
|
|
