chiark / gitweb /
tweak
[nlopt.git] / README.md
1 NLopt is a library for nonlinear local and global optimization, for
2 functions with and without gradient information.  It is designed as
3 as simple, unified interface and packaging of several free/open-source
4 nonlinear optimization libraries.
5
6 The latest release and a complete manual may be found at the NLopt
7 home page: http://ab-initio.mit.edu/nlopt
8
9 It is compiled and installed with the standard GNU autoconf/automake
10 commands:
11
12         ./configure
13         make
14         make install
15
16 (See `./configure --help` or the `INSTALL` file for other options.)
17
18 Once it is installed, `#include <nlopt.h>` in your C/C++ programs and
19 link it with `-lnlopt -lm`.  You may need to use the C++ compiler to link
20 in order to include the C++ libraries (which are used internally by NLopt,
21 even though it has a C API).
22
23 The minimization function, `nlopt_minimize`, is described in the [man
24 page](http://en.wikipedia.org/wiki/Man_page) (`api/nlopt_minimize.3`,
25 which is installed by `make install`.
26
27 There are also interfaces for Fortran, Python, Matlab, Octave, OCaml,
28 GNU Guile, GNU R, Lua, and Julia.  Interfaces for other languages may
29 be added in the future.