BioHDF version 0.3 alpha
Scalable NGS Data Storage Based on HDF5
biohdf_utility.h
00001 /*****************************************************************************
00002  * Copyright by The HDF Group                                                *
00003  * All rights reserved.                                                      *
00004  *                                                                           *
00005  * This file is part of BioHDF.  The full BioHDF copyright notice, including *
00006  * terms governing use, modification, and redistribution, is contained in    *
00007  * the file COPYING.  COPYING can be found at the root of the source code    *
00008  * distribution tree.  If you do not have access to this file, you may       *
00009  * request a copy from help@hdfgroup.org.                                    *
00010  *****************************************************************************/
00011 
00018 #ifndef _BIOHDF_UTILITY_H
00019 #define _BIOHDF_UTILITY_H
00020 
00021 #include "biohdf_api.h"
00022 #include "biohdf_error.h"
00023 
00024 
00025 
00026 /*****************************************************************************
00027  * Destroy BioHDF memory (utility function)                                  *
00028  *****************************************************************************/
00029 
00030 
00031 
00041 BIOHDF_API biohdf_error
00042 BIOHDFfree_memory(/*IN-OUT*/ void **buffer);
00043 
00044 
00045 
00046 /*****************************************************************************
00047  * Index properties                                                          *
00048  *****************************************************************************/
00049 
00056 typedef struct _biohdf_index_creation_properties *biohdf_index_creation_properties;
00057 
00058 
00059 
00061 BIOHDF_API biohdf_error
00062 BIOHDFcreate_index_creation_properties(/*OUT*/ biohdf_index_creation_properties *props);
00063 
00064 
00065 
00067 BIOHDF_API biohdf_error
00068 BIOHDFdestroy_index_creation_properties(/*OUT*/ biohdf_index_creation_properties *props);
00069 
00070 
00071 
00073 BIOHDF_API biohdf_error
00074 BIOHDFset_index_creation_properties_max_memory_mb(biohdf_index_creation_properties props,
00075                                                   int64_t max_memory_to_use_mb);
00076 
00077 
00078 
00080 BIOHDF_API biohdf_error
00081 BIOHDFset_index_creation_properties_temp_path(biohdf_index_creation_properties props,
00082                                               char *path);
00083 
00084 
00085 
00091 #endif
 All Data Structures Variables