divsufsort.h 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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. #ifndef _DIVSUFSORT_H
  27. #define _DIVSUFSORT_H 1
  28. #ifdef __cplusplus
  29. extern "C" {
  30. #endif /* __cplusplus */
  31. /*- Prototypes -*/
  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. * Constructs the burrows-wheeler transformed string of a given string.
  44. * @param T [0..n-1] The input string.
  45. * @param U [0..n-1] The output string. (can be T)
  46. * @param A [0..n-1] The temporary array. (can be NULL)
  47. * @param n The length of the given string.
  48. * @param num_indexes The length of secondary indexes array. (can be NULL)
  49. * @param indexes The secondary indexes array. (can be NULL)
  50. * @param openMP enables OpenMP optimization.
  51. * @return The primary index if no error occurred, -1 or -2 otherwise.
  52. */
  53. int
  54. divbwt(const unsigned char *T, unsigned char *U, int *A, int n, unsigned char * num_indexes, int * indexes, int openMP);
  55. #ifdef __cplusplus
  56. } /* extern "C" */
  57. #endif /* __cplusplus */
  58. #endif /* _DIVSUFSORT_H */