• Stars
    star
    1,082
  • Rank 41,147 (Top 0.9 %)
  • Language
    C++
  • License
    Other
  • Created over 5 years ago
  • Updated 11 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

COIN-OR Interior Point Optimizer IPOPT

Ipopt

Introduction

Ipopt (Interior Point OPTimizer, pronounced eye-pea-Opt) is a software package for large-scale nonlinear optimization. It is designed to find (local) solutions of mathematical optimization problems of the form

$$\begin{align} \min_{x \in R^n}\ & f(x), \\ \text{s.t.}\ & g_L \le g(x) \le g_U, \\ & x_L \le x \le x_U, \end{align}$$

where $f: R^n \rightarrow R$ is the objective function, and $g: R^n \rightarrow R^m$ are the constraint functions. The vectors $g_L$ and $g_U$ denote the lower and upper bounds on the constraints, and the vectors $x_L$ and $x_U$ are the bounds on the variables $x$. The functions $f(x)$ and $g(x)$ can be nonlinear and nonconvex, but should be twice continuously differentiable. Note that equality constraints can be formulated in the above formulation by setting the corresponding components of $g_L$ and $g_U$ to the same value.

Ipopt is part of the COIN-OR Initiative. The Ipopt project webpage is https://github.com/coin-or/Ipopt.

Background

Ipopt is written in C++ and is released as open source code under the Eclipse Public License (EPL). The code has been written by Andreas Wächter and Carl Laird. The COIN-OR project managers for Ipopt are Andreas Wächter und Stefan Vigerske. For a list of all contributors, see the AUTHORS file.

The C++ version has first been released on Aug 26, 2005 as version 3.0.0. The previously released pre-3.0 Fortran version is no longer maintained.

The Ipopt distribution can be used to generate a library that can be linked to one's own C++, C, Fortran, or Java code, as well as a solver executable for the AMPL modeling environment. The package includes an interface to the R programming environment. IPOPT can be used on Linux/UNIX, macOS, and Windows platforms.

As open source software, the source code for Ipopt is provided without charge. You are free to use it, also for commercial purposes. You are also free to modify the source code (with the restriction that you need to make your changes public if you decide to distribute your version in any way, e.g. as an executable); for details see the EPL license. And we are certainly very keen on feedback from users, including contributions!

In order to compile Ipopt, certain third party code is required (such as some linear algebra routines). Those are available under different conditions/licenses.

If you want to learn more about Ipopt, you can find references in the bibliography of the documentation.

For information on projects or papers that use Ipopt, refer to the Ipopt usage stories and papers discussion.

Getting Started

Please consult the detailed installation instructions in the Ipopt documentation. In the following, we only summarize some main points.

Dependencies

Ipopt requires at least one of the following solvers for systems of linear equations:

A fast implementation of BLAS and LAPACK is required by Ipopt.

To build the AMPL interface of Ipopt, the AMPL Solver Library (ASL) is required. It is recommended to use project ThirdParty-ASL to build a ASL library for use by Ipopt.

Build

After installation of dependencies, an Ipopt build and installation follows these 4 steps:

  1. Run ./configure. Use ./configure --help to see available options.

  2. Run make to build the Ipopt libraries. If ASL was made available, also Ipopt executables will be build.

  3. Run make test to test the Ipopt build.

  4. Run make install to install Ipopt (libraries, executables, and header files).

It is suggested to use the same installation prefix (--prefix option of configure) when configuring the build of ThirdParty-ASL, ThirdParty-HSL, ThirdParty-MUMPS, and Ipopt.

Using coinbrew

An alternative to the above steps is to use the coinbrew script from https://coin-or.github.io/coinbrew/. coinbrew automates the download of the source code for ASL, MUMPS, and Ipopt and the sequential build and installation of these three packages.

After obtaining the coinbrew script, run

/path/to/coinbrew fetch Ipopt --no-prompt
/path/to/coinbrew build Ipopt --prefix=/dir/to/install --test --no-prompt --verbosity=3
/path/to/coinbrew install Ipopt --no-prompt

More details on using coinbrew can be found at the instructions on Getting Started with the COIN-OR Optimization Suite.

Precompiled binaries

Some precompiled binaries of Ipopt are also available:

Getting Help

  • Ipopt Documentation with installation instructions, options reference, and more
  • Issue tracking system: If you believe you found a bug in the code, please use the issue tracking system. Please include as much information as possible, and if possible some (ideally simple) example code so that we can reproduce the error.
  • Discussions: ask questions, share ideas, engage with the Ipopt community
  • Mailing list archive (2002-2020): predecessor of Discussions
  • External resources:

Please Cite Us

We provide this program in the hope that it may be useful to others, and we would very much like to hear about your experience with it. If you found it helpful and are using it within our software, we encourage you to add your feedback to the Ipopt usage stories and papers discussion.

Since a lot of time and effort has gone into Ipopt's development, please cite the following publication if you are using Ipopt for your own research:

Versioning

Ipopts version numbers have the form x.y.z. x.y specifies the major and minor version number of Ipopt. An increase in x or y can mean the addition or removal of features, backward-incompatible API changes, etc. Increases in y indicate less severe changes than increases in x. For example, the change from Ipopt 2 to Ipopt 3 came due to a complete rewrite of Ipopt in a different programming language. z specifies the release number of Ipopt. An increase in z usually means bugfixes or additions of small feature. Changes to the API, if any, are done in a backward-compatible way. However, the ABI may changed in a backward-incompatible way.

Source code is organized in branches named stable/x.y. Development towards a next x.y.z release is happening on the stable/x.y branch. The code on branch stable/x.y already caries a x.y.z version number, which can correspond to the next x.y.z release that will be made from this branch. The default branch of the repository is the latest stable/x.y branch, even if x.y is still in beta testing.

An Ipopt x.y.z release is associated with a tag releases/x.y.z on branch stable/x.y. Releases are fixed and don't change.

Additional branches may exist where development of bugfixes or features is taking place. A branch devel may collect development for the next Ipopt x.y version. It will be renamed to stable/x.y when it is considered stable enough for beta testing.

If you want to contribute a bugfix or small feature, please create a pull-request to the latest stable/x.y branch. If you want to contribute a larger feature or something else that changes the API, please create a pull-request to branch devel, if existing, and latest stable/x.y otherwise.

More Repositories

1

pulp

A python Linear Programming API
Python
1,933
star
2

Cbc

COIN-OR Branch-and-Cut solver
C++
620
star
3

python-mip

Python-MIP: collection of Python tools for the modeling and solution of Mixed-Integer Linear programs
Python
495
star
4

CppAD

A C++ Algorithmic Differentiation Package: Home Page
C++
375
star
5

Clp

COIN-OR Linear Programming Solver
C++
321
star
6

qpOASES

Open-source C++ implementation of the recently proposed online active set strategy
C++
261
star
7

rbfopt

RBFOpt library for black-box optimization
Python
181
star
8

CyLP

A Python interface to CLP, CBC, and CGL to solve LPs and MIPs.
JetBrains MPS
175
star
9

Gravity

Mathematical Modeling for Optimization and Machine Learning
C++
143
star
10

SHOT

A solver for mixed-integer nonlinear optimization problems
C++
109
star
11

COIN-OR-OptimizationSuite

A harness for building the bundled suite of interoperable optimization tools available in the COIN-OR repository.
Shell
105
star
12

Bonmin

Basic Open-source Nonlinear Mixed INteger programming
C++
103
star
13

ADOL-C

A Package for Automatic Differentiation of Algorithms Written in C/C++
C++
94
star
14

Cbc.old

This is a mirror of the subversion repository on COIN-OR
C++
88
star
15

minotaur

Minotaur Toolkit for Mixed-Integer Nonlinear Optimization
C++
65
star
16

GrUMPy

A Python library for visualizing algorithms for solving mathematical optimization problems.
Shell
60
star
17

SYMPHONY

SYMPHONY is an open-source solver, callable library, and development framework for mixed-integer linear programs (MILPs) written in C with a number of unique features
C
59
star
18

Couenne

Convex Over and Under Envelopes for Nonlinear Estimation
C++
55
star
19

jorlib

Java Operations Research Library
Java
54
star
20

Csdp

This is the working repository for the CSDP project. CSDP is a solver for semidefinite programming problems. It is a COIN-OR project.
C
52
star
21

Osi

Open Solver Interface
C++
48
star
22

MibS

A solver for mixed integer bilevel programs
JetBrains MPS
47
star
23

Rehearse

Algebraic modeling library in C++ for linear optimization solvers
M4
42
star
24

CoinUtils

COIN-OR Utilities
C++
42
star
25

Clp.old

This a mirror of the subversion repository on COIN-OR.
C++
36
star
26

prtpy

Number partitioning in Python
Python
36
star
27

GiMPy

A graph library containing pure Python implementations of a variety of graph algorithms
Python
33
star
28

coinbrew

COIN-OR build and installation script
Shell
26
star
29

metslib

An Open Source Tabu Search Metaheuristic framework in C++
C++
25
star
30

Bcp

Branch-Cut-Price Framework
C++
24
star
31

Cgl

Cut Generator Library
C++
21
star
32

VRPH

VRPH is an open source library of heuristics for the capacitated Vehicle Routing Problem (VRP).
C++
19
star
33

SYMPHONY.old

This a mirror of the subversion repository on COIN-OR.
C
16
star
34

Dip

DIP is a decomposition-based solver framework for mixed integer linear programs.
C++
15
star
35

Osi.old

This a mirror of the subversion repository on COIN-OR.
C++
11
star
36

Sonnet

A wrapper for COIN-OR mixed integer linear programming via OSI to Microsoft .NET
C#
10
star
37

Dip.old

This a mirror of the subversion repository on COIN-OR.
C++
10
star
38

CoinMP

C-API library for CLP, CBC, and CGL
Shell
9
star
39

Cmpl

<Coliop|Coin> Mathematical Programming Language
C++
9
star
40

CHiPPS-ALPS

This is the Abstract Library for Parallel Search (ALPS), the abstract base layer of the COIN-OR High Performance Parallel Search framework.
C++
8
star
41

FlopCpp

An open source algebraic modelling language implemented as a C++ class library
Shell
8
star
42

oBB

Overlapping Branch and Bound Algorithm
C++
8
star
43

GAMSlinks

Links between GAMS (General Algebraic Modeling System) and solvers
C++
8
star
44

DisCO

Discrete Conic Optimization Solver
C++
7
star
45

filterSD

a library for nonlinear optimization written in Fortran
Fortran
7
star
46

CoinUtils.old

This a mirror of the subversion repository on COIN-OR.
C++
7
star
47

Paver

Python scripts to do comparisons on solver performance
Python
7
star
48

Vol

A C++ implementation of the volume algorithm for linear programming
Shell
7
star
49

Couenne.old

This a mirror of the subversion repository on COIN-OR. For bugtracking and wiki, see website.
C++
7
star
50

CHiPPS-BLIS

This is the BiCePS Linear Integer Solver (BLIS), a parallel solver for mixed integer linear programs that is implemented on top of the BiCePS layer of the CHiPPS framework.
C++
6
star
51

jMarkov

Java framework for Markov-chain (MC) modelling
Java
5
star
52

yaposib

Python binding to coin-osi
C++
5
star
53

metslib-examples

Examples for METSLib
C++
4
star
54

Cgl.old

This a mirror of the subversion repository on COIN-OR.
C++
4
star
55

ROSE

Reformulation-Optimization Software Engine
C++
3
star
56

Smi

An API for stochastic programming problems.
Shell
3
star
57

DyLP

Dynamic Simplex solver
C
2
star
58

CoinMP.old

Mirror of the CoinMP project from https://projects.coin-or.org/svn/CoinMP
Shell
2
star
59

Osi2

Open Solver Interface Version 2
C++
1
star
60

MOCHA

Algorithms and heuristics to solve multicriteria matroid optimization problems
M4
1
star
61

Cgc

Cgc is a collection of network representations to facilitate the development and implementation of network algorithms.
C++
1
star
62

OS

Optimization Services
C++
1
star
63

coin-or.github.io

COIN-OR General Documentation
HTML
1
star
64

PFunc

Generic task-parallel library for C/C++
C++
1
star
65

NLPAPI

NLPAPI is a set of subroutines and data structures for defining nonlinear programming problems. It includes an interface to call LANCELOT to solve the problem (you need to get your own copy of LANCELOT), and an interface to IPOPT.
C
1
star