remainder.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_REMAINDER_H
#define OAKFIELD_REMAINDER_H
 
#include "oakfield/operator_split.h"
 
#include <stdbool.h>
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct SimContext;
 
typedef enum SimRemainderNonlinearity {
    SIM_REMAINDER_NONLINEARITY_IDENTITY = 0, 
    SIM_REMAINDER_NONLINEARITY_ABS,          
    SIM_REMAINDER_NONLINEARITY_LOG_ABS,      
    SIM_REMAINDER_NONLINEARITY_POWER,        
    SIM_REMAINDER_NONLINEARITY_TANH          
} SimRemainderNonlinearity;
 
typedef enum SimRemainderComplexMode {
    SIM_REMAINDER_COMPLEX_MODE_COMPONENT =
        0, 
    SIM_REMAINDER_COMPLEX_MODE_POLAR =
        1 
} SimRemainderComplexMode;
 
typedef struct SimRemainderOperatorConfig {
    size_t warped_field;    
    size_t reference_field; 
    size_t output_field;    
    double weight;          
    double bias;            
    double exponent;        
    double epsilon;         
    SimRemainderNonlinearity nonlinearity; 
    bool accumulate;  
    bool scale_by_dt; 
    SimRemainderComplexMode complex_mode; 
} SimRemainderOperatorConfig;
 
SimResult sim_add_remainder_operator(struct SimContext *context,
                                     const SimRemainderOperatorConfig *config, size_t *out_index);
 
SimResult sim_remainder_config(struct SimContext *context, size_t operator_index,
                               SimRemainderOperatorConfig *out_config);
 
SimResult sim_remainder_update(struct SimContext *context, size_t operator_index,
                               const SimRemainderOperatorConfig *config);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_REMAINDER_H */