Updated documentation (54556485) · Commits · Wenxi XU / Cmsis Dsp

Documentation/Doxygen/dsp.dxy.in

+2 −2

Original line number	Diff line number	Diff line
		@@ -500,7 +500,7 @@ NUM_PROC_THREADS = 1
		# normally produced when WARNINGS is set to YES.
		# The default value is: NO.

		EXTRACT_ALL = YES
		EXTRACT_ALL = NO

		# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
		# be included in the documentation.
		@@ -564,7 +564,7 @@ RESOLVE_UNNAMED_PARAMS = YES
		# section is generated. This option has no effect if EXTRACT_ALL is enabled.
		# The default value is: NO.

		HIDE_UNDOC_MEMBERS = NO
		HIDE_UNDOC_MEMBERS = YES

		# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
		# undocumented classes that are normally visible in the class hierarchy. If set

+86 −0

Original line number	Diff line number	Diff line
		/**
		\page rev_hist Revision History
		<table class="cmtable" summary="Revision History">
		<tr>
		<th>Version</th>
		<th>Description</th>
		</tr>
		<tr>
		<td>v1.15.0</td>
		<td>
		v1.15.0

		* Switched to semantic versioning
		* Corrections to MFCC
		* Updated support for cmsis build tools 2.0
		* Compute graph removed. It is now part of CMSIS-Stream
		* Github issues:
		* 95,96,105,106,108,111,112
		* New FFT initializations to allow linker to do code size optimizations
		* If you know the size of the transform at build time, prefer functions like
		arm_cfft_init_64_q15 to functions like arm_cfft_init_q15.
		It applies for CFFT, RFFT and MFCC and other datatypes.
		</td>
		</tr>
		<tr>
		<td>v1.14.4</td>
		<td>
		Version v1.14.4
		</td>
		</tr>
		<tr>
		<td>v1.14.3</td>
		<td>
		v1.14.3
		</td>
		</tr>
		<tr>
		<td>v1.14.2</td>
		<td>
		Bug fixes.

		Bug fixes and improvements to compute graph.
		</td>
		</tr>
		<tr>
		<td>v1.14.1</td>
		<td>
		Some Neon acceleration for aarch64 f64 kernels
		</td>
		</tr>
		<tr>
		<td>v1.14.0</td>
		<td>
		Added support for CMSIS Event Recorder to the compute graph.
		Added more customization options to the compute graph.
		</td>
		</tr>
		<tr>
		<td>v1.13.0</td>
		<td>
		Added cyclo static scheduling to the CMSIS-DSP compute graph
		</td>
		</tr>
		<tr>
		<td>v1.12.0</td>
		<td>
		New version of SDF
		(Renaming and new feature to make it more developer friendly).
		</td>
		</tr>
		<tr>
		<td>v1.11.0</td>
		<td>
		Improved documentation.

		QR decomposition with Householder transform (float only).
		</td>
		</tr>
		<tr>
		<td>v1.10.1</td>
		<td>
		First release with new repository
		</td>
		</tr>
		</table>
		*/

+3 −0

Original line number	Diff line number	Diff line
		@@ -40,6 +40,9 @@ extern "C"

		#if defined(ARM_FLOAT16_SUPPORTED)

		/**
		* @brief Instance structure for the half floating-point Linear Interpolate function.
		*/
		typedef struct
		{
		uint32_t nValues; /*< nValues /

+7 −1

Original line number	Diff line number	Diff line
		@@ -867,6 +867,9 @@ arm_status arm_mfcc_init_f32(
		float32_t *pTmp
		);

		/**
		* @brief Instance structure for the Q31 MFCC function.
		*/
		typedef struct
		{
		const q31_t dctCoefs; /< Internal DCT coefficients /
		@@ -993,7 +996,7 @@ arm_status arm_mfcc_init_q31(
		@param[in] pSrc points to the input samples
		@param[out] pDst points to the output MFCC values
		@param[inout] pTmp points to a temporary buffer of complex
		@return none
		@return error status
		*/
		arm_status arm_mfcc_q31(
		const arm_mfcc_instance_q31 * S,
		@@ -1002,6 +1005,9 @@ arm_status arm_mfcc_init_q31(
		q31_t *pTmp
		);

		/**
		* @brief Instance structure for the Q15 MFCC function.
		*/
		typedef struct
		{
		const q15_t dctCoefs; /< Internal DCT coefficients /

+2 −1

Original line number	Diff line number	Diff line
		@@ -56,6 +56,7 @@
		@param[in] pSrc points to the input samples in Q15
		@param[out] pDst points to the output MFCC values in q8.7 format
		@param[inout] pTmp points to a temporary buffer of complex
		@return error status

		@par Description
		The number of input samples is the FFT length used