John Garlitos / Mbed OS EVAL-CN0540-ARDZ

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   platform_drivers LTC26X6 AD77681

CMSIS-DSP_Lib/Source/MatrixFunctions/arm_mat_scale_f32.c@1:9dd7c64b4a64, 2021-12-06 (annotated)

Committer:
jngarlitos
Date:
Mon Dec 06 05:22:28 2021 +0000
Revision:
1:9dd7c64b4a64
EVAL-CN0540-ARDZ mbed example program Initial Commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jngarlitos 1:9dd7c64b4a64 1 /* ----------------------------------------------------------------------
jngarlitos 1:9dd7c64b4a64 2 * Copyright (C) 2010-2014 ARM Limited. All rights reserved.
jngarlitos 1:9dd7c64b4a64 3 *
jngarlitos 1:9dd7c64b4a64 4 * $Date: 19. March 2015
jngarlitos 1:9dd7c64b4a64 5 * $Revision: V.1.4.5
jngarlitos 1:9dd7c64b4a64 6 *
jngarlitos 1:9dd7c64b4a64 7 * Project: CMSIS DSP Library
jngarlitos 1:9dd7c64b4a64 8 * Title: arm_mat_scale_f32.c
jngarlitos 1:9dd7c64b4a64 9 *
jngarlitos 1:9dd7c64b4a64 10 * Description: Multiplies a floating-point matrix by a scalar.
jngarlitos 1:9dd7c64b4a64 11 *
jngarlitos 1:9dd7c64b4a64 12 * Target Processor: Cortex-M4/Cortex-M3/Cortex-M0
jngarlitos 1:9dd7c64b4a64 13 *
jngarlitos 1:9dd7c64b4a64 14 * Redistribution and use in source and binary forms, with or without
jngarlitos 1:9dd7c64b4a64 15 * modification, are permitted provided that the following conditions
jngarlitos 1:9dd7c64b4a64 16 * are met:
jngarlitos 1:9dd7c64b4a64 17 * - Redistributions of source code must retain the above copyright
jngarlitos 1:9dd7c64b4a64 18 * notice, this list of conditions and the following disclaimer.
jngarlitos 1:9dd7c64b4a64 19 * - Redistributions in binary form must reproduce the above copyright
jngarlitos 1:9dd7c64b4a64 20 * notice, this list of conditions and the following disclaimer in
jngarlitos 1:9dd7c64b4a64 21 * the documentation and/or other materials provided with the
jngarlitos 1:9dd7c64b4a64 22 * distribution.
jngarlitos 1:9dd7c64b4a64 23 * - Neither the name of ARM LIMITED nor the names of its contributors
jngarlitos 1:9dd7c64b4a64 24 * may be used to endorse or promote products derived from this
jngarlitos 1:9dd7c64b4a64 25 * software without specific prior written permission.
jngarlitos 1:9dd7c64b4a64 26 *
jngarlitos 1:9dd7c64b4a64 27 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
jngarlitos 1:9dd7c64b4a64 28 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
jngarlitos 1:9dd7c64b4a64 29 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
jngarlitos 1:9dd7c64b4a64 30 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
jngarlitos 1:9dd7c64b4a64 31 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
jngarlitos 1:9dd7c64b4a64 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
jngarlitos 1:9dd7c64b4a64 33 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
jngarlitos 1:9dd7c64b4a64 34 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
jngarlitos 1:9dd7c64b4a64 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
jngarlitos 1:9dd7c64b4a64 36 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
jngarlitos 1:9dd7c64b4a64 37 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
jngarlitos 1:9dd7c64b4a64 38 * POSSIBILITY OF SUCH DAMAGE.
jngarlitos 1:9dd7c64b4a64 39 * -------------------------------------------------------------------- */
jngarlitos 1:9dd7c64b4a64 40
jngarlitos 1:9dd7c64b4a64 41 #include "arm_math.h"
jngarlitos 1:9dd7c64b4a64 42
jngarlitos 1:9dd7c64b4a64 43 /**
jngarlitos 1:9dd7c64b4a64 44 * @ingroup groupMatrix
jngarlitos 1:9dd7c64b4a64 45 */
jngarlitos 1:9dd7c64b4a64 46
jngarlitos 1:9dd7c64b4a64 47 /**
jngarlitos 1:9dd7c64b4a64 48 * @defgroup MatrixScale Matrix Scale
jngarlitos 1:9dd7c64b4a64 49 *
jngarlitos 1:9dd7c64b4a64 50 * Multiplies a matrix by a scalar. This is accomplished by multiplying each element in the
jngarlitos 1:9dd7c64b4a64 51 * matrix by the scalar. For example:
jngarlitos 1:9dd7c64b4a64 52 * \image html MatrixScale.gif "Matrix Scaling of a 3 x 3 matrix"
jngarlitos 1:9dd7c64b4a64 53 *
jngarlitos 1:9dd7c64b4a64 54 * The function checks to make sure that the input and output matrices are of the same size.
jngarlitos 1:9dd7c64b4a64 55 *
jngarlitos 1:9dd7c64b4a64 56 * In the fixed-point Q15 and Q31 functions, <code>scale</code> is represented by
jngarlitos 1:9dd7c64b4a64 57 * a fractional multiplication <code>scaleFract</code> and an arithmetic shift <code>shift</code>.
jngarlitos 1:9dd7c64b4a64 58 * The shift allows the gain of the scaling operation to exceed 1.0.
jngarlitos 1:9dd7c64b4a64 59 * The overall scale factor applied to the fixed-point data is
jngarlitos 1:9dd7c64b4a64 60 * <pre>
jngarlitos 1:9dd7c64b4a64 61 * scale = scaleFract * 2^shift.
jngarlitos 1:9dd7c64b4a64 62 * </pre>
jngarlitos 1:9dd7c64b4a64 63 */
jngarlitos 1:9dd7c64b4a64 64
jngarlitos 1:9dd7c64b4a64 65 /**
jngarlitos 1:9dd7c64b4a64 66 * @addtogroup MatrixScale
jngarlitos 1:9dd7c64b4a64 67 * @{
jngarlitos 1:9dd7c64b4a64 68 */
jngarlitos 1:9dd7c64b4a64 69
jngarlitos 1:9dd7c64b4a64 70 /**
jngarlitos 1:9dd7c64b4a64 71 * @brief Floating-point matrix scaling.
jngarlitos 1:9dd7c64b4a64 72 * @param[in] *pSrc points to input matrix structure
jngarlitos 1:9dd7c64b4a64 73 * @param[in] scale scale factor to be applied
jngarlitos 1:9dd7c64b4a64 74 * @param[out] *pDst points to output matrix structure
jngarlitos 1:9dd7c64b4a64 75 * @return The function returns either <code>ARM_MATH_SIZE_MISMATCH</code>
jngarlitos 1:9dd7c64b4a64 76 * or <code>ARM_MATH_SUCCESS</code> based on the outcome of size checking.
jngarlitos 1:9dd7c64b4a64 77 *
jngarlitos 1:9dd7c64b4a64 78 */
jngarlitos 1:9dd7c64b4a64 79
jngarlitos 1:9dd7c64b4a64 80 arm_status arm_mat_scale_f32(
jngarlitos 1:9dd7c64b4a64 81 const arm_matrix_instance_f32 * pSrc,
jngarlitos 1:9dd7c64b4a64 82 float32_t scale,
jngarlitos 1:9dd7c64b4a64 83 arm_matrix_instance_f32 * pDst)
jngarlitos 1:9dd7c64b4a64 84 {
jngarlitos 1:9dd7c64b4a64 85 float32_t *pIn = pSrc->pData; /* input data matrix pointer */
jngarlitos 1:9dd7c64b4a64 86 float32_t *pOut = pDst->pData; /* output data matrix pointer */
jngarlitos 1:9dd7c64b4a64 87 uint32_t numSamples; /* total number of elements in the matrix */
jngarlitos 1:9dd7c64b4a64 88 uint32_t blkCnt; /* loop counters */
jngarlitos 1:9dd7c64b4a64 89 arm_status status; /* status of matrix scaling */
jngarlitos 1:9dd7c64b4a64 90
jngarlitos 1:9dd7c64b4a64 91 #ifndef ARM_MATH_CM0_FAMILY
jngarlitos 1:9dd7c64b4a64 92
jngarlitos 1:9dd7c64b4a64 93 float32_t in1, in2, in3, in4; /* temporary variables */
jngarlitos 1:9dd7c64b4a64 94 float32_t out1, out2, out3, out4; /* temporary variables */
jngarlitos 1:9dd7c64b4a64 95
jngarlitos 1:9dd7c64b4a64 96 #endif // #ifndef ARM_MATH_CM0_FAMILY
jngarlitos 1:9dd7c64b4a64 97
jngarlitos 1:9dd7c64b4a64 98 #ifdef ARM_MATH_MATRIX_CHECK
jngarlitos 1:9dd7c64b4a64 99 /* Check for matrix mismatch condition */
jngarlitos 1:9dd7c64b4a64 100 if((pSrc->numRows != pDst->numRows) || (pSrc->numCols != pDst->numCols))
jngarlitos 1:9dd7c64b4a64 101 {
jngarlitos 1:9dd7c64b4a64 102 /* Set status as ARM_MATH_SIZE_MISMATCH */
jngarlitos 1:9dd7c64b4a64 103 status = ARM_MATH_SIZE_MISMATCH;
jngarlitos 1:9dd7c64b4a64 104 }
jngarlitos 1:9dd7c64b4a64 105 else
jngarlitos 1:9dd7c64b4a64 106 #endif /* #ifdef ARM_MATH_MATRIX_CHECK */
jngarlitos 1:9dd7c64b4a64 107 {
jngarlitos 1:9dd7c64b4a64 108 /* Total number of samples in the input matrix */
jngarlitos 1:9dd7c64b4a64 109 numSamples = (uint32_t) pSrc->numRows * pSrc->numCols;
jngarlitos 1:9dd7c64b4a64 110
jngarlitos 1:9dd7c64b4a64 111 #ifndef ARM_MATH_CM0_FAMILY
jngarlitos 1:9dd7c64b4a64 112
jngarlitos 1:9dd7c64b4a64 113 /* Run the below code for Cortex-M4 and Cortex-M3 */
jngarlitos 1:9dd7c64b4a64 114
jngarlitos 1:9dd7c64b4a64 115 /* Loop Unrolling */
jngarlitos 1:9dd7c64b4a64 116 blkCnt = numSamples >> 2;
jngarlitos 1:9dd7c64b4a64 117
jngarlitos 1:9dd7c64b4a64 118 /* First part of the processing with loop unrolling. Compute 4 outputs at a time.
jngarlitos 1:9dd7c64b4a64 119 ** a second loop below computes the remaining 1 to 3 samples. */
jngarlitos 1:9dd7c64b4a64 120 while(blkCnt > 0u)
jngarlitos 1:9dd7c64b4a64 121 {
jngarlitos 1:9dd7c64b4a64 122 /* C(m,n) = A(m,n) * scale */
jngarlitos 1:9dd7c64b4a64 123 /* Scaling and results are stored in the destination buffer. */
jngarlitos 1:9dd7c64b4a64 124 in1 = pIn[0];
jngarlitos 1:9dd7c64b4a64 125 in2 = pIn[1];
jngarlitos 1:9dd7c64b4a64 126 in3 = pIn[2];
jngarlitos 1:9dd7c64b4a64 127 in4 = pIn[3];
jngarlitos 1:9dd7c64b4a64 128
jngarlitos 1:9dd7c64b4a64 129 out1 = in1 * scale;
jngarlitos 1:9dd7c64b4a64 130 out2 = in2 * scale;
jngarlitos 1:9dd7c64b4a64 131 out3 = in3 * scale;
jngarlitos 1:9dd7c64b4a64 132 out4 = in4 * scale;
jngarlitos 1:9dd7c64b4a64 133
jngarlitos 1:9dd7c64b4a64 134
jngarlitos 1:9dd7c64b4a64 135 pOut[0] = out1;
jngarlitos 1:9dd7c64b4a64 136 pOut[1] = out2;
jngarlitos 1:9dd7c64b4a64 137 pOut[2] = out3;
jngarlitos 1:9dd7c64b4a64 138 pOut[3] = out4;
jngarlitos 1:9dd7c64b4a64 139
jngarlitos 1:9dd7c64b4a64 140 /* update pointers to process next sampels */
jngarlitos 1:9dd7c64b4a64 141 pIn += 4u;
jngarlitos 1:9dd7c64b4a64 142 pOut += 4u;
jngarlitos 1:9dd7c64b4a64 143
jngarlitos 1:9dd7c64b4a64 144 /* Decrement the numSamples loop counter */
jngarlitos 1:9dd7c64b4a64 145 blkCnt--;
jngarlitos 1:9dd7c64b4a64 146 }
jngarlitos 1:9dd7c64b4a64 147
jngarlitos 1:9dd7c64b4a64 148 /* If the numSamples is not a multiple of 4, compute any remaining output samples here.
jngarlitos 1:9dd7c64b4a64 149 ** No loop unrolling is used. */
jngarlitos 1:9dd7c64b4a64 150 blkCnt = numSamples % 0x4u;
jngarlitos 1:9dd7c64b4a64 151
jngarlitos 1:9dd7c64b4a64 152 #else
jngarlitos 1:9dd7c64b4a64 153
jngarlitos 1:9dd7c64b4a64 154 /* Run the below code for Cortex-M0 */
jngarlitos 1:9dd7c64b4a64 155
jngarlitos 1:9dd7c64b4a64 156 /* Initialize blkCnt with number of samples */
jngarlitos 1:9dd7c64b4a64 157 blkCnt = numSamples;
jngarlitos 1:9dd7c64b4a64 158
jngarlitos 1:9dd7c64b4a64 159 #endif /* #ifndef ARM_MATH_CM0_FAMILY */
jngarlitos 1:9dd7c64b4a64 160
jngarlitos 1:9dd7c64b4a64 161 while(blkCnt > 0u)
jngarlitos 1:9dd7c64b4a64 162 {
jngarlitos 1:9dd7c64b4a64 163 /* C(m,n) = A(m,n) * scale */
jngarlitos 1:9dd7c64b4a64 164 /* The results are stored in the destination buffer. */
jngarlitos 1:9dd7c64b4a64 165 *pOut++ = (*pIn++) * scale;
jngarlitos 1:9dd7c64b4a64 166
jngarlitos 1:9dd7c64b4a64 167 /* Decrement the loop counter */
jngarlitos 1:9dd7c64b4a64 168 blkCnt--;
jngarlitos 1:9dd7c64b4a64 169 }
jngarlitos 1:9dd7c64b4a64 170
jngarlitos 1:9dd7c64b4a64 171 /* Set status as ARM_MATH_SUCCESS */
jngarlitos 1:9dd7c64b4a64 172 status = ARM_MATH_SUCCESS;
jngarlitos 1:9dd7c64b4a64 173 }
jngarlitos 1:9dd7c64b4a64 174
jngarlitos 1:9dd7c64b4a64 175 /* Return to application */
jngarlitos 1:9dd7c64b4a64 176 return (status);
jngarlitos 1:9dd7c64b4a64 177 }
jngarlitos 1:9dd7c64b4a64 178
jngarlitos 1:9dd7c64b4a64 179 /**
jngarlitos 1:9dd7c64b4a64 180 * @} end of MatrixScale group
jngarlitos 1:9dd7c64b4a64 181 */