1 /* 2 * divsufsort.h for libdivsufsort-lite 3 * Copyright (c) 2003-2008 Yuta Mori All Rights Reserved. 4 * 5 * Permission is hereby granted, free of charge, to any person 6 * obtaining a copy of this software and associated documentation 7 * files (the "Software"), to deal in the Software without 8 * restriction, including without limitation the rights to use, 9 * copy, modify, merge, publish, distribute, sublicense, and/or sell 10 * copies of the Software, and to permit persons to whom the 11 * Software is furnished to do so, subject to the following 12 * conditions: 13 * 14 * The above copyright notice and this permission notice shall be 15 * included in all copies or substantial portions of the Software. 16 * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 18 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 19 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND 20 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 21 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 22 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 23 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 24 * OTHER DEALINGS IN THE SOFTWARE. 25 */ 26 27 #ifndef _DIVSUFSORT_H 28 #define _DIVSUFSORT_H 1 29 30 /*- Prototypes -*/ 31 32 /** 33 * Constructs the suffix array of a given string. 34 * @param T [0..n-1] The input string. 35 * @param SA [0..n-1] The output array of suffixes. 36 * @param n The length of the given string. 37 * @param openMP enables OpenMP optimization. 38 * @return 0 if no error occurred, -1 or -2 otherwise. 39 */ 40 int 41 divsufsort(const unsigned char *T, int *SA, int n, int openMP); 42 43 /** 44 * Constructs the burrows-wheeler transformed string of a given string. 45 * @param T [0..n-1] The input string. 46 * @param U [0..n-1] The output string. (can be T) 47 * @param A [0..n-1] The temporary array. (can be NULL) 48 * @param n The length of the given string. 49 * @param num_indexes The length of secondary indexes array. (can be NULL) 50 * @param indexes The secondary indexes array. (can be NULL) 51 * @param openMP enables OpenMP optimization. 52 * @return The primary index if no error occurred, -1 or -2 otherwise. 53 */ 54 int 55 divbwt(const unsigned char *T, unsigned char *U, int *A, int n, unsigned char * num_indexes, int * indexes, int openMP); 56 57 #endif /* _DIVSUFSORT_H */ 58