Learn how easy it is to sync an existing GitHub or Google Code repo to a SourceForge project! See Demo

Close

Diff of /src/foreign/levmar/README.txt [000000] .. [efa19d] Maximize Restore

  Switch to side-by-side view

--- a
+++ b/src/foreign/levmar/README.txt
@@ -0,0 +1,51 @@
+    **************************************************************
+                                LEVMAR
+                              version 2.1.3
+                          By Manolis Lourakis
+
+                     Institute of Computer Science
+            Foundation for Research and Technology - Hellas
+                       Heraklion, Crete, Greece
+    **************************************************************
+
+
+GENERAL
+This is levmar, a copylefted C/C++ implementation of the Levenberg-Marquardt non-linear
+least squares algorithm. levmar includes double and single precision LM versions, both
+with analytic and finite difference approximated jacobians. levmar also has some support
+for constrained non-linear least squares, allowing linear equation and box constraints.
+You have the following options regarding the solution of the underlying augmented normal
+equations:
+
+1) Assuming that you have LAPACK (or an equivalent vendor library such as ESSL, MKL,
+   NAG, ...) installed, you can use the included LAPACK-based solvers (default).
+
+2) If you don't have LAPACK or decide not to use it, undefine HAVE_LAPACK in lm.h
+   and a LAPACK-free, LU-based linear systems solver will by used.
+
+It is strongly recommended that you *do* employ LAPACK; if you don't have it already,
+I suggest getting clapack from http://www.netlib.org/clapack. However, LAPACK's
+use is not mandatory and the 2nd option makes levmar totally self-contained.
+See lmdemo.c for examples of use and http://www.ics.forth.gr/~lourakis/levmar
+for general comments.
+
+The mathematical theory behind levmar is described in the lecture notes entitled
+"Methods for Non-Linear Least Squares Problems", by K. Madsen, H.B. Nielsen and O. Tingleff,
+Technical University of Denmark (http://www.imm.dtu.dk/courses/02611/nllsq.pdf). 
+
+
+COMPILATION
+ - On a Linux/Unix system, typing "make" will build both levmar and the demo
+   program using gcc. Alternatively, if Intel's C++ compiler is installed, it
+   can be used by typing "make -f Makefile.icc".
+
+ - Under Windows and if Visual C is installed & configured for command line
+   use, type "nmake /f Makefile.vc" in a cmd window to build levmar and the
+   demo program. In case of trouble, read the comments on top of Makefile.vc
+
+Notice that *_core.c files are not to be compiled directly; For example,
+Axb_core.c is included by Axb.c, to provide single and double precision
+routine versions.
+
+
+Send your comments/bug reports to lourakis@ics.forth.gr