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 Yet undocumented modules
  25 ------------------------
  26 - Sorting
  27   * `arraysort.h`
  28   * `sorter/`
  29 - Growing buffers
  30   * `gbuf.h`
  31   * `bbuf.h`
  32 - Heaps
  33   * `binheap.h`
  34   * `binheap-node.h`
  35   * `heap.h`
  36 - Binary search
  37   * `binsearch.h`
  38 - Bit manipulation
  39   * `bitarray.h`
  40   * `bitopts.h`
  41   * `bitsig.h`
  42 - Character manipulation
  43   * `char-map.h`
  44   * `chartype.h`
  45   * `unicode.h`
  46 - Link lists
  47   * `clists.h`
  48   * `simple-lists.h`
  49   * `slists.h`
  50 - Fixed-sized allocator
  51   * `eltpool.h`
  52 - Hash tables
  53   * `hashtable.h`
  54 - IP address access lists
  55   * `ipaccess.h`
  56 - String manipulation
  57   * `kmp.h`
  58   * `kmp-search.h`
  59   * `regex.h`
  60   * `stkstring.h`
  61   * `string.h`
  62   * `str-match.h`
  63   * `wildmatch.h`
  64 - File manipulation
  65   * `asio.h`
  66   * `lfs.h`
  67   * `partmap.h`
  68 - Compression
  69   * `lizard.h`
  70 - Prefetching of memory
  71   * `prefetch.h`
  72 - Primes
  73   * `prime.h`
  74 - Profiling support
  75   * `profile.h`
  76 - Caches
  77   * `qache.h`
  78 - Red-black trees
  79   * `redblack.h`
  80 - Threads
  81   * `semaphore.h`
  82   * `threads.h`
  83   * `workqueue.h`
  84 - Trie
  85   * `trie.h`
  86 - Unaligned data
  87   * `unaligned.h`
  88 - URL manipulation
  89   * `url.h`
  90
  91 Other features
  92 --------------
  93 - <<docsys:,Documentation system>>
  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.