Skip to main content

A flexible implementation of the adaptive large neighbourhood search (ALNS) algorithm.

Project description

PyPI version Build Status codecov Codacy Badge

This package offers a general, well-documented and tested implementation of the adaptive large neighbourhood search (ALNS) meta-heuristic, based on the description given in Pisinger and Ropke (2010). It may be installed in the usual way as,

pip install alns

How to use

The alns package exposes two classes, ALNS and State. The first may be used to run the ALNS algorithm, the second may be subclassed to store a solution state - all it requires is to define an objective member function.

The ALNS algorithm must be supplied with an acceptance criterion, to determine the acceptance of a new solution state at each iteration. An overview of common acceptance criteria is given in Santini et al. (2018). Several have already been implemented for you, in alns.criteria,

  • HillClimbing. The simplest acceptance criterion, hill-climbing solely accepts solutions improving the objective value.
  • RecordToRecordTravel. This criterion only accepts solutions when the improvement meets some updating threshold.
  • SimulatedAnnealing. This criterion accepts solutions when the scaled probability is bigger than some random number, using an updating temperature.

Each acceptance criterion inherits from AcceptanceCriterion, which may be used to write your own.

Examples

The examples/ directory features some example notebooks showcasing how the ALNS library may be used. Of particular interest are,

  • The travelling salesman problem (TSP), here. We solve an instance of 131 cities to within 2.1% of optimality, using simple destroy and repair heuristics with a post-processing step.
  • The cutting-stock problem (CSP), here. We solve an instance with 180 beams over 165 distinct sizes to within 1.35% of optimality in only a very limited number of iterations.

References

  • Pisinger, D., and Ropke, S. (2010). Large Neighborhood Search. In M. Gendreau (Ed.), Handbook of Metaheuristics (2 ed., pp. 399-420). Springer.
  • Santini, A., Ropke, S. & Hvattum, L.M. (2018). A comparison of acceptance criteria for the adaptive large neighbourhood search metaheuristic. Journal of Heuristics 24 (5): 783-815.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

alns-1.2.4.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alns-1.2.4-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

Details for the file alns-1.2.4.tar.gz.

File metadata

  • Download URL: alns-1.2.4.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.5.6

File hashes

Hashes for alns-1.2.4.tar.gz
Algorithm Hash digest
SHA256 cb21cff2dba636c760a86a8e9e9547a238eb12d5de6a34a27a85115937ec59fd
MD5 70753274352530dd713351f8e1f14712
BLAKE2b-256 afeafbd45ca594edbae3a21bef87de3de124e944a0f791f6b02363dc7184f4b1

See more details on using hashes here.

File details

Details for the file alns-1.2.4-py3-none-any.whl.

File metadata

  • Download URL: alns-1.2.4-py3-none-any.whl
  • Upload date:
  • Size: 28.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.5.6

File hashes

Hashes for alns-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 55e2f617ec5c5747c5e34e35d0d10870686f4d2c0631cbcceb2e5e3f377ad142
MD5 75ff52d7d23852f878d83497840fc926
BLAKE2b-256 225b1855b96fb68c11a72deeb397347a7bc38dbdfde434aa654a685155be97a3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page