Extras/simdmathlibrary/README

   1                           SIMD math library
   2
   3
   4 * Overview
   5
   6   The SIMD math library (SIMD math lib) is a SIMDized version of the
   7   C99 standard math library (libm).
   8
   9
  10 * License
  11
  12   This library is licensed under the terms in the file 'LICENSE' in
  13   this directory.
  14
  15
  16 * Installing
  17
  18   To install this library, run following commands:
  19
  20   - 32 bit mode PowerPC with VMX
  21
  22     $ make ARCH=ppu
  23     $ make ARCH=ppu install
  24
  25   - 64 bit mode PowerPC with VMX
  26
  27     $ make ARCH=ppu64
  28     $ make ARCH=ppu64 install
  29
  30   - SPU (Cell Broadband Engine Synergistic Processor Unit)
  31
  32     $ make ARCH=spu
  33     $ make ARCH=spu install
  34
  35   The same library is created and installed for SPU regardless of
  36   PPU's mode.
  37
  38
  39   By default, files in the library will be placed as below:
  40
  41   - libraries (except SPU library)
  42
  43     /usr/lib/libsimdmath.a             (static library)
  44     /usr/lib/libsimdmath.so            (shared library)
  45
  46   - headers (except SPU headers)
  47
  48     /usr/lib/simdmath.h                 (main header)
  49     /usr/lib/simdmath/<FUNCTION>.h      (header of inline version)
  50
  51   - SPU library
  52
  53     /usr/spu/lib/libsimdmath.a (static library)
  54     (no shared library for SPU)
  55
  56   - SPU headers
  57
  58     /usr/spu/lib/simdmath.h             (main header)
  59     /usr/spu/lib/simdmath/<FUNCTION>.h  (header of inline version)
  60
  61
  62 * Packaging
  63
  64   By running following command in this directory, a source tarball
  65   'simdmath-<VERSION>.tar.gz' can be created:
  66
  67     $ make dist
  68
  69   You can also create RPM packages by executing the command below with
  70   the tarball:
  71
  72     $ rpmbuild -tb simdmath-1.0.1.tar.gz --target=ppc
  73
  74   Three packages, simdmath, simdmath-devel and spu-simdmath-devel,
  75   will be created.
  76
  77
  78 * Quick start
  79
  80   - Including headers
  81
  82     You must include the header simdmat.h in your source code, as
  83     following:
  84
  85     e.g.)
  86
  87       #include <simdmath.h>
  88
  89     If you want to use inlined version of the functions, you need to
  90     include simdmath/<FUNCTION>.h instead of simdmath.h:
  91
  92     e.g.)
  93
  94       #include <simdmath/sinf4.h>
  95
  96   - Linking with library
  97
  98     If you use non-inlined version of the library, you need to link
  99     the library libsimdmath.a or libsimdmath.so:
 100
 101     e.g.)
 102
 103       $ gcc -o foo foo.o -lsimdmath
 104       $ spu-gcc -o bar bar.o -lsimdmath
 105
 106   - Function reference
 107
 108     To obtain details about each function in this library, the
 109     specification document "SIMD Math Library Specification for Cell
 110     Broadband Engine Architecture" is avaiable at
 111     "http://cell.scei.co.jp/".
 112
 113     Note that the name of each inlined version of function is prefixed
 114     by a character '_' against the corresponding non-inlined one.
 115
 116
 117 * Contacting the project
 118
 119   Module maintainer: Erwin Coumans
 120
 121   Feedback and patches:
 122     http://www.bulletphysics.com/Bullet/phpBB2/viewforum.php?f=18
 123
 124   Main repository URL:
 125     http://bullet.svn.sourceforge.net/viewvc/bullet/trunk/Extras/simdmathlibrary
 126
 127 ---
 128 EOF