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