Joep D / CMSIS_DSP_5

The CMSIS DSP 5 library

Dependents:   Nucleo-Heart-Rate ejercicioVrms2 PROYECTOFINAL ejercicioVrms ... more

functions/MatrixFunctions/arm_mat_sub_q31.c@1:24714b45cd1b, 2018-06-20 (annotated)

Committer:
xorjoep
Date:
Wed Jun 20 11:21:31 2018 +0000
Revision:
1:24714b45cd1b
The newest version of the CMSIS library

Who changed what in which revision?

UserRevisionLine numberNew contents of line
xorjoep 1:24714b45cd1b 1 /* ----------------------------------------------------------------------
xorjoep 1:24714b45cd1b 2 * Project: CMSIS DSP Library
xorjoep 1:24714b45cd1b 3 * Title: arm_mat_sub_q31.c
xorjoep 1:24714b45cd1b 4 * Description: Q31 matrix subtraction
xorjoep 1:24714b45cd1b 5 *
xorjoep 1:24714b45cd1b 6 * $Date: 27. January 2017
xorjoep 1:24714b45cd1b 7 * $Revision: V.1.5.1
xorjoep 1:24714b45cd1b 8 *
xorjoep 1:24714b45cd1b 9 * Target Processor: Cortex-M cores
xorjoep 1:24714b45cd1b 10 * -------------------------------------------------------------------- */
xorjoep 1:24714b45cd1b 11 /*
xorjoep 1:24714b45cd1b 12 * Copyright (C) 2010-2017 ARM Limited or its affiliates. All rights reserved.
xorjoep 1:24714b45cd1b 13 *
xorjoep 1:24714b45cd1b 14 * SPDX-License-Identifier: Apache-2.0
xorjoep 1:24714b45cd1b 15 *
xorjoep 1:24714b45cd1b 16 * Licensed under the Apache License, Version 2.0 (the License); you may
xorjoep 1:24714b45cd1b 17 * not use this file except in compliance with the License.
xorjoep 1:24714b45cd1b 18 * You may obtain a copy of the License at
xorjoep 1:24714b45cd1b 19 *
xorjoep 1:24714b45cd1b 20 * www.apache.org/licenses/LICENSE-2.0
xorjoep 1:24714b45cd1b 21 *
xorjoep 1:24714b45cd1b 22 * Unless required by applicable law or agreed to in writing, software
xorjoep 1:24714b45cd1b 23 * distributed under the License is distributed on an AS IS BASIS, WITHOUT
xorjoep 1:24714b45cd1b 24 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
xorjoep 1:24714b45cd1b 25 * See the License for the specific language governing permissions and
xorjoep 1:24714b45cd1b 26 * limitations under the License.
xorjoep 1:24714b45cd1b 27 */
xorjoep 1:24714b45cd1b 28
xorjoep 1:24714b45cd1b 29 #include "arm_math.h"
xorjoep 1:24714b45cd1b 30
xorjoep 1:24714b45cd1b 31 /**
xorjoep 1:24714b45cd1b 32 * @ingroup groupMatrix
xorjoep 1:24714b45cd1b 33 */
xorjoep 1:24714b45cd1b 34
xorjoep 1:24714b45cd1b 35 /**
xorjoep 1:24714b45cd1b 36 * @addtogroup MatrixSub
xorjoep 1:24714b45cd1b 37 * @{
xorjoep 1:24714b45cd1b 38 */
xorjoep 1:24714b45cd1b 39
xorjoep 1:24714b45cd1b 40 /**
xorjoep 1:24714b45cd1b 41 * @brief Q31 matrix subtraction.
xorjoep 1:24714b45cd1b 42 * @param[in] *pSrcA points to the first input matrix structure
xorjoep 1:24714b45cd1b 43 * @param[in] *pSrcB points to the second input matrix structure
xorjoep 1:24714b45cd1b 44 * @param[out] *pDst points to output matrix structure
xorjoep 1:24714b45cd1b 45 * @return The function returns either
xorjoep 1:24714b45cd1b 46 * <code>ARM_MATH_SIZE_MISMATCH</code> or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.
xorjoep 1:24714b45cd1b 47 *
xorjoep 1:24714b45cd1b 48 * <b>Scaling and Overflow Behavior:</b>
xorjoep 1:24714b45cd1b 49 * \par
xorjoep 1:24714b45cd1b 50 * The function uses saturating arithmetic.
xorjoep 1:24714b45cd1b 51 * Results outside of the allowable Q31 range [0x80000000 0x7FFFFFFF] will be saturated.
xorjoep 1:24714b45cd1b 52 */
xorjoep 1:24714b45cd1b 53
xorjoep 1:24714b45cd1b 54
xorjoep 1:24714b45cd1b 55 arm_status arm_mat_sub_q31(
xorjoep 1:24714b45cd1b 56 const arm_matrix_instance_q31 * pSrcA,
xorjoep 1:24714b45cd1b 57 const arm_matrix_instance_q31 * pSrcB,
xorjoep 1:24714b45cd1b 58 arm_matrix_instance_q31 * pDst)
xorjoep 1:24714b45cd1b 59 {
xorjoep 1:24714b45cd1b 60 q31_t *pIn1 = pSrcA->pData; /* input data matrix pointer A */
xorjoep 1:24714b45cd1b 61 q31_t *pIn2 = pSrcB->pData; /* input data matrix pointer B */
xorjoep 1:24714b45cd1b 62 q31_t *pOut = pDst->pData; /* output data matrix pointer */
xorjoep 1:24714b45cd1b 63 q31_t inA1, inB1; /* temporary variables */
xorjoep 1:24714b45cd1b 64
xorjoep 1:24714b45cd1b 65 #if defined (ARM_MATH_DSP)
xorjoep 1:24714b45cd1b 66
xorjoep 1:24714b45cd1b 67 q31_t inA2, inB2; /* temporary variables */
xorjoep 1:24714b45cd1b 68 q31_t out1, out2; /* temporary variables */
xorjoep 1:24714b45cd1b 69
xorjoep 1:24714b45cd1b 70 #endif // #if defined (ARM_MATH_DSP)
xorjoep 1:24714b45cd1b 71
xorjoep 1:24714b45cd1b 72 uint32_t numSamples; /* total number of elements in the matrix */
xorjoep 1:24714b45cd1b 73 uint32_t blkCnt; /* loop counters */
xorjoep 1:24714b45cd1b 74 arm_status status; /* status of matrix subtraction */
xorjoep 1:24714b45cd1b 75
xorjoep 1:24714b45cd1b 76
xorjoep 1:24714b45cd1b 77 #ifdef ARM_MATH_MATRIX_CHECK
xorjoep 1:24714b45cd1b 78 /* Check for matrix mismatch condition */
xorjoep 1:24714b45cd1b 79 if ((pSrcA->numRows != pSrcB->numRows) ||
xorjoep 1:24714b45cd1b 80 (pSrcA->numCols != pSrcB->numCols) ||
xorjoep 1:24714b45cd1b 81 (pSrcA->numRows != pDst->numRows) || (pSrcA->numCols != pDst->numCols))
xorjoep 1:24714b45cd1b 82 {
xorjoep 1:24714b45cd1b 83 /* Set status as ARM_MATH_SIZE_MISMATCH */
xorjoep 1:24714b45cd1b 84 status = ARM_MATH_SIZE_MISMATCH;
xorjoep 1:24714b45cd1b 85 }
xorjoep 1:24714b45cd1b 86 else
xorjoep 1:24714b45cd1b 87 #endif
xorjoep 1:24714b45cd1b 88 {
xorjoep 1:24714b45cd1b 89 /* Total number of samples in the input matrix */
xorjoep 1:24714b45cd1b 90 numSamples = (uint32_t) pSrcA->numRows * pSrcA->numCols;
xorjoep 1:24714b45cd1b 91
xorjoep 1:24714b45cd1b 92 #if defined (ARM_MATH_DSP)
xorjoep 1:24714b45cd1b 93
xorjoep 1:24714b45cd1b 94 /* Run the below code for Cortex-M4 and Cortex-M3 */
xorjoep 1:24714b45cd1b 95
xorjoep 1:24714b45cd1b 96 /* Loop Unrolling */
xorjoep 1:24714b45cd1b 97 blkCnt = numSamples >> 2U;
xorjoep 1:24714b45cd1b 98
xorjoep 1:24714b45cd1b 99 /* First part of the processing with loop unrolling. Compute 4 outputs at a time.
xorjoep 1:24714b45cd1b 100 ** a second loop below computes the remaining 1 to 3 samples. */
xorjoep 1:24714b45cd1b 101 while (blkCnt > 0U)
xorjoep 1:24714b45cd1b 102 {
xorjoep 1:24714b45cd1b 103 /* C(m,n) = A(m,n) - B(m,n) */
xorjoep 1:24714b45cd1b 104 /* Subtract, saturate and then store the results in the destination buffer. */
xorjoep 1:24714b45cd1b 105 /* Read values from source A */
xorjoep 1:24714b45cd1b 106 inA1 = pIn1[0];
xorjoep 1:24714b45cd1b 107
xorjoep 1:24714b45cd1b 108 /* Read values from source B */
xorjoep 1:24714b45cd1b 109 inB1 = pIn2[0];
xorjoep 1:24714b45cd1b 110
xorjoep 1:24714b45cd1b 111 /* Read values from source A */
xorjoep 1:24714b45cd1b 112 inA2 = pIn1[1];
xorjoep 1:24714b45cd1b 113
xorjoep 1:24714b45cd1b 114 /* Subtract and saturate */
xorjoep 1:24714b45cd1b 115 out1 = __QSUB(inA1, inB1);
xorjoep 1:24714b45cd1b 116
xorjoep 1:24714b45cd1b 117 /* Read values from source B */
xorjoep 1:24714b45cd1b 118 inB2 = pIn2[1];
xorjoep 1:24714b45cd1b 119
xorjoep 1:24714b45cd1b 120 /* Read values from source A */
xorjoep 1:24714b45cd1b 121 inA1 = pIn1[2];
xorjoep 1:24714b45cd1b 122
xorjoep 1:24714b45cd1b 123 /* Subtract and saturate */
xorjoep 1:24714b45cd1b 124 out2 = __QSUB(inA2, inB2);
xorjoep 1:24714b45cd1b 125
xorjoep 1:24714b45cd1b 126 /* Read values from source B */
xorjoep 1:24714b45cd1b 127 inB1 = pIn2[2];
xorjoep 1:24714b45cd1b 128
xorjoep 1:24714b45cd1b 129 /* Store result in destination */
xorjoep 1:24714b45cd1b 130 pOut[0] = out1;
xorjoep 1:24714b45cd1b 131 pOut[1] = out2;
xorjoep 1:24714b45cd1b 132
xorjoep 1:24714b45cd1b 133 /* Read values from source A */
xorjoep 1:24714b45cd1b 134 inA2 = pIn1[3];
xorjoep 1:24714b45cd1b 135
xorjoep 1:24714b45cd1b 136 /* Read values from source B */
xorjoep 1:24714b45cd1b 137 inB2 = pIn2[3];
xorjoep 1:24714b45cd1b 138
xorjoep 1:24714b45cd1b 139 /* Subtract and saturate */
xorjoep 1:24714b45cd1b 140 out1 = __QSUB(inA1, inB1);
xorjoep 1:24714b45cd1b 141
xorjoep 1:24714b45cd1b 142 /* Subtract and saturate */
xorjoep 1:24714b45cd1b 143 out2 = __QSUB(inA2, inB2);
xorjoep 1:24714b45cd1b 144
xorjoep 1:24714b45cd1b 145 /* Store result in destination */
xorjoep 1:24714b45cd1b 146 pOut[2] = out1;
xorjoep 1:24714b45cd1b 147 pOut[3] = out2;
xorjoep 1:24714b45cd1b 148
xorjoep 1:24714b45cd1b 149 /* update pointers to process next samples */
xorjoep 1:24714b45cd1b 150 pIn1 += 4U;
xorjoep 1:24714b45cd1b 151 pIn2 += 4U;
xorjoep 1:24714b45cd1b 152 pOut += 4U;
xorjoep 1:24714b45cd1b 153
xorjoep 1:24714b45cd1b 154 /* Decrement the loop counter */
xorjoep 1:24714b45cd1b 155 blkCnt--;
xorjoep 1:24714b45cd1b 156 }
xorjoep 1:24714b45cd1b 157
xorjoep 1:24714b45cd1b 158 /* If the numSamples is not a multiple of 4, compute any remaining output samples here.
xorjoep 1:24714b45cd1b 159 ** No loop unrolling is used. */
xorjoep 1:24714b45cd1b 160 blkCnt = numSamples % 0x4U;
xorjoep 1:24714b45cd1b 161
xorjoep 1:24714b45cd1b 162 #else
xorjoep 1:24714b45cd1b 163
xorjoep 1:24714b45cd1b 164 /* Run the below code for Cortex-M0 */
xorjoep 1:24714b45cd1b 165
xorjoep 1:24714b45cd1b 166 /* Initialize blkCnt with number of samples */
xorjoep 1:24714b45cd1b 167 blkCnt = numSamples;
xorjoep 1:24714b45cd1b 168
xorjoep 1:24714b45cd1b 169 #endif /* #if defined (ARM_MATH_DSP) */
xorjoep 1:24714b45cd1b 170
xorjoep 1:24714b45cd1b 171 while (blkCnt > 0U)
xorjoep 1:24714b45cd1b 172 {
xorjoep 1:24714b45cd1b 173 /* C(m,n) = A(m,n) - B(m,n) */
xorjoep 1:24714b45cd1b 174 /* Subtract, saturate and then store the results in the destination buffer. */
xorjoep 1:24714b45cd1b 175 inA1 = *pIn1++;
xorjoep 1:24714b45cd1b 176 inB1 = *pIn2++;
xorjoep 1:24714b45cd1b 177
xorjoep 1:24714b45cd1b 178 inA1 = __QSUB(inA1, inB1);
xorjoep 1:24714b45cd1b 179
xorjoep 1:24714b45cd1b 180 *pOut++ = inA1;
xorjoep 1:24714b45cd1b 181
xorjoep 1:24714b45cd1b 182 /* Decrement the loop counter */
xorjoep 1:24714b45cd1b 183 blkCnt--;
xorjoep 1:24714b45cd1b 184 }
xorjoep 1:24714b45cd1b 185
xorjoep 1:24714b45cd1b 186 /* Set status as ARM_MATH_SUCCESS */
xorjoep 1:24714b45cd1b 187 status = ARM_MATH_SUCCESS;
xorjoep 1:24714b45cd1b 188 }
xorjoep 1:24714b45cd1b 189
xorjoep 1:24714b45cd1b 190 /* Return to application */
xorjoep 1:24714b45cd1b 191 return (status);
xorjoep 1:24714b45cd1b 192 }
xorjoep 1:24714b45cd1b 193
xorjoep 1:24714b45cd1b 194 /**
xorjoep 1:24714b45cd1b 195 * @} end of MatrixSub group
xorjoep 1:24714b45cd1b 196 */