Optimist

Optimist is a library for the numerical solution of optimization problems and zero-finding problems. It is based on the Eigen library and written in C++17.

Are you looking for the online documentation? Visit this link!

Installation

Quick and dirty

Optimist is a header-only library that depends only on Eigen (version >= 3.4.0), so the quick and dirty way of installing it is by simply copying the include directory to your project and make sure to have Eigen available however you see fit. Alternatively, you can do things properly and use CMake (version >= 3.14).

Optionally, you can also install Matplot++ (version >= 1.2.0) to plot the results of your simulations.

CMake

If you are using CMake, you can add the library as a subdirectory in your project.

add_subdirectory(path/to/Optimist)
target_link_libraries(your_target PRIVATE Optimist::Optimist)

You can use FetchContent to download the library from GitHub.

include(FetchContent)
 
# Optionally specify a custom path to fetch content to
set(FETCHCONTENT_BASE_DIR "path/to/your/dependencies")
fetchcontent_declare(
  Optimist
  GIT_REPOSITORY https://github.com/StoccoDavide/Optimist.git
  GIT_TAG        main
)
fetchcontent_makeavailable(Optimist)
target_link_libraries(your_target PRIVATE Optimist::Optimist)

If you already have Optimist somewhere on your system, you can use find_pacakge directly.

# Optionally specify a custom path to find content from
list(APPEND CMAKE_PREFIX_PATH "path/to/your/dependencies")
find_package(
  Optimist
  ${YOUR_DESIRED_OPTIMIST_VERSION}
  NO_MODULE
)
 
target_link_libraries(your_target PRIVATE Optimist::Optimist)

Since we are nice people, we also show you how to conditionally use FetchContent based if you already have the library or not.

# Optionally specify a custom path to find content from
list(APPEND CMAKE_PREFIX_PATH "path/to/your/dependencies")
find_package(
  Optimist
  ${YOUR_DESIRED_OPTIMIST_VERSION}
  NO_MODULE
)
 
if(NOT TARGET Optimist::Optimist)
  include(FetchContent)
 
  # Optionally specify a custom path to fetch content to
  set(FETCHCONTENT_BASE_DIR "path/to/your/dependencies")
  fetchcontent_declare(
    Optimist
    GIT_REPOSITORY https://github.com/StoccoDavide/Optimist.git
    GIT_TAG        main
  )
 
  fetchcontent_makeavailable(Optimist)
endif()
 
target_link_libraries(your_target PRIVATE Optimist::Optimist)

Authors

• Davide Stocco
  University of Trento
  Department of Industrial Engineering
  email: david.nosp@m.e.st.nosp@m.occo@.nosp@m.unit.nosp@m.n.it
• Mattia Piazza
  University of Trento
  Department of Industrial Engineering
  email: matti.nosp@m.a.pi.nosp@m.azza@.nosp@m.unit.nosp@m.n.it
• Enrico Bertolazzi
  University of Trento
  Department of Industrial Engineering
  email: enric.nosp@m.o.be.nosp@m.rtola.nosp@m.zzi@.nosp@m.unitn.nosp@m..it

License

The Optimist project is distributed under the BSD 2-Clause License - see the LICENSE file for details.

Here's what the license entails:

1. Anyone can copy, modify and distribute this software.
2. You have to include the license and copyright notice with each and every distribution.
3. You can use this software privately.
4. You can use this software for commercial purposes.
5. This software is provided without warranty.
6. The software author or license can not be held liable for any damages inflicted by the software.