arm_pid_reset_q15.c

00001 /* ----------------------------------------------------------------------
00002  * Project:      CMSIS DSP Library
00003  * Title:        arm_pid_reset_q15.c
00004  * Description:  Q15 PID Control reset function
00005  *
00006  * $Date:        27. January 2017
00007  * $Revision:    V.1.5.1
00008  *
00009  * Target Processor: Cortex-M cores
00010  * -------------------------------------------------------------------- */
00011 /*
00012  * Copyright (C) 2010-2017 ARM Limited or its affiliates. All rights reserved.
00013  *
00014  * SPDX-License-Identifier: Apache-2.0
00015  *
00016  * Licensed under the Apache License, Version 2.0 (the License); you may
00017  * not use this file except in compliance with the License.
00018  * You may obtain a copy of the License at
00019  *
00020  * www.apache.org/licenses/LICENSE-2.0
00021  *
00022  * Unless required by applicable law or agreed to in writing, software
00023  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
00024  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00025  * See the License for the specific language governing permissions and
00026  * limitations under the License.
00027  */
00028 
00029 #include "arm_math.h"
00030 
00031  /**
00032  * @addtogroup PID
00033  * @{
00034  */
00035 
00036 /**
00037 * @brief  Reset function for the Q15 PID Control.
00038 * @param[in] *S     Instance pointer of PID control data structure.
00039 * @return none.
00040 * \par Description:
00041 * The function resets the state buffer to zeros.
00042 */
00043 void arm_pid_reset_q15(
00044   arm_pid_instance_q15 * S)
00045 {
00046   /* Reset state to zero, The size will be always 3 samples */
00047   memset(S->state, 0, 3U * sizeof(q15_t));
00048 }
00049 
00050 /**
00051  * @} end of PID group
00052  */
00053