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 - <<fastbuf:,Fastbufs>>
  18 - <<basecode:,Base64 and Base224 encoding>>
  19 - <<hash:,Hashing routines>>
  20 - <<conf:,Configuration and command line parser>>
  21 - <<mempool:,Memory pools>>
  22 - <<eltpool:,Fixed-sized allocators>>
  23 - <<mainloop:,Mainloop>>
  24 - <<unaligned:,Unaligned data>>
  25 - <<lists:,Link lists>>
  26 - <<heap:,Binary heaps>>
  27 - <<binheap:,Binomial heaps>>
  28 - <<hashtable:,Hash tables>>
  29 - <<growbuf:,Growing buffers>>
  30 - <<chartype:,Single-byte characters>>
  31 - <<unicode:,Multi-byte characters>>
  32 - <<prime:,Prime numbers>>
  33 - <<sort:,Sorting>>
  34 - <<binsearch:,Binary search>>
  35 - <<compress:,Compression>>
  36
  37 Other features
  38 --------------
  39 - <<configure:,Compile time configuration>>
  40 - <<config:,Configuration file syntax>>
  41 - <<docsys:,Documentation system>>
  42 - <<generic:,Macro-generated generics>>
  43
  44 Yet undocumented modules
  45 ------------------------
  46 - Trie
  47   * `trie.h`
  48 - Red-black trees
  49   * `redblack.h`
  50 - Bit manipulation
  51   * `bitarray.h`
  52   * `bitopts.h`
  53   * `bitsig.h`
  54 - String manipulation
  55   * `kmp.h`
  56   * `kmp-search.h`
  57   * `regex.h`
  58   * `stkstring.h`
  59   * `string.h`
  60   * `str-match.h`
  61   * `wildmatch.h`
  62 - File manipulation
  63   * `asio.h`
  64   * `lfs.h`
  65   * `partmap.h`
  66 - Address manipulation
  67   * `url.h`
  68   * `ipaccess.h`
  69 - Prefetching of memory
  70   * `prefetch.h`
  71 - Caches
  72   * `qache.h`
  73 - Threads
  74   * `semaphore.h`
  75   * `threads.h`
  76   * `workqueue.h`
  77 - Profiling support
  78   * `profile.h`
  79
  80 License
  81 -------
  82 The UCW library is copyrighted by its authors:
  83
  84 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  85 - Martin Mareš <mailto:mj\@ucw.cz[]>
  86 - Robert Špalek <mailto:robert\@ucw.cz[]>
  87 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  88
  89 It can be freely distributed and used according to the terms of
  90 the GNU Lesser General Public License.