libROB

Readme

2005-01-07
Turku PET Centre

LibROB is distributed under the GNU Lesser General Public Licence
http://www.turkupetcentre.net/programs/lgpl-license.html
More information on open source licences: http://www.opensource.org

Description
------------------------

The LibROB library is a collection of functions used in robust estimation.

List of files
------------------------

include/     -	Includes all the .h files for the .c files

makefile     -	The makefile.

history      -  Change history

README       -  This file

 .C files **

librobv.c    -  For displaying compilation time of this library.

lms.c        -  Calculation of least meadian of squares estimate and related functions.

lts.c        -  Calculation of least trimmed square estimate and related functions.

median.c     -  Calculation of median and related functions.

Installation
------------------------

To compile, just type 'make'. No modifications should be necessary to the Makefile.
The compiled library is kept in /usr/local/lib and the header files in /usr/local/include.

Using the library
------------------------

The program that uses the library should include the .h file it needs
eg. #include <median.h>
To compile, link the library with -lrob
If the library and/or the .h files are outside normal compiler search path,
add these lines when compiling
-L<path to="" library="">  eg. -L/usr/local/lib
-I<path to .h files> eg. -I/usr/local/include

Extending the library
------------------------

To add new files to the library, first copy the .c file(s) to the librob directory
and the .h file(s) to the librob/include directory.
Modify the C file if necessary.
Add the .c file(s) to the Makefile's CFILES line.
Then just recompile and copy the librob.a to its place.
PLEASE update the README and HISTORY file to include the new .c file !

---