libsais-sys 0.2.0

Raw bindings to the C library libsais for suffix array construction
Documentation
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
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
/* automatically generated by rust-bindgen 0.72.0 and slightly edited */

pub const LIBSAIS16_VERSION_MAJOR: u32 = 2;
pub const LIBSAIS16_VERSION_MINOR: u32 = 10;
pub const LIBSAIS16_VERSION_PATCH: u32 = 3;
pub const LIBSAIS16_VERSION_STRING: &str = "2.10.3";

unsafe extern "C" {
    /// Creates the libsais16 context that allows reusing allocated memory with each libsais16 operation.In multi-threaded environments, use one context per thread for parallel executions.
    ///
    /// # Returns
    ///
    /// the libsais16 context, NULL otherwise.
    pub fn libsais16_create_ctx() -> *mut ::std::os::raw::c_void;

    /// Creates the libsais16 context that allows reusing allocated memory with each parallel libsais16 operation using OpenMP.In multi-threaded environments, use one context per thread for parallel executions.
    ///
    /// # Arguments
    ///
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// the libsais16 context, NULL otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_create_ctx_omp(threads: i32) -> *mut ::std::os::raw::c_void;

    /// Destroys the libsass context and free previusly allocated memory.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context (can be NULL).
    pub fn libsais16_free_ctx(ctx: *mut ::std::os::raw::c_void);

    /// Constructs the suffix array of a given 16-bit string.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16(T: *const u16, SA: *mut i32, n: i32, fs: i32, freq: *mut i32) -> i32;

    /// Constructs the generalized suffix array (GSA) of given 16-bit string set.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string set using 0 as separators (T[n-1] must be 0).
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string set.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_gsa(T: *const u16, SA: *mut i32, n: i32, fs: i32, freq: *mut i32) -> i32;

    /// Constructs the suffix array of a given integer array.Note, during construction input array will be modified, but restored at the end if no errors occurred.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input integer array.
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the integer array.
    /// * `k` - The alphabet size of the input integer array.
    /// * `fs` - Extra space available at the end of SA array (can be 0, but 4k or better 6k is recommended for optimal performance).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_int(T: *mut i32, SA: *mut i32, n: i32, k: i32, fs: i32) -> i32;

    /// Constructs the suffix array of a given 16-bit string using libsais16 context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context.
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        SA: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
    ) -> i32;

    /// Constructs the generalized suffix array (GSA) of given 16-bit string set using libsais16 context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context.
    /// * `T` - [0..n-1] The input 16-bit string set using 0 as separators (T[n-1] must be 0).
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string set.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_gsa_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        SA: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
    ) -> i32;

    /// Constructs the suffix array of a given 16-bit string in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_omp(
        T: *const u16,
        SA: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        threads: i32,
    ) -> i32;

    /// Constructs the generalized suffix array (GSA) of given 16-bit string set in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string set using 0 as separators (T[n-1] must be 0).
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the given 16-bit string set.
    /// * `fs` - The extra space available at the end of SA array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_gsa_omp(
        T: *const u16,
        SA: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        threads: i32,
    ) -> i32;

    /// Constructs the suffix array of a given integer array in parallel using OpenMP.Note, during construction input array will be modified, but restored at the end if no errors occurred.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input integer array.
    /// * `SA` - [0..n-1+fs] The output array of suffixes.
    /// * `n` - The length of the integer array.
    /// * `k` - The alphabet size of the input integer array.
    /// * `fs` - Extra space available at the end of SA array (can be 0, but 4k or better 6k is recommended for optimal performance).
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_int_omp(
        T: *mut i32,
        SA: *mut i32,
        n: i32,
        k: i32,
        fs: i32,
        threads: i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// The primary index if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_bwt(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string with auxiliary indexes.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The output auxiliary indexes.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_bwt_aux(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        r: i32,
        I: *mut i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string using libsais16 context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context.
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    ///
    /// # Returns
    ///
    /// The primary index if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_bwt_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string with auxiliary indexes using libsais16 context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context.
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The output auxiliary indexes.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_bwt_aux_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        r: i32,
        I: *mut i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// The primary index if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_bwt_omp(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        threads: i32,
    ) -> i32;

    /// Constructs the burrows-wheeler transformed 16-bit string (BWT) of a given 16-bit string with auxiliary indexes in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n-1+fs] The temporary array.
    /// * `n` - The length of the given 16-bit string.
    /// * `fs` - The extra space available at the end of A array (0 should be enough for most cases).
    /// * `freq` - [0..65535] The output 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The output auxiliary indexes.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_bwt_aux_omp(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        fs: i32,
        freq: *mut i32,
        r: i32,
        I: *mut i32,
        threads: i32,
    ) -> i32;

    /// Creates the libsais16 reverse BWT context that allows reusing allocated memory with each libsais16_unbwt_* operation.In multi-threaded environments, use one context per thread for parallel executions.
    ///
    /// # Returns
    ///
    /// the libsais16 context, NULL otherwise.
    pub fn libsais16_unbwt_create_ctx() -> *mut ::std::os::raw::c_void;

    /// Creates the libsais16 reverse BWT context that allows reusing allocated memory with each parallel libsais16_unbwt_* operation using OpenMP.In multi-threaded environments, use one context per thread for parallel executions.
    ///
    /// # Arguments
    ///
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// the libsais16 context, NULL otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_unbwt_create_ctx_omp(threads: i32) -> *mut ::std::os::raw::c_void;

    /// Destroys the libsass reverse BWT context and free previusly allocated memory.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 context (can be NULL).
    pub fn libsais16_unbwt_free_ctx(ctx: *mut ::std::os::raw::c_void);

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with primary index.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `i` - The primary index.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_unbwt(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        i: i32,
    ) -> i32;

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with primary index using libsais16 reverse BWT context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 reverse BWT context.
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `i` - The primary index.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_unbwt_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        i: i32,
    ) -> i32;

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with auxiliary indexes.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The input auxiliary indexes.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_unbwt_aux(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        r: i32,
        I: *const i32,
    ) -> i32;

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with auxiliary indexes using libsais16 reverse BWT context.
    ///
    /// # Arguments
    ///
    /// * `ctx` - The libsais16 reverse BWT context.
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The input auxiliary indexes.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    pub fn libsais16_unbwt_aux_ctx(
        ctx: *const ::std::os::raw::c_void,
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        r: i32,
        I: *const i32,
    ) -> i32;

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with primary index in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `i` - The primary index.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_unbwt_omp(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        i: i32,
        threads: i32,
    ) -> i32;

    /// Constructs the original 16-bit string from a given burrows-wheeler transformed 16-bit string (BWT) with auxiliary indexes in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `U` - [0..n-1] The output 16-bit string (can be T).
    /// * `A` - [0..n] The temporary array (NOTE, temporary array must be n + 1 size).
    /// * `n` - The length of the given 16-bit string.
    /// * `freq` - [0..65535] The input 16-bit symbol frequency table (can be NULL).
    /// * `r` - The sampling rate for auxiliary indexes (must be power of 2).
    /// * `I` - [0..(n-1)/r] The input auxiliary indexes.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 or -2 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_unbwt_aux_omp(
        T: *const u16,
        U: *mut u16,
        A: *mut i32,
        n: i32,
        freq: *const i32,
        r: i32,
        I: *const i32,
        threads: i32,
    ) -> i32;

    /// Constructs the permuted longest common prefix array (PLCP) of a given 16-bit string and a suffix array.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `SA` - [0..n-1] The input suffix array.
    /// * `PLCP` - [0..n-1] The output permuted longest common prefix array.
    /// * `n` - The length of the 16-bit string and the suffix array.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    pub fn libsais16_plcp(T: *const u16, SA: *const i32, PLCP: *mut i32, n: i32) -> i32;

    /// Constructs the permuted longest common prefix array (PLCP) of a given 16-bit string set and a generalized suffix array (GSA).
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string set using 0 as separators (T[n-1] must be 0).
    /// * `SA` - [0..n-1] The input generalized suffix array.
    /// * `PLCP` - [0..n-1] The output permuted longest common prefix array.
    /// * `n` - The length of the string set and the generalized suffix array.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    pub fn libsais16_plcp_gsa(T: *const u16, SA: *const i32, PLCP: *mut i32, n: i32) -> i32;

    /// Constructs the longest common prefix array (LCP) of a given permuted longest common prefix array (PLCP) and a suffix array.
    ///
    /// # Arguments
    ///
    /// * `PLCP` - [0..n-1] The input permuted longest common prefix array.
    /// * `SA` - [0..n-1] The input suffix array or generalized suffix array (GSA).
    /// * `LCP` - [0..n-1] The output longest common prefix array (can be SA).
    /// * `n` - The length of the permuted longest common prefix array and the suffix array.
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    pub fn libsais16_lcp(PLCP: *const i32, SA: *const i32, LCP: *mut i32, n: i32) -> i32;

    /// Constructs the permuted longest common prefix array (PLCP) of a given 16-bit string and a suffix array in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string.
    /// * `SA` - [0..n-1] The input suffix array.
    /// * `PLCP` - [0..n-1] The output permuted longest common prefix array.
    /// * `n` - The length of the 16-bit string and the suffix array.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_plcp_omp(
        T: *const u16,
        SA: *const i32,
        PLCP: *mut i32,
        n: i32,
        threads: i32,
    ) -> i32;

    /// Constructs the permuted longest common prefix array (PLCP) of a given 16-bit string set and a generalized suffix array (GSA) in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `T` - [0..n-1] The input 16-bit string set using 0 as separators (T[n-1] must be 0).
    /// * `SA` - [0..n-1] The input generalized suffix array.
    /// * `PLCP` - [0..n-1] The output permuted longest common prefix array.
    /// * `n` - The length of the string set and the generalized suffix array.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_plcp_gsa_omp(
        T: *const u16,
        SA: *const i32,
        PLCP: *mut i32,
        n: i32,
        threads: i32,
    ) -> i32;

    /// Constructs the longest common prefix array (LCP) of a given permuted longest common prefix array (PLCP) and a suffix array in parallel using OpenMP.
    ///
    /// # Arguments
    ///
    /// * `PLCP` - [0..n-1] The input permuted longest common prefix array.
    /// * `SA` - [0..n-1] The input suffix array or generalized suffix array (GSA).
    /// * `LCP` - [0..n-1] The output longest common prefix array (can be SA).
    /// * `n` - The length of the permuted longest common prefix array and the suffix array.
    /// * `threads` - The number of OpenMP threads to use (can be 0 for OpenMP default).
    ///
    /// # Returns
    ///
    /// 0 if no error occurred, -1 otherwise.
    #[cfg(feature = "openmp")]
    pub fn libsais16_lcp_omp(
        PLCP: *const i32,
        SA: *const i32,
        LCP: *mut i32,
        n: i32,
        threads: i32,
    ) -> i32;
}