1  /* ----------------------------------------------------------------------   
 2  * Copyright (C) 2010-2013 ARM Limited. All rights reserved.   
 3  *   
 4  * $Date:        17. January 2013  
 5  * $Revision: 	V1.4.0   
 6  *  
 7  * Project: 	    CMSIS DSP Library 
 8  *
 9  * Title:	    math_helper.h
10  * 
11  * Description:	Prototypes of all helper functions required.  
12  *
13  * Target Processor: Cortex-M4/Cortex-M3
14  *  
15  * Redistribution and use in source and binary forms, with or without 
16  * modification, are permitted provided that the following conditions
17  * are met:
18  *   - Redistributions of source code must retain the above copyright
19  *     notice, this list of conditions and the following disclaimer.
20  *   - Redistributions in binary form must reproduce the above copyright
21  *     notice, this list of conditions and the following disclaimer in
22  *     the documentation and/or other materials provided with the 
23  *     distribution.
24  *   - Neither the name of ARM LIMITED nor the names of its contributors
25  *     may be used to endorse or promote products derived from this
26  *     software without specific prior written permission.
27  *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
30  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
31  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
32  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
33  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
34  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
35  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
36  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
37  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
38  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
39  * POSSIBILITY OF SUCH DAMAGE.  
40  * -------------------------------------------------------------------- */
41  
42  
43  #include "arm_math.h"
44  
45  #ifndef MATH_HELPER_H
46  #define MATH_HELPER_H
47  
48  float arm_snr_f32(float *pRef, float *pTest,  uint32_t buffSize);  
49  void arm_float_to_q12_20(float *pIn, q31_t * pOut, uint32_t numSamples);
50  void arm_provide_guard_bits_q15(q15_t *input_buf, uint32_t blockSize, uint32_t guard_bits);
51  void arm_provide_guard_bits_q31(q31_t *input_buf, uint32_t blockSize, uint32_t guard_bits);
52  void arm_float_to_q14(float *pIn, q15_t *pOut, uint32_t numSamples);
53  void arm_float_to_q29(float *pIn, q31_t *pOut, uint32_t numSamples);
54  void arm_float_to_q28(float *pIn, q31_t *pOut, uint32_t numSamples);
55  void arm_float_to_q30(float *pIn, q31_t *pOut, uint32_t numSamples);
56  uint32_t arm_calc_guard_bits(uint32_t num_adds);
57  void arm_apply_guard_bits (float32_t * pIn, uint32_t numSamples, uint32_t guard_bits);
58  uint32_t arm_compare_fixed_q15(q15_t *pIn, q15_t * pOut, uint32_t numSamples);
59  uint32_t arm_compare_fixed_q31(q31_t *pIn, q31_t *pOut, uint32_t numSamples);
60  uint32_t arm_calc_2pow(uint32_t guard_bits);
61  #endif
62