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