sim_buffer.h

Go to the documentation of this file.

 
#ifndef OAKFIELD_SIM_BUFFER_H
#define OAKFIELD_SIM_BUFFER_H
 
#include <stdbool.h>
#include <stddef.h>
 
#include "field.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum SimBufferDataType {
    SIM_BUFFER_DOUBLE = 0,     
    SIM_BUFFER_COMPLEX_DOUBLE, 
    SIM_BUFFER_UNKNOWN,        
    SIM_BUFFER_I32,            
    SIM_BUFFER_I64,            
    SIM_BUFFER_U32,            
    SIM_BUFFER_U64,            
    SIM_BUFFER_I8,             
    SIM_BUFFER_U8              
} SimBufferDataType;
 
typedef struct SimBufferView {
    void *data;                        
    size_t count;                      
    SimBufferDataType type;            
    SimFieldLayout layout;             
    const size_t *logical_to_physical; 
} SimBufferView;
 
typedef struct SimBuffer {
    void *data;             
    size_t count;           
    size_t bytes;           
    SimBufferDataType type; 
    size_t *shape_storage;  
    size_t *stride_storage; 
    SimFieldLayout layout;  
} SimBuffer;
 
size_t sim_buffer_element_size(SimBufferDataType type);
 
SimBufferDataType sim_buffer_data_type_from_element_size(size_t element_size);
 
SimBufferDataType sim_buffer_data_type_from_scalar_domain(SimScalarDomain domain);
 
SimScalarDomain sim_buffer_data_type_to_scalar_domain(SimBufferDataType type);
 
const char *sim_buffer_data_type_name(SimBufferDataType type);
 
bool sim_buffer_view_is_valid(const SimBufferView *view);
 
bool sim_buffer_view_offset_for_indices(const SimBufferView *view, const size_t *indices,
                                        size_t index_count, size_t *out_offset);
 
bool sim_buffer_view_offset_for_linear_index(const SimBufferView *view, size_t logical_index,
                                             size_t *out_offset);
 
bool sim_buffer_view_get_complex(const SimBufferView *view, size_t logical_index,
                                 SimComplexDouble *out_value);
 
bool sim_buffer_view_set_complex(SimBufferView *view, size_t logical_index, SimComplexDouble value);
 
SimBuffer *sim_buffer_create(size_t rank, const size_t *shape, SimBufferDataType type);
 
SimBuffer *sim_buffer_create_1d(size_t count, SimBufferDataType type);
 
SimBuffer *sim_buffer_clone_view(const SimBufferView *view);
 
SimResult sim_buffer_reshape(SimBuffer *buffer, size_t rank, const size_t *shape);
 
void sim_buffer_destroy(SimBuffer *buffer);
 
void *sim_buffer_data(SimBuffer *buffer);
 
const void *sim_buffer_const_data(const SimBuffer *buffer);
 
size_t sim_buffer_count(const SimBuffer *buffer);
 
size_t sim_buffer_bytes(const SimBuffer *buffer);
 
SimBufferDataType sim_buffer_type(const SimBuffer *buffer);
 
const SimFieldLayout *sim_buffer_layout(const SimBuffer *buffer);
 
SimBufferView sim_buffer_view(const SimBuffer *buffer);
 
#ifdef __cplusplus
}
#endif
 
#endif /* OAKFIELD_SIM_BUFFER_H */