CONTENTS:	IT++ version 4.0.2

DESCRIPTION:	IT++ is a C++ library of mathematical, signal processing,
		speech processing and communications classes and functions.
		The kernel of the IT++ library consists of templated vector 
		and matrix classes, and many functions for vectors and
		matrices; this makes the library functionality similar
		to that of MATLAB.

		IT++ makes extensive use of routines in the BLAS, 
		LAPACK and FFTW libraries, and versions of these are also
		installed in this locker. IT++ will use routines from these
		automatically as needed.

HOW TO RUN:

  COMMAND:	add itpp
		setenv ITPP_VERSION 4.0.2 (to use version 4.0.2, or other 
                version)
		source /mit/itpp_v4.0.2/cshrc (to use default version, if 
		ITPP_VERSION is not defined)
                
		itpp-config <options> (to get version number and build flags)

		see file /mit/itpp_v4.0.2/README.to-run and comments in
		file example.cpp for compiling and linking info

NOTE: due to API compatibility issues, you will most likely need to compile 
      with a g++ 3.4 release to be able to use the libraries in this locker.

  DASH:		no

INTERFACES:	none

VERSIONS:	IT++ version 4.0.2 for Sun and Linux (in this locker)

DEPENDENCIES:	BLAS, LAPTACK, FFTW libraries (installed in locker)

DATAFILES:	platform-independent

LICENSE SERVER:	none

------------------------------------------------------------------------

SUPPORT ISSUES

I/S SUPPORT:

  CONSULTING:	None

  TRAINING:	None

  DOCUMENTATION: READMEs in /mit/itpp_v4.0.2; local documentation copy
                 starting from 
http://web.mit.edu/itpp_v4.0.2/doc/itpp-html-doc-4.0.2/index.html

NOTE: search functionality not enabled but you can get to a searchable
copy on the Web at http://itpp.sourceforge.net/current/

OTHER SUPPORT:

  WEB PAGE:	http://itpp.sourceforge.net

  CONSULTING:	None

  TRAINING:	None

  DOCUMENTATION: None besides what is available online. 

BUG REPORTS:	Send bug reports to bugs@mit.edu via the "sendbug" 
		command on Athena, and be sure to indicate which version 
		of IP++ you were using.

------------------------------------------------------------------------

LEGAL ISSUES

Freely distributable under the GNU GPL

STATUS:		Open source product under GPL

SITES:		Unlimited

------------------------------------------------------------------------

ABOUT THIS LOCKER

MAINTAINERS:	alexp, 3partysw (group)

DIRECTORY STRUCTURE:


  arch		shared scripts, symlinks to platform-dependent binaries
  bin		symlink to platform-dependent binary directory
  cshrc		C shell script to be sourced that sets paths for compiling
		and linking
  doc		html documentation
  example.cpp   simple example
  include	header files
  info          info pages
  lib		symlink to platform-dependent library directory
  man		man pages
  share		misc files, including .m files for I/O from Matlab to IT++ 
                itfiles
  src		source code

MODIFY HISTORY:	2/26/08
		Alex Prengel did initial locker setup, wrote this README
		
MISCELLANEOUS:	

The Sun libraries are 64 bit- you will need to use the -mcpu=v9 -m64
compiler flags to build compatible applications; use of the build
compilers is recommended (see below).

File /mit/itpp_v4.0.2/example.cpp is a simple example with comments
that explain how to build it.

Both dynamic and static libraries are available for both
platforms. itpp-config is set up for dynamic linking, but you can link
statically by replacing library calls to libraries in the
/mit/itpp_v4.0.2 locker by the full path to the static equivalent,
i.e. for example replace -litpp by /mit/itpp_v4.0.2/lib/libitpp.a in
your link line (and so on).

Compilers used to build IT++ 4.0.2: 

Sun: gcc/g++/g77 in gcc-3.4 locker:

gcc version 3.4.4

Linux: default  gcc/g++/g77 in Athena 9.4 release:

gcc version 3.4.6 20060404 (Red Hat 3.4.6-9)

NOTE: the Sun version fails the following checks:

vec_test
ldpc_test
pulse_shape_test
modulator_nd_test
filter_test
window_test
fastica_test
filter_design_test

Please test your results carefully if using the Sun version, or use the
Linux version insted.