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 - <<basics:,Basics>>
  18 - <<log:,Logging>>
  19 - <<fastbuf:,Fastbufs>>
  20 - <<basecode:,Base64 and Base224 encoding>>
  21 - <<hash:,Hashing routines>>
  22 - <<conf:,Configuration and command line parser>>
  23 - <<mempool:,Memory pools>>
  24 - <<eltpool:,Fixed-sized allocators>>
  25 - <<mainloop:,Mainloop>>
  26 - <<unaligned:,Unaligned data>>
  27 - <<lists:,Link lists>>
  28 - <<heap:,Binary heaps>>
  29 - <<binheap:,Binomial heaps>>
  30 - <<hashtable:,Hash tables>>
  31 - <<growbuf:,Growing buffers>>
  32 - <<chartype:,Single-byte characters>>
  33 - <<unicode:,Multi-byte characters>>
  34 - <<prime:,Prime numbers>>
  35 - <<sort:,Sorting>>
  36 - <<binsearch:,Binary search>>
  37 - <<compress:,Compression>>
  38 - <<trans:,Transactions and resource tracking>>
  39 - <<string:,String operations>>
  40
  41 Other features
  42 --------------
  43 - <<configure:,Compile time configuration>>
  44 - <<config:,Configuration file syntax>>
  45 - <<docsys:,Documentation system>>
  46 - <<generic:,Macro-generated generics>>
  47 - <<relnotes:,Release notes>>
  48
  49 Yet undocumented modules
  50 ------------------------
  51 - Allocators
  52   * `gary.h`
  53 - Trie
  54   * `trie.h`
  55 - Red-black trees
  56   * `redblack.h`
  57 - Bit manipulation
  58   * `bitarray.h`
  59   * `bitopts.h`
  60   * `bitsig.h`
  61 - String manipulation
  62   * `kmp.h`
  63   * `kmp-search.h`
  64   * `regex.h`
  65   * `stkstring.h`
  66   * `strtonum.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 - Prefetching of memory
  76   * `prefetch.h`
  77 - Caches
  78   * `qache.h`
  79 - Threads
  80   * `semaphore.h`
  81   * `threads.h`
  82   * `workqueue.h`
  83 - Profiling support
  84   * `profile.h`
  85
  86 License
  87 -------
  88 The UCW library is copyrighted by its authors:
  89
  90 - Pavel Charvát <mailto:pchar\@ucw.cz[]>
  91 - Martin Mareš <mailto:mj\@ucw.cz[]>
  92 - Robert Špalek <mailto:robert\@ucw.cz[]>
  93 - Michal Vaner <mailto:vorner\@ucw.cz[]>
  94
  95 It can be freely distributed and used according to the terms of
  96 the GNU Lesser General Public License.