neural_tensor_map.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_NEURAL_TENSOR_MAP_H
#define OAKFIELD_NEURAL_TENSOR_MAP_H
 
#include "field.h"
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define SIM_NEURAL_TENSOR_MAX_RANK 5U
 
#define SIM_NEURAL_TENSOR_CHANNEL_AXIS_AUTO 255U
 
typedef enum SimNeuralTensorValueType {
    SIM_NEURAL_TENSOR_VALUE_REAL_F64 = 0,            
    SIM_NEURAL_TENSOR_VALUE_COMPLEX_F64_INTERLEAVED, 
} SimNeuralTensorValueType;
 
typedef enum SimNeuralTensorComplexMode {
    SIM_NEURAL_TENSOR_COMPLEX_INTERLEAVED = 0, 
    SIM_NEURAL_TENSOR_COMPLEX_SPLIT_CHANNELS,  
} SimNeuralTensorComplexMode;
 
typedef struct SimNeuralTensorAffineHook {
    bool enabled; 
    double scale; 
    double bias;  
} SimNeuralTensorAffineHook;
 
typedef struct SimNeuralTensorMapConfig {
    uint8_t channel_axis; 
    bool channels_last; 
    size_t batch_size;  
    SimNeuralTensorComplexMode complex_mode; 
    SimNeuralTensorAffineHook affine;        
} SimNeuralTensorMapConfig;
 
typedef struct SimNeuralTensorView {
    void *data;                                 
    SimNeuralTensorValueType value_type;        
    size_t value_size;                          
    size_t rank;                                
    size_t shape[SIM_NEURAL_TENSOR_MAX_RANK];   
    size_t strides[SIM_NEURAL_TENSOR_MAX_RANK]; 
    uint8_t batch_axis;                         
    uint8_t channel_axis;                       
    uint8_t spatial_rank;                       
} SimNeuralTensorView;
 
typedef struct SimNeuralTensorMapMetrics {
    bool zero_copy;                 
    bool used_copy_fallback;        
    size_t bytes_copied_from_field; 
    size_t bytes_copied_to_field; 
    size_t affine_element_ops;    
} SimNeuralTensorMapMetrics;
 
typedef struct SimNeuralTensorMapping {
    SimNeuralTensorView view;          
    SimNeuralTensorMapMetrics metrics; 
    SimNeuralTensorMapConfig config;   
    /* Internal bookkeeping fields (public for C ABI simplicity). */
    const SimField *field_const; 
    SimField *field_mut;         
    void *scratch;              
    size_t scratch_bytes;       
    uint8_t field_rank;         
    uint8_t field_channel_axis; 
    uint8_t field_spatial_rank; 
    uint8_t field_spatial_axes[3]; 
    bool has_field_channel_axis;   
    bool output_mode;              
    bool active;                   
} SimNeuralTensorMapping;
 
SimNeuralTensorMapConfig sim_neural_tensor_map_config_defaults(void);
 
SimResult sim_neural_tensor_map_input(const SimField *field, const SimNeuralTensorMapConfig *config,
                                      SimNeuralTensorMapping *out_mapping);
 
SimResult sim_neural_tensor_map_output(SimField *field, const SimNeuralTensorMapConfig *config,
                                       SimNeuralTensorMapping *out_mapping);
 
SimResult sim_neural_tensor_unmap_output(SimNeuralTensorMapping *mapping);
 
void sim_neural_tensor_mapping_release(SimNeuralTensorMapping *mapping);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_NEURAL_TENSOR_MAP_H */