This file is indexed.

/usr/include/itpp/comm/interleave.h is in libitpp-dev 4.3.1-2.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  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
/*!
 * \file
 * \brief Definitions of interleaver classes
 * \author Pal Frenger
 *
 * -------------------------------------------------------------------------
 *
 * Copyright (C) 1995-2010  (see AUTHORS file for a list of contributors)
 *
 * This file is part of IT++ - a C++ library of mathematical, signal
 * processing, speech processing, and communications classes and functions.
 *
 * IT++ is free software: you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation, either version 3 of the License, or (at your option) any
 * later version.
 *
 * IT++ is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along
 * with IT++.  If not, see <http://www.gnu.org/licenses/>.
 *
 * -------------------------------------------------------------------------
 */

#ifndef INTERLEAVE_H
#define INTERLEAVE_H

#include <itpp/base/vec.h>
#include <itpp/base/mat.h>
#include <itpp/base/random.h>
#include <itpp/base/sort.h>
#include <itpp/itexports.h>

namespace itpp
{

/*! \addtogroup interl
 */

/*! \ingroup interl
  \class Block_Interleaver comm/interleave.h
  \brief Block Interleaver Class.

  Data is written row-wise and read column-wise when interleaving.
  <h3>Example of use:</h3>
  \code
  BPSK bpsk;
  bvec bits = "0 1 1 0 0 0 1 1 1 1 0 0 1 0 0 1";
  vec symbols = bpsk.modulate_bits(bits);

  Block_Interleaver<double> block_interleaver(4,4);
  vec interleaved_symbols = block_interleaver.interleave(symbols);
  \endcode

*/
template <class T>
class Block_Interleaver
{
public:
  //! Block_Interleaver constructor
  Block_Interleaver(void) {rows = 0; cols = 0;};
  //! Block_Interleaver constructor
  Block_Interleaver(int in_rows, int in_cols);
  //! Function for block interleaving. May add some zeros.
  Vec<T> interleave(const Vec<T> &input);
  //! Function for block interleaving. May add some zeros.
  void interleave(const Vec<T> &input, Vec<T> &output);
  //! Function for block deinterleaving. Removes additional zeros if \a keepzeros = 0.
  Vec<T> deinterleave(const Vec<T> &input, short keepzeros = 0);
  //! Function for block deinterleaving. Removes additional zeros if \a keepzeros = 0.
  void deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros = 0);
  //! Set the number of \a rows for block interleaving
  void set_rows(int in_rows) {rows = in_rows;};
  //! Set the number of \a columns for block interleaving
  void set_cols(int in_cols) {cols = in_cols;};
  //! Get the number of \a rows for block interleaving
  int get_rows(void) {return rows;};
  //! Get the number of \a columns for block interleaving
  int get_cols(void) {return cols;};
private:
  int rows, cols, input_length;
};

/*! \ingroup interl
  \class Cross_Interleaver comm/interleave.h
  \brief Cross Interleaver Class.

  <h3> Example of use: </h3>
  \code
  BPSK bpsk;
  bvec bits = "0 1 1 0 0 0 1 1 1 1 0 0 1 0 0 1";
  vec symbols = bpsk.modulate_bits(bits);

  Cross_Interleaver<double> cross_interleaver(4);
  vec interleaved_symbols = cross_interleaver.interleave(symbols);
  \endcode

  <ul>
  <li> See S. B. Wicker, "Error control systems for digital communications and storage,"
  Prentice Hall 1995, p. 427 for details. </li>
  </ul>
*/
template <class T>
class Cross_Interleaver
{
public:
  //! Cross_Interleaver constructor
  Cross_Interleaver(void) {order = 0;};
  //! Cross_Interleaver constructor
  Cross_Interleaver(int in_order);
  //! Function for cross interleaving. Adds some zeros.
  Vec<T> interleave(const Vec<T> &input);
  //! Function for cross interleaving. Adds some zeros.
  void interleave(const Vec<T> &input, Vec<T> &output);
  //! Function for cross deinterleaving. Removes aditional zeros if \a keepzeros = 0.
  Vec<T> deinterleave(const Vec<T> &input, short keepzeros = 0);
  //! Function for cross deinterleaving. Removes aditional zeros if \a keepzeros = 0.
  void deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros = 0);
  //! Set the \a order of the Cross Interleaver
  void set_order(int in_order);
  //! Get the \a order of the Cross Interleaver
  int get_order(void) {return order;};
private:
  int order;
  int input_length;
  Mat<T> inter_matrix;
  Vec<T> tempvec, zerostemp;
};

/*! \ingroup interl
  \class Sequence_Interleaver comm/interleave.h
  \brief Sequence Interleaver Class

  <h3> Example of use: </h3>
  \code
  BPSK bpsk;
  bvec bits = "0 1 1 0 0 0 1 1 1 1 0 0 1 0 0 1";
  vec symbols = bpsk.modulate_bits(bits);

  Sequence_Interleaver<double> sequence_interleaver(16);
  sequence_interleaver.randomize_interleaver_sequence();
  vec interleaved_symbols = sequence_snterleaver.interleave(symbols);
  \endcode

*/
template <class T>
class Sequence_Interleaver
{
public:
  //! Sequence_Interleaver constructor.
  Sequence_Interleaver(void) {interleaver_depth = 0;};
  /*!
    \brief Sequence_Interleaver constructor.

    Chooses a random sequence of length \a in_interleaver_depth for interleaving.
  */
  Sequence_Interleaver(int in_interleaver_depth);
  /*!
    \brief Sequence_Interleaver constructor.

    Uses the \a in_interleaver_sequence for interleaving.
  */
  Sequence_Interleaver(ivec in_interleaver_sequence);
  //! Function for sequence interleaving. May add some zeros.
  Vec<T> interleave(const Vec<T> &input);
  //! Function for sequence interleaving. May add some zeros.
  void interleave(const Vec<T> &input, Vec<T> &output);
  //! Function for sequence deinterleaving. Removes additional zeros if \a keepzeros = 0.
  Vec<T> deinterleave(const Vec<T> &input, short keepzeros = 0);
  //! Function for sequence deinterleaving. Removes additional zeros if \a keepzeros = 0.
  void deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros = 0);
  //! Generate a new random sequence for interleaving.
  void randomize_interleaver_sequence();
  //! Returns the interleaver sequence presently used.
  ivec get_interleaver_sequence();
  //! Set the interleaver sequence to be used.
  void set_interleaver_sequence(ivec in_interleaver_sequence);
  //! Set the length of the interleaver sequence to be used.
  void set_interleaver_depth(int in_interleaver_depth) { interleaver_depth = in_interleaver_depth; };
  //! Get the length of the interleaver sequence presently used.
  int get_interleaver_depth(void) { return interleaver_depth; };
private:
  ivec interleaver_sequence;
  int interleaver_depth, input_length;
};

//-----------------------------------------------------------------------------
// Implementation of templated members starts here
//-----------------------------------------------------------------------------

//-------------------------- Block Interleaver ---------------------------------

template<class T>
Block_Interleaver<T>::Block_Interleaver(int in_rows, int in_cols)
{
  rows = in_rows;
  cols = in_cols;
  input_length = 0;
}

template<class T>
void Block_Interleaver<T>::interleave(const Vec<T> &input, Vec<T> &output)
{
  input_length = input.length();
  int steps = (int)std::ceil(double(input_length) / double(rows * cols));
  int output_length = steps * rows * cols;
  output.set_length(output_length, false);
  int s, r, c;

  if (input_length == output_length) {
    //Block interleaver loop: All steps.
    for (s = 0; s < steps; s++) {
      for (c = 0; c < cols; c++) {
        for (r = 0; r < rows; r++) {
          output(s*rows*cols + r*cols + c) = input(s * rows * cols + c * rows + r);
        }
      }
    }
  }
  else {
    //Block interleaver loop: All, but the last, steps.
    for (s = 0; s < steps - 1; s++) {
      for (c = 0; c < cols; c++) {
        for (r = 0; r < rows; r++) {
          output(s*rows*cols + r*cols + c) = input(s * rows * cols + c * rows + r);
        }
      }
    }
    //The last step.
    Vec<T> zerovect(output_length - input_length);
    zerovect.clear();
    Vec<T> temp_last_input = concat(input.right(rows * cols - zerovect.length()), zerovect);
    for (c = 0; c < cols; c++) {
      for (r = 0; r < rows; r++) {
        output((steps - 1)*rows*cols + r*cols + c) = temp_last_input(c * rows + r);
      }
    }
  }
}

template<class T>
Vec<T> Block_Interleaver<T>::interleave(const Vec<T> &input)
{
  Vec<T> output;
  interleave(input, output);
  return output;
}

template<class T>
void Block_Interleaver<T>::deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros)
{
  int thisinput_length = input.length();
  int steps = (int)std::ceil(double(thisinput_length) / double(rows * cols));
  int output_length = steps * rows * cols;
  output.set_size(output_length, false);
  int s, r, c;

  if (thisinput_length == output_length) {
    //Block deinterleaver loop: All, but the last, steps.
    for (s = 0; s < steps; s++) {
      for (r = 0; r < rows; r++) {
        for (c = 0; c < cols; c++) {
          output(s*rows*cols + c*rows + r) = input(s * rows * cols + r * cols + c);
        }
      }
    }
  }
  else {
    //Block deinterleaver loop: All, but the last, steps.
    for (s = 0; s < steps - 1; s++) {
      for (r = 0; r < rows; r++) {
        for (c = 0; c < cols; c++) {
          output(s*rows*cols + c*rows + r) = input(s * rows * cols + r * cols + c);
        }
      }
    }
    //The last step.
    Vec<T> zerovect(output_length - thisinput_length);
    zerovect.clear();
    Vec<T> temp_last_input = concat(input.right(rows * cols - zerovect.length()), zerovect);
    for (r = 0; r < rows; r++) {
      for (c = 0; c < cols; c++) {
        output((steps - 1)*rows*cols + c*rows + r) = temp_last_input(r * cols + c);
      }
    }
  }
  if (keepzeros == 0)
    output.set_size(input_length, true);
}

template<class T>
Vec<T> Block_Interleaver<T>::deinterleave(const Vec<T> &input, short keepzeros)
{
  Vec<T> output;
  deinterleave(input, output, keepzeros);
  return output;
}

//---------------------------- Cross Interleaver ---------------------------

template<class T>
Cross_Interleaver<T>::Cross_Interleaver(int in_order)
{
  order = in_order;
  input_length = 0;
  inter_matrix.set_size(order, order, false);
  tempvec.set_size(order, false);
  zerostemp.set_size(order, false);
}

template<class T>
void Cross_Interleaver<T>::interleave(const Vec<T> &input, Vec<T> &output)
{
  input_length = input.length();
  int steps = (int)std::ceil(float(input_length) / order) + order;
  int output_length = steps * order;
  output.set_length(output_length, false);
  int i, r, c;

  inter_matrix.clear();
  zerostemp.clear();

  //Cross interleaver loop:
  for (i = 0; i < steps; i++) {

    //Shift the matrix to the right:
    for (c = order - 1; c > 0; c--)
      inter_matrix.set_col(c, inter_matrix.get_col(c - 1));

    // Write the new data to the matrix
    if ((i*order + order) < input_length)
      tempvec = input.mid(i * order, order);
    else if ((i*order) < input_length)
      tempvec = concat(input.right(input_length - i * order), zerostemp.left(order - (input_length - i * order)));
    else
      tempvec.clear();
    inter_matrix.set_col(0, tempvec);

    //Read the matrix diagonal-wise:
    for (r = 0; r < order; r++)
      output(i*order + r) = inter_matrix(r, r);
  }
}

template<class T>
Vec<T> Cross_Interleaver<T>::interleave(const Vec<T> &input)
{
  Vec<T> output;
  interleave(input, output);
  return output;
}

template<class T>
void Cross_Interleaver<T>::deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros)
{
  int thisinput_length = input.length();
  int steps = (int)std::ceil(float(thisinput_length) / order) + order;
  int output_length = steps * order;
  output.set_size(output_length, false);
  int i, r, c;

  inter_matrix.clear();
  zerostemp.clear();

  //Cross interleaver loop:
  for (i = 0; i < steps; i++) {

    //Shift the matrix to the right:
    for (c = order - 1; c > 0; c--)
      inter_matrix.set_col(c, inter_matrix.get_col(c - 1));

    // Write the new data to the matrix
    if ((i*order + order) < thisinput_length)
      tempvec = input.mid(i * order, order);
    else if ((i*order) < thisinput_length)
      tempvec = concat(input.right(thisinput_length - i * order), zerostemp.left(order - (thisinput_length - i * order)));
    else
      tempvec.clear();
    inter_matrix.set_col(0, tempvec);

    //Read the matrix diagonal-wise:
    for (r = 0; r < order; r++)
      output(i*order + r)  = inter_matrix(r, order - 1 - r);
  }
  if (keepzeros == 0)
    output = output.mid(round_i(std::pow(double(order), 2)) - order, input_length);
}

template<class T>
Vec<T> Cross_Interleaver<T>::deinterleave(const Vec<T> &input, short keepzeros)
{
  Vec<T> output;
  deinterleave(input, output, keepzeros);
  return output;
}

template<class T>
void Cross_Interleaver<T>::set_order(int in_order)
{
  order = in_order;
  input_length = 0;
  inter_matrix.set_size(order, order, false);
  tempvec.set_size(order, false);
  zerostemp.set_size(order, false);
}

//------------------- Sequence Interleaver --------------------------------

template<class T>
Sequence_Interleaver<T>::Sequence_Interleaver(int in_interleaver_depth)
{
  interleaver_depth = in_interleaver_depth;
  interleaver_sequence = sort_index(randu(in_interleaver_depth));
  input_length = 0;
}

template<class T>
Sequence_Interleaver<T>::Sequence_Interleaver(ivec in_interleaver_sequence)
{
  interleaver_depth = in_interleaver_sequence.length();
  interleaver_sequence = in_interleaver_sequence;
  input_length = 0;
}

template<class T>
void Sequence_Interleaver<T>::interleave(const Vec<T> &input, Vec<T> &output)
{
  input_length = input.length();
  int steps = (int)std::ceil(double(input_length) / double(interleaver_depth));
  int output_length = steps * interleaver_depth;
  output.set_size(output_length, false);
  int s, i;

  if (input_length == output_length) {

    //Sequence interleaver loop: All steps.
    for (s = 0; s < steps; s++) {
      for (i = 0; i < interleaver_depth; i++) {
        output(s*interleaver_depth + i) = input(s * interleaver_depth + interleaver_sequence(i));
      }
    }

  }
  else {

    //Sequence interleaver loop: All, but the last, steps.
    for (s = 0; s < steps - 1; s++) {
      for (i = 0; i < interleaver_depth; i++) {
        output(s*interleaver_depth + i) = input(s * interleaver_depth + interleaver_sequence(i));
      }
    }
    //The last step.
    Vec<T> zerovect(output_length - input_length);
    zerovect.clear();
    Vec<T> temp_last_input = concat(input.right(interleaver_depth - zerovect.length()), zerovect);
    for (i = 0; i < interleaver_depth; i++) {
      output((steps - 1)*interleaver_depth + i) = temp_last_input(interleaver_sequence(i));
    }

  }
}

template<class T>
Vec<T> Sequence_Interleaver<T>::interleave(const Vec<T> &input)
{
  Vec<T> output;
  interleave(input, output);
  return output;
}

template<class T>
void Sequence_Interleaver<T>::deinterleave(const Vec<T> &input, Vec<T> &output, short keepzeros)
{
  int thisinput_length = input.length();
  int steps = (int)std::ceil(double(thisinput_length) / double(interleaver_depth));
  int output_length = steps * interleaver_depth;
  output.set_length(output_length, false);
  int s, i;

  if (thisinput_length == output_length) {

    //Sequence interleaver loop: All steps.
    for (s = 0; s < steps; s++) {
      for (i = 0; i < interleaver_depth; i++) {
        output(s*interleaver_depth + interleaver_sequence(i)) = input(s * interleaver_depth + i);
      }
    }

  }
  else {
    //Sequence interleaver loop: All, but the last, steps.
    for (s = 0; s < steps - 1; s++) {
      for (i = 0; i < interleaver_depth; i++) {
        output(s*interleaver_depth + interleaver_sequence(i)) = input(s * interleaver_depth + i);
      }
    }
    //The last step.
    Vec<T> zerovect(output_length - thisinput_length);
    zerovect.clear();
    Vec<T> temp_last_input = concat(input.right(interleaver_depth - zerovect.length()), zerovect);
    for (i = 0; i < interleaver_depth; i++) {
      output((steps - 1)*interleaver_depth + interleaver_sequence(i)) = temp_last_input(i);
    }
    if (keepzeros == 0)
      output.set_size(input_length, true);
  }

}

template<class T>
Vec<T> Sequence_Interleaver<T>::deinterleave(const Vec<T> &input, short keepzeros)
{
  Vec<T> output;
  deinterleave(input, output, keepzeros);
  return output;
}

template<class T>
void Sequence_Interleaver<T>::randomize_interleaver_sequence()
{
  interleaver_sequence = sort_index(randu(interleaver_depth));
}

template<class T>
ivec Sequence_Interleaver<T>::get_interleaver_sequence()
{
  return interleaver_sequence;
}

template<class T>
void Sequence_Interleaver<T>::set_interleaver_sequence(ivec in_interleaver_sequence)
{
  interleaver_sequence = in_interleaver_sequence;
  interleaver_depth = interleaver_sequence.size();
}

//! \cond

// ----------------------------------------------------------------------
// Instantiations
// ----------------------------------------------------------------------

ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Block_Interleaver<double>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Block_Interleaver<short>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Block_Interleaver<int>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Block_Interleaver<std::complex<double> >;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Block_Interleaver<bin>;

ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Cross_Interleaver<double>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Cross_Interleaver<short>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Cross_Interleaver<int>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Cross_Interleaver<std::complex<double> >;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Cross_Interleaver<bin>;

ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Sequence_Interleaver<double>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Sequence_Interleaver<short>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Sequence_Interleaver<int>;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Sequence_Interleaver<std::complex<double> >;
ITPP_EXPORT_TEMPLATE template class ITPP_EXPORT Sequence_Interleaver<bin>;

//! \endcond

} // namespace itpp

#endif // #ifndef INTERLEAVE_H