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 - <<mainloop:,Mainloop>>
  23
  24 Other features
  25 --------------
  26 - <<configure:,Compile time configuration>>
  27 - <<config:,Configuration file syntax>>
  28 - <<docsys:,Documentation system>>
  29
  30 Yet undocumented modules
  31 ------------------------
  32 - Sorting
  33   * `sorter/`
  34 - Binary search
  35   * `binsearch.h`
  36 - Primes
  37   * `prime.h`
  38 - Growing buffers
  39   * `gbuf.h`
  40   * `bbuf.h`
  41 - Heaps
  42   * `binheap.h`
  43   * `binheap-node.h`
  44   * `heap.h`
  45 - Link lists
  46   * `clists.h`
  47   * `simple-lists.h`
  48   * `slists.h`
  49 - Hash tables
  50   * `hashtable.h`
  51 - Trie
  52   * `trie.h`
  53 - Red-black trees
  54   * `redblack.h`
  55 - Bit manipulation
  56   * `bitarray.h`
  57   * `bitopts.h`
  58   * `bitsig.h`
  59 - Character manipulation
  60   * `char-map.h`
  61   * `chartype.h`
  62   * `unicode.h`
  63 - String manipulation
  64   * `kmp.h`
  65   * `kmp-search.h`
  66   * `regex.h`
  67   * `stkstring.h`
  68   * `string.h`
  69   * `str-match.h`
  70   * `wildmatch.h`
  71 - File manipulation
  72   * `asio.h`
  73   * `lfs.h`
  74   * `partmap.h`
  75 - Address manipulation
  76   * `url.h`
  77   * `ipaccess.h`
  78 - Fixed-sized allocator
  79   * `eltpool.h`
  80 - Prefetching of memory
  81   * `prefetch.h`
  82 - Unaligned data
  83   * `unaligned.h`
  84 - Compression
  85   * `lizard.h`
  86 - Caches
  87   * `qache.h`
  88 - Threads
  89   * `semaphore.h`
  90   * `threads.h`
  91   * `workqueue.h`
  92 - Profiling support
  93   * `profile.h`
  94
  95 License
  96 -------
  97 The UCW library is copyrighted by its authors:
  98
  99 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
 100 - Martin Mareš <mailto:mj\@ucw.cz[]>
 101 - Robert Špalek <mailto:robert\@ucw.cz[]>
 102 - Michal Vaner <mailto:vorner\@ucw.cz[]>
 103
 104 It can be freely distributed and used according to the terms of
 105 the GNU Lesser General Public License.