ucw/doc/index.txt

   1 The UCW library
   2 ===============
   3
   4 The UCW library aims to provide a set general purpose tools for programming
   5 in the C language. It contains generic data structures (lists, trees, hash
   6 tables etc.), fast memory allocators optimized for various usage patterns,
   7 abstract I/O streams and optimized implementations of some common algorithms
   8 (e.g., sorting of arrays and files).
   9
  10 Please note that this documentation is not yet complete. Many modules are
  11 not described, so you might need to look into the source code.
  12
  13 You can see the index of <<def_index:,documented definitions>>.
  14
  15 Modules
  16 -------
  17 - <<basics:,Basics>>
  18 - <<log:,Logging>>
  19 - <<fastbuf:,Fastbufs>>
  20 - <<basecode:,Base64 and Base224 encoding>>
  21 - <<hash:,Hashing routines>>
  22 - <<conf:,Configuration and command line parser>>
  23 - <<mempool:,Memory pools>>
  24 - <<eltpool:,Fixed-sized allocators>>
  25 - <<mainloop:,Mainloop>>
  26 - <<unaligned:,Unaligned data>>
  27 - <<lists:,Link lists>>
  28 - <<heap:,Binary heaps>>
  29 - <<binheap:,Binomial heaps>>
  30 - <<hashtable:,Hash tables>>
  31 - <<growbuf:,Growing buffers>>
  32 - <<chartype:,Single-byte characters>>
  33 - <<unicode:,Multi-byte characters>>
  34 - <<prime:,Prime numbers>>
  35 - <<sort:,Sorting>>
  36 - <<binsearch:,Binary search>>
  37 - <<compress:,Compression>>
  38
  39 Other features
  40 --------------
  41 - <<configure:,Compile time configuration>>
  42 - <<config:,Configuration file syntax>>
  43 - <<docsys:,Documentation system>>
  44 - <<generic:,Macro-generated generics>>
  45 - <<relnotes:,Release notes>>
  46
  47 Yet undocumented modules
  48 ------------------------
  49 - Trie
  50   * `trie.h`
  51 - Red-black trees
  52   * `redblack.h`
  53 - Bit manipulation
  54   * `bitarray.h`
  55   * `bitopts.h`
  56   * `bitsig.h`
  57 - String manipulation
  58   * `kmp.h`
  59   * `kmp-search.h`
  60   * `regex.h`
  61   * `stkstring.h`
  62   * `string.h`
  63   * `str-match.h`
  64   * `strtonum.h`
  65   * `wildmatch.h`
  66 - File manipulation
  67   * `asio.h`
  68   * `lfs.h`
  69   * `partmap.h`
  70 - Address manipulation
  71   * `url.h`
  72   * `ipaccess.h`
  73 - Prefetching of memory
  74   * `prefetch.h`
  75 - Caches
  76   * `qache.h`
  77 - Threads
  78   * `semaphore.h`
  79   * `threads.h`
  80   * `workqueue.h`
  81 - Profiling support
  82   * `profile.h`
  83
  84 License
  85 -------
  86 The UCW library is copyrighted by its authors:
  87
  88 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  89 - Martin Mareš <mailto:mj\@ucw.cz[]>
  90 - Robert Špalek <mailto:robert\@ucw.cz[]>
  91 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  92
  93 It can be freely distributed and used according to the terms of
  94 the GNU Lesser General Public License.