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

Documented the functions indexing and retrieving character strings

Browse Source
This commit is contained in:
Celine Mercier
2016-04-21 11:35:21 +02:00
parent 00f2f2cc51
commit 1a2fa0923c
1 changed files with 28 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
src/char_str_indexer.h
View File

@ -41,9 +41,11 @@ Obi_blob_p obi_str_to_blob(char* value);
/** /**
* @brief Converts a blob to a character string. * @brief Converts a blob to a character string.
* *
* @warning The character string returned is mapped.
*
* @param value_b The blob to convert. * @param value_b The blob to convert.
* *
* @returns A pointer to the character string contained in the blob. * @returns A pointer on the character string contained in the blob.
* *
* @since October 2015 * @since October 2015
* @author Celine Mercier (celine.mercier@metabarcoding.org) * @author Celine Mercier (celine.mercier@metabarcoding.org)
@ -51,9 +53,33 @@ Obi_blob_p obi_str_to_blob(char* value);
const char* obi_blob_to_str(Obi_blob_p value_b); const char* obi_blob_to_str(Obi_blob_p value_b);
// TODO doc /**
* @brief Stores a character string in an indexer and returns the index.
*
* @param indexer The indexer structure.
* @param value The character string to index.
*
* @returns The index referring to the stored character string in the indexer.
*
* @since April 2016
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
index_t obi_index_char_str(Obi_indexer_p indexer, const char* value); index_t obi_index_char_str(Obi_indexer_p indexer, const char* value);
/**
* @brief Retrieves a character string from an indexer.
*
* @warning The character string returned is mapped.
*
* @param indexer The indexer structure.
* @param idx The index referring to the character string to retrieve in the indexer.
*
* @returns A pointer on the character string.
*
* @since April 2016
* @author Celine Mercier (celine.mercier@metabarcoding.org)
*/
char* obi_retrieve_char_str(Obi_indexer_p indexer, index_t idx); char* obi_retrieve_char_str(Obi_indexer_p indexer, index_t idx);