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 - <<growbuf:,Growing buffers>>
  27 - <<chartype:,Single-byte characters>>
  28 - <<unicode:,Multi-byte characters>>
  29 - <<prime:,Prime numbers>>
  30
  31 Other features
  32 --------------
  33 - <<configure:,Compile time configuration>>
  34 - <<config:,Configuration file syntax>>
  35 - <<docsys:,Documentation system>>
  36 - <<generic:,Macro-generated generics>>
  37
  38 Yet undocumented modules
  39 ------------------------
  40 - Sorting
  41   * `sorter/`
  42 - Binary search
  43   * `binsearch.h`
  44 - Heaps
  45   * `binheap.h`
  46   * `binheap-node.h`
  47   * `heap.h`
  48 - Hash tables
  49   * `hashtable.h`
  50 - Trie
  51   * `trie.h`
  52 - Red-black trees
  53   * `redblack.h`
  54 - Bit manipulation
  55   * `bitarray.h`
  56   * `bitopts.h`
  57   * `bitsig.h`
  58 - String manipulation
  59   * `kmp.h`
  60   * `kmp-search.h`
  61   * `regex.h`
  62   * `stkstring.h`
  63   * `string.h`
  64   * `str-match.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 - Compression
  76   * `lizard.h`
  77 - Caches
  78   * `qache.h`
  79 - Threads
  80   * `semaphore.h`
  81   * `threads.h`
  82   * `workqueue.h`
  83 - Profiling support
  84   * `profile.h`
  85
  86 License
  87 -------
  88 The UCW library is copyrighted by its authors:
  89
  90 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  91 - Martin Mareš <mailto:mj\@ucw.cz[]>
  92 - Robert Špalek <mailto:robert\@ucw.cz[]>
  93 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  94
  95 It can be freely distributed and used according to the terms of
  96 the GNU Lesser General Public License.