Matrix Scale

riscv_status riscv_mat_scale_f32(const riscv_matrix_instance_f32 *pSrc, float32_t scale, riscv_matrix_instance_f32 *pDst)
riscv_status riscv_mat_scale_q15(const riscv_matrix_instance_q15 *pSrc, q15_t scaleFract, int32_t shift, riscv_matrix_instance_q15 *pDst)
riscv_status riscv_mat_scale_q31(const riscv_matrix_instance_q31 *pSrc, q31_t scaleFract, int32_t shift, riscv_matrix_instance_q31 *pDst)
group MatrixScale

Multiplies a matrix by a scalar. This is accomplished by multiplying each element in the matrix by the scalar. For example:

../../../_images/MatrixScale.png

The function checks to make sure that the input and output matrices are of the same size.

In the fixed-point Q15 and Q31 functions, scale is represented by a fractional multiplication scaleFract and an arithmetic shift shift. The shift allows the gain of the scaling operation to exceed 1.0. The overall scale factor applied to the fixed-point data is

Functions

riscv_status riscv_mat_scale_f32(const riscv_matrix_instance_f32 *pSrc, float32_t scale, riscv_matrix_instance_f32 *pDst)

Floating-point matrix scaling.

Return

execution status

  • RISCV_MATH_SUCCESS : Operation successful

  • RISCV_MATH_SIZE_MISMATCH : Matrix size check failed

Parameters
  • [in] pSrc: points to input matrix

  • [in] scale: scale factor to be applied

  • [out] pDst: points to output matrix structure

riscv_status riscv_mat_scale_q15(const riscv_matrix_instance_q15 *pSrc, q15_t scaleFract, int32_t shift, riscv_matrix_instance_q15 *pDst)

Q15 matrix scaling.

Return

execution status

  • RISCV_MATH_SUCCESS : Operation successful

  • RISCV_MATH_SIZE_MISMATCH : Matrix size check failed

Scaling and Overflow Behavior

The input data *pSrc and scaleFract are in 1.15 format. These are multiplied to yield a 2.30 intermediate result and this is shifted with saturation to 1.15 format.

Parameters
  • [in] pSrc: points to input matrix

  • [in] scaleFract: fractional portion of the scale factor

  • [in] shift: number of bits to shift the result by

  • [out] pDst: points to output matrix structure

riscv_status riscv_mat_scale_q31(const riscv_matrix_instance_q31 *pSrc, q31_t scaleFract, int32_t shift, riscv_matrix_instance_q31 *pDst)

Q31 matrix scaling.

Return

execution status

  • RISCV_MATH_SUCCESS : Operation successful

  • RISCV_MATH_SIZE_MISMATCH : Matrix size check failed

Scaling and Overflow Behavior

The input data *pSrc and scaleFract are in 1.31 format. These are multiplied to yield a 2.62 intermediate result which is shifted with saturation to 1.31 format.

Parameters
  • [in] pSrc: points to input matrix

  • [in] scaleFract: fractional portion of the scale factor

  • [in] shift: number of bits to shift the result by

  • [out] pDst: points to output matrix structure