chiark / gitweb /
octave4.4
[nlopt.git] / README
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.  To
17 build the latest development sources:
18
19     git clone git://github.com/stevengj/nlopt
20     cd nlopt
21     sh autogen.sh
22     make
23
24 (To build from git, you will need GNU autoconf, automake, and libtool
25 installed, along with SWIG and Unix tools such as m4, perl, and sed.)
26
27 Once it is installed, `#include <nlopt.h>` in your C/C++ programs and
28 link it with `-lnlopt -lm`.  You may need to use the C++ compiler to link
29 in order to include the C++ libraries (which are used internally by NLopt,
30 even though it has a C API).
31
32 The minimization function, `nlopt_minimize`, is described in the [man
33 page](http://en.wikipedia.org/wiki/Man_page) (`api/nlopt_minimize.3`,
34 which is installed by `make install`.  See also the manual on our
35 web page.
36
37 There are also interfaces for Fortran, Python, Matlab, Octave, OCaml,
38 GNU Guile, GNU R, Lua, and Julia.  Interfaces for other languages may
39 be added in the future.