arm_pid_reset_q31.c

00001 /* ----------------------------------------------------------------------  
00002 * Copyright (C) 2010 ARM Limited. All rights reserved.  
00003 *  
00004 * $Date:        29. November 2010  
00005 * $Revision:    V1.0.3  
00006 *  
00007 * Project:      CMSIS DSP Library  
00008 * Title:        arm_pid_reset_q31.c  
00009 *  
00010 * Description:  Q31 PID Control reset function 
00011 *  
00012 * Target Processor: Cortex-M4/Cortex-M3
00013 *  
00014 * Version 1.0.3 2010/11/29 
00015 *    Re-organized the CMSIS folders and updated documentation.  
00016 *   
00017 * Version 1.0.2 2010/11/11  
00018 *    Documentation updated.   
00019 *  
00020 * Version 1.0.1 2010/10/05   
00021 *    Production release and review comments incorporated.  
00022 *  
00023 * Version 1.0.0 2010/09/20   
00024 *    Production release and review comments incorporated.  
00025 * ------------------------------------------------------------------- */ 
00026  
00027 #include "arm_math.h" 
00028  
00029  /**  
00030  * @addtogroup PID  
00031  * @{  
00032  */ 
00033  
00034 /**  
00035 * @brief  Reset function for the Q31 PID Control. 
00036 * @param[in] *S Instance pointer of PID control data structure. 
00037 * @return none.  
00038 * \par Description: 
00039 * The function resets the state buffer to zeros.  
00040 */ 
00041 void arm_pid_reset_q31( 
00042   arm_pid_instance_q31 * S) 
00043 { 
00044  
00045   /* Clear the state buffer.  The size will be always 3 samples */ 
00046   memset(S->state, 0, 3u * sizeof(q31_t));  
00047 } 
00048  
00049 /**  
00050  * @} end of PID group  
00051  */