obitools/obitools3
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 66 Wiki Activity

Add function for estimating the size of an obitype or of an array of

Browse Source 
obitype.
This commit is contained in:
Eric Coissac
2015-05-23 16:50:49 +03:00
parent 57db677d1f
commit 3aec0d7b50
2 changed files with 87 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
src/obitypes.h
View File

@ -1,7 +1,3 @@
/****************************************************************************
* OBITypes header file *
****************************************************************************/
/**
* @file obitypes.h
* @author Celine Mercier
@ -13,6 +9,7 @@
#define OBITYPES_H_
#include <stdio.h>
#include <unistd.h>
#define OBIInt_NA (INT32_MIN)
#define OBIFloat_NA (NAN)
@ -35,10 +32,10 @@ typedef enum {
typedef enum OBIType {
OBI_VOID = 0, /**< data type not specified */
OBIInt_t, /**< a signed integer value (C type : int32_t) */
OBIFloat_t, /**< a floating value (C type : double) */
OBIChar_t, /**< a character (C type : char) */
OBIIdx_t /**< an index in a data structure (C type : size_t) */
OBI_INT, /**< a signed integer value (C type : int32_t) */
OBI_FLOAT, /**< a floating value (C type : double) */
OBI_CHAR, /**< a character (C type : char) */
OBI_IDX /**< an index in a data structure (C type : size_t) */
} OBIType_t, *OBIType_p;
typedef int32_t obiint_t;
@ -46,5 +43,34 @@ typedef double obifloat_t;
typedef char obichar_t;
typedef size_t obiidx_t;
/**
* @brief returns the memory size in bytes of an OBIType
*
* @param type the OBIType code used as query
*
* @return the size in bytes of the type
* @retval 0 on error (unknown type)
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
size_t obi_sizeof(OBIType_t type);
/**
* @brief returns the size requested to store an array of OBIType
*
* The returned size is enouth large to store an array of size nbelement
* but rounded at a multiple of the memory page size.
*
* @param type the OBIType code used as query
* @param nbelement the number of element to be stored
*
* @return the size in bytes of the type
* @retval 0 on error (unknown type)
*
* @since May 2015
* @author Eric Coissac (eric.coissac@metabarcoding.org)
*/
size_t obi_array_sizeof(OBIType_t type,size_t nbelement);
#endif /* OBITYPES_H_ */