complex_math.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_COMPLEX_MATH_H
#define OAKFIELD_COMPLEX_MATH_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimComplexMathMode {
    SIM_COMPLEX_MATH_ADD = 0, 
    SIM_COMPLEX_MATH_SUB,     
    SIM_COMPLEX_MATH_MUL,     
    SIM_COMPLEX_MATH_DIV,     
    SIM_COMPLEX_MATH_POW,     
    SIM_COMPLEX_MATH_EXP,     
    SIM_COMPLEX_MATH_LOG,     
    SIM_COMPLEX_MATH_SIN,     
    SIM_COMPLEX_MATH_COS,     
    SIM_COMPLEX_MATH_TAN,     
    SIM_COMPLEX_MATH_SINH,    
    SIM_COMPLEX_MATH_COSH,    
    SIM_COMPLEX_MATH_TANH,    
    SIM_COMPLEX_MATH_SQRT,    
    SIM_COMPLEX_MATH_CONJ,    
    SIM_COMPLEX_MATH_ABS,     
    SIM_COMPLEX_MATH_ARG,     
    SIM_COMPLEX_MATH_REAL,    
    SIM_COMPLEX_MATH_IMAG,    
    SIM_COMPLEX_MATH_NEG      
} SimComplexMathMode;
 
typedef enum SimComplexMathRhsSource {
    SIM_COMPLEX_MATH_RHS_FIELD = 0, 
    SIM_COMPLEX_MATH_RHS_CONSTANT   
} SimComplexMathRhsSource;
 
typedef enum SimComplexMathOutputComponent {
    SIM_COMPLEX_MATH_OUTPUT_REAL = 0,  
    SIM_COMPLEX_MATH_OUTPUT_IMAG,      
    SIM_COMPLEX_MATH_OUTPUT_MAGNITUDE, 
    SIM_COMPLEX_MATH_OUTPUT_PHASE      
} SimComplexMathOutputComponent;
 
typedef enum SimComplexMathPhaseWrap {
    SIM_COMPLEX_MATH_PHASE_NONE = 0, 
    SIM_COMPLEX_MATH_PHASE_SIGNED,   
    SIM_COMPLEX_MATH_PHASE_UNSIGNED, 
    SIM_COMPLEX_MATH_PHASE_UNIT      
} SimComplexMathPhaseWrap;
 
typedef struct SimComplexMathOperatorConfig {
    size_t lhs_field;                               
    size_t rhs_field;                               
    size_t output_field;                            
    SimComplexMathMode mode;                        
    SimComplexMathRhsSource rhs_source;             
    double rhs_constant_re;                         
    double rhs_constant_im;                         
    double lhs_scale_re;                            
    double lhs_scale_im;                            
    double rhs_scale_re;                            
    double rhs_scale_im;                            
    double bias_re;                                 
    double bias_im;                                 
    double epsilon;                                 
    SimComplexMathOutputComponent output_component; 
    SimComplexMathPhaseWrap phase_wrap;             
    bool accumulate;                                
    bool scale_by_dt;                               
} SimComplexMathOperatorConfig;
 
SimResult sim_add_complex_math_operator(struct SimContext *context,
                                        const SimComplexMathOperatorConfig *config,
                                        size_t *out_index);
 
SimResult sim_complex_math_config(struct SimContext *context, size_t operator_index,
                                  SimComplexMathOperatorConfig *out_config);
 
SimResult sim_complex_math_update(struct SimContext *context, size_t operator_index,
                                  const SimComplexMathOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_COMPLEX_MATH_H */