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