dna_seq_indexer.h 2.13 KB
Newer Older
Celine Mercier's avatar
Celine Mercier committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
/****************************************************************************
 * DNA sequence indexer header file	                                        *
 ****************************************************************************/

/**
 * @file dna_seq_indexer.h
 * @author Celine Mercier
 * @date April 12th 2016
 * @brief Header file for the functions handling the indexing of DNA sequences.
 */


#ifndef DNA_SEQ_INDEXER_H_
#define DNA_SEQ_INDEXER_H_


#include <stdlib.h>
#include <stdio.h>

#include "obidms.h"
#include "obitypes.h"
#include "obiblob.h"
#include "obiblob_indexer.h"


/**
 * @brief Converts a DNA sequence to a blob.
 *
 * @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(const 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)
 */
char* obi_blob_to_seq(Obi_blob_p value_b);


56 57 58 59 60 61 62 63 64 65 66
/**
 * @brief Stores a DNA sequence in an indexer and returns the index.
 *
 * @param indexer The indexer structure.
 * @param value The DNA sequence to index.
 *
 * @returns The index referring to the stored DNA sequence in the indexer.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
Celine Mercier's avatar
Celine Mercier committed
67 68
index_t obi_index_dna_seq(Obi_indexer_p indexer, const char* value);

69 70 71 72 73 74 75 76 77 78 79 80 81 82

/**
 * @brief Retrieves a DNA sequence from an indexer.
 *
 * @warning The DNA sequence returned must be freed by the caller.
 *
 * @param indexer The indexer structure.
 * @param idx The index referring to the DNA sequence to retrieve in the indexer.
 *
 * @returns A pointer on the DNA sequence.
 *
 * @since April 2016
 * @author Celine Mercier (celine.mercier@metabarcoding.org)
 */
Celine Mercier's avatar
Celine Mercier committed
83 84 85 86 87
char* obi_retrieve_dna_seq(Obi_indexer_p indexer, index_t idx);


#endif /* DNA_SEQ_INDEXER_H_ */