dcl_zpk3.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2023-2025 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef _DCL_ZPK3_H_
#define _DCL_ZPK3_H_
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <complex.h>
 
//--- ZPK3 structure ---------------------------------------------------------
 
typedef struct dcl_zpk3 
{
    float complex z1;   
    float complex z2;   
    float complex z3;   
    float complex p1;   
    float complex p2;   
    float complex p3;   
    float32_t K;        
} DCL_ZPK3;
 
#define ZPK3_DEFAULTS { 0.0f + 0.0f*I, 0.0f + 0.0f*I, 0.0f + 0.0f*I, \
                        0.0f + 0.0f*I, 0.0f + 0.0f*I, 0.0f + 0.0f*I, \
                        1.0f }
 
typedef struct dcl_zpk3f64
{
    double complex z1;   
    double complex z2;   
    double complex z3;   
    double complex p1;   
    double complex p2;   
    double complex p3;   
    float64_t K;         
} DCL_ZPK3F64;
 
#define ZPK3F64_DEFAULTS { 0.0L + 0.0L*I, 0.0L + 0.0L*I, 0.0L + 0.0L*I, \
                        0.0L + 0.0L*I, 0.0L + 0.0L*I, 0.0L + 0.0L*I, \
                        1.0L }                        
 
_DCL_CODE_ACCESS
bool DCL_isStableZpk3(DCL_ZPK3 *q)
{
    return((cabsf(q->p1) < 1.0f) && (cabsf(q->p2) < 1.0f) && (cabsf(q->p3) < 1.0f));
}
 
_DCL_CODE_ACCESS
bool DCL_isStableZpk3F64(DCL_ZPK3 *q)
{
    return((cabs(q->p1) < 1.0L) && (cabs(q->p2) < 1.0L) && (cabs(q->p3) < 1.0L));
}
 
//  \brief          All ZPK functions exist in its respective controller conversion type
//                  All the ZPK conversion function prototypes are listed below
/*
extern void DCL_loadDF11asZPK(DCL_DF11 *p, DCL_ZPK3 *q);
 
extern void DCL_loadDF12asZPK(DCL_DF12 *p, DCL_ZPK3 *q);
 
extern void DCL_loadDF13asZPK(DCL_DF13 *p, DCL_ZPK3 *q);
 
extern void DCL_loadDF22asZPK(DCL_DF22 *p, DCL_ZPK3 *q);
 
extern void DCL_loadDF23asZPK(DCL_DF23 *p, DCL_ZPK3 *q);
 
extern void DCL_loadSeriesPIasZPK(DCL_PI *p, DCL_ZPK3 *q);
 
extern void DCL_loadParallelPIasZPK(DCL_PI *p, DCL_ZPK3 *q);
 
extern void DCL_loadSeriesPIDasZPK(DCL_PID *p, DCL_ZPK3 *q);
 
extern void DCL_loadParallelPIDasZPK(DCL_PID *p, DCL_ZPK3 *q);
 
extern void DCL_loadSeriesPIDF64asZPK(DCL_PIDF64 *p, DCL_ZPK3 *q);
 
extern void DCL_loadParallelPIDF64asZPK(DCL_PIDF64 *p, DCL_ZPK3F64 *q);
*/
 
#ifdef __cplusplus
}
#endif // extern "C"
 
#endif // _DCL_ZPK3_H_