BioHDF version 0.3 alpha
Scalable NGS Data Storage Based on HDF5
|
BioHDF utility functions. More...
Functions | |
BIOHDF_API biohdf_error | BIOHDFfree_memory (void **buffer) |
Free memory allocated by the BioHDF library. | |
Indexing: Index Creation Properties | |
typedef struct _biohdf_index_creation_properties * | biohdf_index_creation_properties |
BioHDF index creation properties. | |
BIOHDF_API biohdf_error | BIOHDFcreate_index_creation_properties (biohdf_index_creation_properties *props) |
Create a reads properties container. | |
BIOHDF_API biohdf_error | BIOHDFdestroy_index_creation_properties (biohdf_index_creation_properties *props) |
Destroy a reads properties container. | |
BIOHDF_API biohdf_error | BIOHDFset_index_creation_properties_max_memory_mb (biohdf_index_creation_properties props, int64_t max_memory_to_use_mb) |
Set reads properties sequences length. | |
BIOHDF_API biohdf_error | BIOHDFset_index_creation_properties_temp_path (biohdf_index_creation_properties props, char *path) |
Set reads properties sequences length. |
BioHDF utility functions.
BIOHDF_API biohdf_error BIOHDFcreate_index_creation_properties | ( | biohdf_index_creation_properties * | props | ) |
Create a reads properties container.
CHECK*PARAMETERS
CODE
SUCCESS
FAILURE
BIOHDF_API biohdf_error BIOHDFfree_memory | ( | void ** | buffer | ) |
Free memory allocated by the BioHDF library.
Frees memory returned via a void or char pointer from any BioHDF function. The memory will be freed and set to NULL. Used to avoid CRT problems on Windows and for language interop.
[in,out] | buffer | The memory to be freed. |
BIOHDF_API biohdf_error BIOHDFset_index_creation_properties_temp_path | ( | biohdf_index_creation_properties | props, |
char * | path | ||
) |
Set reads properties sequences length.
CHECK*PARAMETERS
CODE
SUCCESS
FAILURE