DNA_seq_indexer API

This commit is contained in:
Celine Mercier
2016-04-12 16:38:47 +02:00
parent 04e3a7b5a9
commit be05c889e2
16 changed files with 200 additions and 97 deletions

View File

@ -45,6 +45,11 @@ typedef struct Obi_blob {
} Obi_blob_t, *Obi_blob_p;
// TODO doc
Obi_blob_p obi_blob(byte_t* encoded_value, uint8_t element_size, int32_t length_encoded_value, int32_t length_decoded_value);
/**
* @brief Converts a character string to a blob.
*
@ -74,35 +79,5 @@ Obi_blob_p obi_str_to_blob(char* value);
const char* obi_blob_to_str(Obi_blob_p value_b);
/**
* @brief Converts a DNA sequence to a blob with a header.
*
* @warning The blob must be freed by the caller.
*
* @param value The DNA sequence to convert.
*
* @returns A pointer to the blob created.
* @retval NULL if an error occurred.
*
* @since November 2015
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
Obi_blob_p obi_seq_to_blob(char* seq);
/**
* @brief Converts a blob to a DNA sequence.
*
* @param value_b The blob to convert.
*
* @returns A pointer to the DNA sequence contained in the blob.
* @retval NULL if an error occurred.
*
* @since November 2015
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
const char* obi_blob_to_seq(Obi_blob_p value_b); // TODO move to encode source files
#endif /* OBIBLOB_H_ */