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.5.tar.gz (18.4 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.5-py3-none-any.whl (28.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: alns-1.2.5.tar.gz
  • Upload date:
  • Size: 18.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.6.7

File hashes

Hashes for alns-1.2.5.tar.gz
Algorithm Hash digest
SHA256 7c71759cf565316ad938825b942dddb2c34f86782c509f361a22a0411df772b5
MD5 f2da620f561f74cca6135d9fbff6dccd
BLAKE2b-256 6499e127a07c794bb22d25e3acdc31d635a7679bc85591b8bdadbcafaba3997a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: alns-1.2.5-py3-none-any.whl
  • Upload date:
  • Size: 28.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3 requests-toolbelt/0.9.1 tqdm/4.44.0 CPython/3.7.1

File hashes

Hashes for alns-1.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 59af7230218f262d7df37244ac0c512f88f3c63ad4a9f719d55222069255afb8
MD5 bf902895b42b80f8c6ad82397fc3d336
BLAKE2b-256 f1cd7bf6de9c8f83b860c7cae34fd3e1b5d2f2e1a72de3ad45ccbe4b93983386

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