summaryrefslogtreecommitdiffstats
path: root/ml/dlib/docs/docs/compression.xml
blob: a5b3897b20893ba7023d08af7a32761d5a9e89fd (plain)
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
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
<?xml version="1.0" encoding="ISO-8859-1"?>
<?xml-stylesheet type="text/xsl" href="stylesheet.xsl"?>

<doc>
   <title>Data Compression</title>

   <!-- ************************************************************************* -->

   <body>
  <p>
     This page contains a bunch of objects that implement various parts of compression algorithms.  
     They can be put together in different ways to construct many different algorithms.  
     Note that the <a href="#compress_stream">compress_stream</a> object contains complete compression algorithms.  So if you
     just want to compress some data then you can easily use that object and not bother with the others.
  </p>
      <p>
      In the column to the right you can see benchmark data for each of the compress_stream 
      typedefs.  The times measured are the time it takes to compress and then
      decompress each file.  It was run on a 3.0ghz P4.   For reference see the Canterbury corpus 
      <a href="http://corpus.canterbury.ac.nz/">web site</a>.
      </p>


   
   </body>

   <!-- ************************************************************************* -->

   <menu width="200">
    <top>
      <section>
         <name>Objects</name>
         <item>compress_stream</item>
         <item>conditioning_class</item>
         <item>entropy_decoder</item>
         <item>entropy_encoder</item>
         <item>entropy_decoder_model</item>
         <item>entropy_encoder_model</item>
         <item>lz77_buffer</item>
         <item>lzp_buffer</item>
      </section>
 
 
 
 
      <section>
         <name>Benchmarks</name>
         <item>
            <name>kernel_1a</name>
            <link>kernel_1a.html</link>
         </item>
         <item>
            <name>kernel_1b</name>
            <link>kernel_1b.html</link>
         </item>
         <item>
            <name>kernel_1c</name>
            <link>kernel_1c.html</link>
         </item>
         <item>
            <name>kernel_1da</name>
            <link>kernel_1da.html</link>
         </item>
         <item>
            <name>kernel_1db</name>
            <link>kernel_1db.html</link>
         </item>
         <item>
            <name>kernel_1ea</name>
            <link>kernel_1ea.html</link>
         </item>
         <item>
            <name>kernel_1eb</name>
            <link>kernel_1eb.html</link>
         </item>
         <item>
            <name>kernel_1ec</name>
            <link>kernel_1ec.html</link>
         </item>
         <item>
            <name>kernel_2a</name>
            <link>kernel_2a.html</link>
         </item>
         <item>
            <name>kernel_3a</name>
            <link>kernel_3a.html</link>
         </item>
         <item>
            <name>kernel_3b</name>
            <link>kernel_3b.html</link>
         </item>
      </section>
    </top>  
   </menu>

   <!-- ************************************************************************* -->
   <!-- ************************************************************************* -->
   <!-- ************************************************************************* -->

   <components>
   
      
   <!-- ************************************************************************* -->
      
      <component>
         <name>compress_stream</name>
         <file>dlib/compress_stream.h</file>
         <spec_file>dlib/compress_stream/compress_stream_kernel_abstract.h</spec_file>
         <description>
            This object is pretty straight forward.  It has no state and just 
            contains the functions compress and decompress.
            They do just what their names imply to iostream objects.       
         </description>
         
         <examples>
            <example>compress_stream_ex.cpp.html</example>
            <example>file_to_code_ex.cpp.html</example>
         </examples>

         <implementations>
            <implementation>
               <name>compress_stream_kernel_1</name>
               <file>dlib/compress_stream/compress_stream_kernel_1.h</file>
               <description> 
                  This implementation is done using the <a href="#entropy_encoder_model">entropy_encoder_model</a> and 
                  <a href="#entropy_decoder_model">entropy_decoder_model</a> objects.
               </description> 
   

               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_1b and entropy_decoder_model_kernel_1b</description>
                  </typedef>
                  <typedef>
                     <name>kernel_1b</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_2b and entropy_decoder_model_kernel_2b  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1c</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_3b and entropy_decoder_model_kernel_3b  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1da</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_4a and entropy_decoder_model_kernel_4a  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1db</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_4b and entropy_decoder_model_kernel_4b  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1ea</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_5a and entropy_decoder_model_kernel_5a  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1eb</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_5b and entropy_decoder_model_kernel_5b  </description>
                  </typedef>
                  <typedef>
                     <name>kernel_1ec</name>
                     <description>is a typedef for compress_stream_kernel_1 which uses entropy_decoder_model_kernel_5c and entropy_decoder_model_kernel_5c  </description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>compress_stream_kernel_2</name>
               <file>dlib/compress_stream/compress_stream_kernel_2.h</file>
               <description> 
                  This implementation is done using the <a href="#entropy_encoder_model">entropy_encoder_model</a> and 
                  <a href="#entropy_decoder_model">entropy_decoder_model</a> objects.  It also uses the
                  <a href="#lz77_buffer">lz77_buffer</a> object.  It uses the entropy coder models to
                  encode symbols when there is no match found by the lz77_buffer.  
               </description> 
  

               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for compress_stream_kernel_2 which uses entropy_encoder_model_kernel_2b, entropy_decoder_model_kernel_2b, and lz77_buffer_kernel_2a.</description>
                  </typedef>
                  
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>compress_stream_kernel_3</name>
               <file>dlib/compress_stream/compress_stream_kernel_3.h</file>
               <description> 
                  This implementation is done using the <a href="#lzp_buffer">lzp_buffer</a> object and
                  <a href="other.html#crc32">crc32</a> object.  It does not use any sort of entropy coding, instead
                  a byte aligned output method is used.
               </description> 
  

               <typedefs>
                  <typedef>
                     <name>kernel_3a</name>
                     <description>is a typedef for compress_stream_kernel_3 which uses lzp_buffer_kernel_1.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_3b</name>
                     <description>is a typedef for compress_stream_kernel_3 which uses lzp_buffer_kernel_2.</description>
                  </typedef>
                  
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>conditioning_class</name>
         <file>dlib/conditioning_class.h</file>
         <spec_file>dlib/conditioning_class/conditioning_class_kernel_abstract.h</spec_file>
         <description>
                This object represents a conditioning class used for arithmetic style
                compression.  It maintains the cumulative counts which are needed
                by the entropy_encoder and entropy_decoder objects below.  
         </description>
         
         <implementations>
            <implementation>
               <name>conditioning_class_kernel_1</name>
               <file>dlib/conditioning_class/conditioning_class_kernel_1.h</file>
               <description> 
                  This implementation is done using an array to store all the counts and they are summed 
                  whenever the cumulative counts are requested.  It's pretty straight forward.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for conditioning_class_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
            <implementation>
               <name>conditioning_class_kernel_2</name>
               <file>dlib/conditioning_class/conditioning_class_kernel_2.h</file>
               <description> 
                  This implementation is done using a binary tree where each node in the tree represents one symbol and
                  contains that symbols count and the sum of all the counts for the nodes to the left.  This way
                  when you request a cumulative count it can be computed by visiting log n nodes where n is the 
                  size of the alphabet.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for conditioning_class_kernel_2</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                        
            <implementation>
               <name>conditioning_class_kernel_3</name>
               <file>dlib/conditioning_class/conditioning_class_kernel_3.h</file>
               <description> 
                  This implementation is done using an array to store all the counts and they are 
                  summed whenever the cumulative counts are requested. The counts are also kept in 
                  semi-sorted order to speed up the calculation of the cumulative count.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_3a</name>
                     <description>is a typedef for conditioning_class_kernel_3</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>conditioning_class_kernel_4</name>
               <file>dlib/conditioning_class/conditioning_class_kernel_4.h</file>
               <description> 
                  This implementation is done using a linked list to store all the counts and they are 
                  summed whenever the cumulative counts are requested. The counts are also kept in 
                  semi-sorted order to speed up the calculation of the cumulative count.  This implementation
                  also uses the <a href="other.html#memory_manager">memory_manager</a> component to create a 
                  memory pool of linked list nodes.  This implementation is especially useful for high order
                  contexts and/or very large and sparse alphabets.
               </description> 
    
    
               <typedefs>
                  <typedef>
                     <name>kernel_4a</name>
                     <description>is a typedef for conditioning_class_kernel_4 with a memory pool of 10,000 nodes.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_4b</name>
                     <description>is a typedef for conditioning_class_kernel_4 with a memory pool of 100,000 nodes.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_4c</name>
                     <description>is a typedef for conditioning_class_kernel_4 with a memory pool of 1,000,000 nodes.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_4d</name>
                     <description>is a typedef for conditioning_class_kernel_4 with a memory pool of 10,000,000 nodes.</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>entropy_decoder</name>
         <file>dlib/entropy_decoder.h</file>
         <spec_file>dlib/entropy_decoder/entropy_decoder_kernel_abstract.h</spec_file>
         <description>
            This object represents an entropy decoder.  E.g. the decoding part of 
            an arithmetic coder.
         </description>
         
         <implementations>
            <implementation>
               <name>entropy_decoder_kernel_1</name>
               <file>dlib/entropy_decoder/entropy_decoder_kernel_1.h</file>
               <description> 
                  This object is implemented using arithmetic coding and is done in the 
                  straight forward way using integers and fixed precision math. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for entropy_decoder_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation>
            <implementation>
               <name>entropy_decoder_kernel_2</name>
               <file>dlib/entropy_decoder/entropy_decoder_kernel_2.h</file>
               <description> 
                  This object is implemented using "range" coding and is done 
                  in the straight forward way using integers and fixed precision math. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for entropy_decoder_kernel_2</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>entropy_encoder</name>
         <file>dlib/entropy_encoder.h</file>
         <spec_file>dlib/entropy_encoder/entropy_encoder_kernel_abstract.h</spec_file>
         <description>
            This object represents an entropy encoder.  E.g. the encoding part of 
            an arithmetic coder.
         </description>
         
         <implementations>
            <implementation>
               <name>entropy_encoder_kernel_1</name>
               <file>dlib/entropy_encoder/entropy_encoder_kernel_1.h</file>
               <description> 
                  This object is implemented using arithmetic coding and is done in the 
                  straight forward way using integers and fixed precision math. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for entropy_encoder_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation>
            <implementation>
               <name>entropy_encoder_kernel_2</name>
               <file>dlib/entropy_encoder/entropy_encoder_kernel_2.h</file>
               <description> 
                  This object is implemented using "range" coding and is done 
                  in the straight forward way using integers and fixed precision math. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for entropy_encoder_kernel_2</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
      
   <!-- ************************************************************************* -->
      
      <component>
         <name>entropy_decoder_model</name>
         <file>dlib/entropy_decoder_model.h</file>
         <spec_file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_abstract.h</spec_file>
         <description>
                This object represents some kind of statistical model.  You
                can use it to read symbols from an entropy_decoder and it will calculate
                the cumulative counts/probabilities and manage contexts for you.
         </description>
         
         <implementations>
            <implementation>
               <name>entropy_decoder_model_kernel_1</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_1.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for entropy_decoder_model_kernel_1 that uses conditioning_class_kernel_1a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_1b</name>
                     <description>is a typedef for entropy_decoder_model_kernel_1 that uses conditioning_class_kernel_2a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_1c</name>
                     <description>is a typedef for entropy_decoder_model_kernel_1 that uses conditioning_class_kernel_3a</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_decoder_model_kernel_2</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_2.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-1-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for entropy_decoder_model_kernel_2 that uses conditioning_class_kernel_1a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2b</name>
                     <description>is a typedef for entropy_decoder_model_kernel_2 that uses conditioning_class_kernel_2a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2c</name>
                     <description>is a typedef for entropy_decoder_model_kernel_2 that uses conditioning_class_kernel_3a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2d</name>
                     <description>is a typedef for entropy_decoder_model_kernel_2 that uses conditioning_class_kernel_2a for its order-0
                         context and conditioning_class_kernel_4b for its order-1 context.</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_decoder_model_kernel_3</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_3.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-2-1-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_3a</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_3 that uses conditioning_class_kernel_1a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_3b</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_3 that uses conditioning_class_kernel_2a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_3c</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_3 that uses conditioning_class_kernel_3a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_decoder_model_kernel_4</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_4.h</file>
               <description> 
                  This object is implemented using a variation of the PPM algorithm described by Alistair Moffat in his paper "Implementing 
                  the PPM data compression scheme."
                  It provides template arguments to select the maximum order and maximum memory to use.  For speed,
                  exclusions are not used.  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_4a</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_4 with the max order set to 4 and the max number
                        of nodes set to 200,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_4b</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_4 with the max order set to 5 and the max number
                        of nodes set to 1,000,000</description>
                  </typedef>
               </typedefs>                
               
            </implementation>    
                     
            <implementation>
               <name>entropy_decoder_model_kernel_5</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_5.h</file>
               <description> 
                  This object is implemented using a variation of the PPM algorithm described by Alistair Moffat in his paper "Implementing 
                  the PPM data compression scheme."
                  It provides template arguments to select the maximum order and maximum memory to use.  Exclusions are used. The escape method used is method D.
                  This implementation is very much like kernel_4 except it is tuned for higher compression rather than speed.
                  This also uses Dmitry Shkarin's Information Inheritance scheme.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_5a</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_5 with the max order set to 4 and the max number
                        of nodes set to 200,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_5b</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_5 with the max order set to 5 and the max number
                         of nodes set to 1,000,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_5c</name>
                     <description>   is a typedef for entropy_decoder_model_kernel_5 with the max order set to 7 and the max number
                         of nodes set to 2,500,000</description>
                  </typedef>
               </typedefs>                
               
            </implementation>    
                     
            <implementation>
               <name>entropy_decoder_model_kernel_6</name>
               <file>dlib/entropy_decoder_model/entropy_decoder_model_kernel_6.h</file>
               <description> 
                  This object just assigns every symbol the same probability.  I.e. it uses an <i>order-(-1)</i> model.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_6a</name>
                     <description>is a typedef for entropy_decoder_model_kernel_6</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
      
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>entropy_encoder_model</name>
         <file>dlib/entropy_encoder_model.h</file>
         <spec_file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_abstract.h</spec_file>
         <description>
                This object represents some kind of statistical model.  You
                can use it to write symbols to an entropy_encoder and it will calculate
                the cumulative counts/probabilities and manage contexts for you.
         </description>
         
         <implementations>
            <implementation>
               <name>entropy_encoder_model_kernel_1</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_1.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for entropy_encoder_model_kernel_1 that uses conditioning_class_kernel_1a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_1b</name>
                     <description>is a typedef for entropy_encoder_model_kernel_1 that uses conditioning_class_kernel_2a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_1c</name>
                     <description>is a typedef for entropy_encoder_model_kernel_1 that uses conditioning_class_kernel_3a</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_encoder_model_kernel_2</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_2.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-1-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for entropy_encoder_model_kernel_2 that uses conditioning_class_kernel_1a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2b</name>
                     <description>is a typedef for entropy_encoder_model_kernel_2 that uses conditioning_class_kernel_2a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2c</name>
                     <description>is a typedef for entropy_encoder_model_kernel_2 that uses conditioning_class_kernel_3a</description>
                  </typedef>
                  <typedef>
                     <name>kernel_2d</name>
                     <description>is a typedef for entropy_encoder_model_kernel_2 that uses conditioning_class_kernel_2a for its order-0
                         context and conditioning_class_kernel_4b for its order-1 context.</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_encoder_model_kernel_3</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_3.h</file>
               <description> 
                  This object is implemented using the <a href="#conditioning_class">conditioning_class</a> component.
                  It implements an <i>order-2-1-0</i> finite context model and uses lazy exclusions and update exclusions.  
                  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_3a</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_3 that uses conditioning_class_kernel_1a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_3b</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_3 that uses conditioning_class_kernel_2a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
                  <typedef>
                     <name>kernel_3c</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_3 that uses conditioning_class_kernel_3a for orders 0 and 1
                        and conditioning_class_kernel_4b for order-2.</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
            <implementation>
               <name>entropy_encoder_model_kernel_4</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_4.h</file>
               <description> 
                  This object is implemented using a variation of the PPM algorithm described by Alistair Moffat in his paper "Implementing 
                  the PPM data compression scheme."
                  It provides template arguments to select the maximum order and maximum memory to use.  For speed,
                  exclusions are not used.  The escape method used is method D.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_4a</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_4 with the max order set to 4 and the max number
                        of nodes set to 200,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_4b</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_4 with the max order set to 5 and the max number
                        of nodes set to 1,000,000</description>
                  </typedef>
               </typedefs>                
               
            </implementation>    
                     
            <implementation>
               <name>entropy_encoder_model_kernel_5</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_5.h</file>
               <description> 
                  This object is implemented using a variation of the PPM algorithm described by Alistair Moffat in his paper "Implementing 
                  the PPM data compression scheme."
                  It provides template arguments to select the maximum order and maximum memory to use.  Exclusions are used. The escape method used is method D.
                  This implementation is very much like kernel_4 except it is tuned for higher compression rather than speed.
                  This also uses Dmitry Shkarin's Information Inheritance scheme.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_5a</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_5 with the max order set to 4 and the max number
                        of nodes set to 200,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_5b</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_5 with the max order set to 5 and the max number
                         of nodes set to 1,000,000</description>
                  </typedef>
                  <typedef>
                     <name>kernel_5c</name>
                     <description>   is a typedef for entropy_encoder_model_kernel_5 with the max order set to 7 and the max number
                         of nodes set to 2,500,000</description>
                  </typedef>
               </typedefs>                
               
            </implementation>    
                     
            <implementation>
               <name>entropy_encoder_model_kernel_6</name>
               <file>dlib/entropy_encoder_model/entropy_encoder_model_kernel_6.h</file>
               <description> 
                  This object just assigns every symbol the same probability.  I.e. it uses an <i>order-(-1)</i> model.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_6a</name>
                     <description>is a typedef for entropy_encoder_model_kernel_6</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
      
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>lz77_buffer</name>
         <file>dlib/lz77_buffer.h</file>
         <spec_file>dlib/lz77_buffer/lz77_buffer_kernel_abstract.h</spec_file>
         <description>
            This object represents a pair of buffers (history and lookahead buffers) 
                used during lz77 style compression.
         </description>
         
         <implementations>
            <implementation>
               <name>lz77_buffer_kernel_1</name>
               <file>dlib/lz77_buffer/lz77_buffer_kernel_1.h</file>
               <description> 
                  This object is implemented using the <a href="containers.html#sliding_buffer">sliding_buffer</a> and it 
                  just does simple linear searches of the history buffer to find matches. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for lz77_buffer_kernel_1 that uses sliding_buffer_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
            <implementation>
               <name>lz77_buffer_kernel_2</name>
               <file>dlib/lz77_buffer/lz77_buffer_kernel_2.h</file>
               <description> 
                  This object is implemented using the <a href="containers.html#sliding_buffer">sliding_buffer</a>.  It
                  finds matches by using a hash table. 
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for lz77_buffer_kernel_2 that uses sliding_buffer_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
      
   <!-- ************************************************************************* -->
      
      <component checked="true">
         <name>lzp_buffer</name>
         <file>dlib/lzp_buffer.h</file>
         <spec_file>dlib/lzp_buffer/lzp_buffer_kernel_abstract.h</spec_file>
         <description>
                This object represents some variation on the LZP algorithm
                described by Charles Bloom in his paper "LZP: a new data
                compression algorithm"
         </description>
         
         <implementations>
            <implementation>
               <name>lzp_buffer_kernel_1</name>
               <file>dlib/lzp_buffer/lzp_buffer_kernel_1.h</file>
               <description> 
                  This object is implemented using the <a href="containers.html#sliding_buffer">sliding_buffer</a> and uses
                  an order-3 model to predict matches.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_1a</name>
                     <description>is a typedef for lzp_buffer_kernel_1 that uses sliding_buffer_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
            <implementation>
               <name>lzp_buffer_kernel_2</name>
               <file>dlib/lzp_buffer/lzp_buffer_kernel_2.h</file>
               <description> 
                  This object is implemented using the <a href="containers.html#sliding_buffer">sliding_buffer</a> and uses
                  an order-5-4-3 model to predict matches.
               </description> 
    
               <typedefs>
                  <typedef>
                     <name>kernel_2a</name>
                     <description>is a typedef for lzp_buffer_kernel_2 that uses sliding_buffer_kernel_1</description>
                  </typedef>
               </typedefs>                
               
            </implementation> 
                     
         </implementations>
                        
      </component>
            
   <!-- ************************************************************************* -->
      
   </components>

   <!-- ************************************************************************* -->


</doc>