Skip to main content

GRASP-ILS-VND with Path Relinking — direction-agnostic metaheuristic optimizer.

Project description

givp — GRASP-ILS-VND with Path Relinking

Python   PyPI version Python versions CI Python codecov (python) Ruff Checked with mypy

Julia   JuliaHub Julia CI Julia codecov (julia)

Rust   Crates.io Rust CI Rust codecov (rust) docs.rs

C++   header-only C++17 CI C++ codecov (cpp)

Project   OpenSSF Scorecard OpenSSF Best Practices License: MIT PRs welcome

A direction-agnostic metaheuristic optimizer for continuous, integer or mixed black-box problems, available in four languages:

Language Distribution Requires
Python (NumPy-native) PyPI givp Python 3.10+, NumPy
Julia JuliaHub GIVPOptimizer Julia 1.9+
Rust crates.io givp Rust 1.85+
C++17 Header-only (FetchContent / copy) C++17 compiler, CMake 3.21+

The library bundles:

  • GRASP — Greedy Randomized Adaptive Search Procedure
  • ILS — Iterated Local Search
  • VND — Variable Neighborhood Descent (with an adaptive variant)
  • Path Relinking between elite solutions
  • LRU evaluation cache, convergence monitor, optional thread-parallel candidate evaluation, and a wall-clock time budget

Table of contents


Install

Python installation

pip install givp

Recommended: install with the optional cache extra to use xxhash for a ~10× faster evaluation cache:

pip install givp[cache]

Without xxhash, the cache falls back to Python's built-in hashlib (SHA-256), which works correctly but is slower.

From source (editable):

git clone https://github.com/Arnime/grasp_ils_vnd_pr.git
cd grasp_ils_vnd_pr
pip install -e .[dev]

Requires Python 3.10+ and NumPy.

Julia installation

git clone https://github.com/Arnime/grasp_ils_vnd_pr.git
cd grasp_ils_vnd_pr/julia
julia --project=. -e 'using Pkg; Pkg.instantiate()'

Requires Julia 1.9+.

Rust installation

Add to your Cargo.toml:

[dependencies]
givp = "0.5"

From source:

git clone https://github.com/Arnime/grasp_ils_vnd_pr.git
cd grasp_ils_vnd_pr/rust
cargo build --release
cargo test

Requires Rust 1.85+ (edition 2021).

C++ installation

The C++ port is header-only. The recommended way is CMake FetchContent:

include(FetchContent)
FetchContent_Declare(
    givp
    GIT_REPOSITORY https://github.com/Arnime/grasp_ils_vnd_pr.git
    GIT_TAG        v0.7.0
    SOURCE_SUBDIR  cpp
)
FetchContent_MakeAvailable(givp)

target_link_libraries(my_app PRIVATE givp::givp)

Or copy the cpp/include/givp/ directory into your project and add it to your include path. No external dependencies are required at runtime.

Requires a C++17 compiler (GCC 9+, Clang 10+, MSVC 2019+) and CMake 3.21+ (for the FetchContent approach).


Python

Quick start

import numpy as np
from givp import givp

def sphere(x: np.ndarray) -> float:
    return float(np.sum(x ** 2))

result = givp(sphere, bounds=[(-5.0, 5.0)] * 10)
print(result.x)        # best vector found
print(result.fun)      # best objective value
print(result.nfev)     # number of evaluations performed

Default behavior:

  • Minimization (minimize=True / direction="minimize").
  • All variables treated as continuous.
  • Default hyper-parameters (GIVPConfig()).

Choosing the optimization sense

The library is agnostic to whether you want the lowest or the highest value of func. Two equivalent ways to declare it:

Boolean flag (recommended)

from givp import givp

def gain(x):
    return float((x ** 2).sum())  # higher is better

result = givp(gain, [(-5, 5)] * 10, minimize=False)
assert result.direction == "maximize"

String flag (SciPy/Optuna compatible)

result = givp(gain, [(-5, 5)] * 10, direction="maximize")

Both flags are accepted on givp, on GIVPOptimizer and on GIVPConfig. Setting both simultaneously is allowed only when they agree; conflicting values raise ValueError.

Internal note. The core algorithm always minimizes. When you ask for maximization the public API wraps your objective with a sign flip and restores the sign on result.fun. This means result.fun is always reported in your original sign — no need to negate it back yourself.


Bounds, integer variables and mixed problems

bounds is accepted in two equivalent forms:

# SciPy style: list of (low, high) per variable
bounds = [(-5.0, 5.0), (0.0, 10.0), (-1.0, 1.0)]

# (lower, upper) tuple of two equally-sized sequences
bounds = ([-5.0, 0.0, -1.0], [5.0, 10.0, 1.0])

By default every variable is continuous. To declare a mixed problem (some continuous variables followed by some integer variables in the decision vector), use integer_split on the configuration:

from givp import GIVPConfig, givp

n_cont, n_int = 12, 8
bounds = [(-5.0, 5.0)] * n_cont + [(0.0, 4.0)] * n_int

cfg = GIVPConfig(integer_split=n_cont)  # indices >= n_cont are integer

result = givp(my_objective, bounds, config=cfg)

Special cases:

integer_split Meaning
None (public API default: num_vars) All-continuous problem.
0 All-integer problem.
n_vars All-continuous problem (explicit).
k (0 < k < n) First k continuous, rest integer.

Object-oriented API and multi-start

When you want to keep configuration around, run the optimizer multiple times and track the best result automatically, use GIVPOptimizer:

from givp import GIVPConfig, GIVPOptimizer

opt = GIVPOptimizer(
    func=sphere,
    bounds=[(-5.0, 5.0)] * 10,
    minimize=True,
    config=GIVPConfig(max_iterations=50, time_limit=30.0),
    verbose=True,
)
for _ in range(5):
    opt.run()
print("best across 5 restarts:", opt.best_fun)
print("history length:", len(opt.history))

opt.best_x and opt.best_fun always reflect the best result observed across all run() calls, in the user's original sign.


Configuration cookbook

from givp import GIVPConfig

# 1) Fast triage (small budget, no warm-up)
cfg_fast = GIVPConfig(
    max_iterations=20,
    vnd_iterations=50,
    ils_iterations=5,
    use_elite_pool=False,
    use_convergence_monitor=False,
    use_cache=True,
)

# 2) Production-quality run with wall-clock budget
cfg_quality = GIVPConfig(
    max_iterations=200,
    vnd_iterations=300,
    ils_iterations=15,
    elite_size=10,
    path_relink_frequency=5,
    adaptive_alpha=True,
    alpha_min=0.05,
    alpha_max=0.20,
    time_limit=600.0,         # stop after 10 minutes
    n_workers=4,              # parallelize candidate evaluation
)

# 3) Expensive objective: maximize cache reuse, keep evaluations few
cfg_expensive = GIVPConfig(
    num_candidates_per_step=8,
    cache_size=50_000,
    use_cache=True,
    early_stop_threshold=40,  # stop earlier on stagnation
)

# 4) Maximization with hourly-shaped layout (3 plants × 24 hours)
cfg_hydro = GIVPConfig(
    minimize=False,
    integer_split=72,         # first 72 vars continuous, rest integer
    max_iterations=120,
    time_limit=300.0,
)

Inspecting progress (callback and verbose)

Both givp and GIVPOptimizer accept:

  • verbose=True — prints per-iteration cost and cache statistics.
  • iteration_callback=fn — calls fn(iteration_index, best_cost, best_solution) once per outer GRASP iteration. The callback receives the cost in the internal minimization sign (i.e., already sign-flipped if you asked for maximization). Useful to plot convergence or persist intermediate results.
costs = []

def log_iter(i, cost, sol):
    costs.append(cost)

result = givp(
    sphere,
    [(-5, 5)] * 10,
    iteration_callback=log_iter,
    verbose=True,
)

API reference

givp(...) -> OptimizeResult

givp(
    func: Callable[[np.ndarray], float],
    bounds: Sequence[tuple[float, float]] | tuple[Sequence[float], Sequence[float]],
    *,
    num_vars: int | None = None,
    minimize: bool | None = None,
    direction: str | None = None,         # 'minimize' or 'maximize'
    config: GIVPConfig | None = None,
    initial_guess: Sequence[float] | None = None,
    iteration_callback: Callable[[int, float, np.ndarray], None] | None = None,
    verbose: bool = False,
) -> OptimizeResult

class GIVPOptimizer

Same constructor signature, exposes .run() -> OptimizeResult and tracks .best_x, .best_fun, .history.

class GIVPConfig (dataclass)

All hyper-parameters listed in the glossary.

class OptimizeResult

Field Type Meaning
x np.ndarray Best solution vector.
fun float Objective value at x, in the user's original sign.
nit int GRASP outer iterations executed.
nfev int Number of objective evaluations.
success bool True when at least one feasible solution was produced.
message str Human-readable termination reason.
direction str 'minimize' or 'maximize'.
meta dict Algorithm-specific extras (cache stats, etc.).

For backward compatibility the result is iterable: x, fun = result works.


Glossary of hyper-parameters

Field Default Meaning
max_iterations 100 GRASP outer iterations.
alpha 0.12 Initial RCL randomization (0 = greedy, 1 = uniform).
vnd_iterations 200 Maximum VND inner iterations.
ils_iterations 10 Iterated Local Search loops per outer iteration.
perturbation_strength 4 Magnitude of ILS perturbation (number of variables jolted).
use_elite_pool True Maintain a diverse pool of elite solutions for path relinking.
elite_size 7 Maximum number of elite solutions kept.
path_relink_frequency 8 Every N GRASP iterations, run path relinking on elite pairs.
adaptive_alpha True If True, alpha varies in [alpha_min, alpha_max] over iterations.
alpha_min / alpha_max 0.08 / 0.18 Bounds for adaptive alpha.
num_candidates_per_step 20 Candidates evaluated per construction step.
use_cache True Memoize evaluations via LRU cache.
cache_size 10000 LRU cache capacity.
early_stop_threshold 80 Iterations without improvement before terminating.
use_convergence_monitor True Enable diversification/restart heuristics.
n_workers 1 Threads used to evaluate candidates concurrently in the GRASP construction phase. Set to os.cpu_count() or a fixed value (2–4) for CPU-bound objectives. Due to the Python GIL, gains are most visible when func releases the GIL (e.g. NumPy-heavy code).
time_limit 0.0 Wall-clock budget in seconds (0 = unlimited).
minimize None Boolean direction flag. True = minimize, False = maximize.
direction 'minimize' String direction flag (alternative form).
integer_split None Index where integer variables begin in the decision vector.

Adapting to a domain-specific model

The library knows nothing about your problem. Wrap your domain code so it exposes a func(x: np.ndarray) -> float and a list of bounds. Penalty terms, repair operators and constraint handling all live in your project.

Minimal pattern:

def make_objective(model):
    def f(x):
        try:
            return float(model.evaluate(x))
        except (ValueError, RuntimeError):
            return float("inf")  # treat infeasibility as worst possible cost
    return f

result = givp(make_objective(my_model), bounds=my_bounds)

For an end-to-end example with a mixed continuous/integer hydropower model, see the SOG2 adapter in the upstream project repository (givp.py).


Julia

The Julia port exposes the same algorithm with an idiomatic Julia API. Install via the Julia installation instructions above.

Julia quick start

using GIVPOptimizer

function sphere(x::Vector{Float64})::Float64
    return sum(x .^ 2)
end

result = givp(sphere, [(-5.0, 5.0) for _ in 1:10])
println(result.x)       # best vector found
println(result.fun)     # best objective value
println(result.nfev)    # number of evaluations

Maximization:

result = givp(my_score, bounds; direction=maximize)

Julia bounds and integer variables

bounds is a vector of (lower, upper) tuples, one per variable. Use integer_split to declare mixed continuous/integer problems:

n_cont, n_int = 8, 4
bounds = vcat(fill((-5.0, 5.0), n_cont), fill((0.0, 3.0), n_int))
cfg = GIVPConfig(; integer_split=n_cont)          # indices >= n_cont are integer
result = givp(my_obj, bounds; config=cfg)

Julia configuration cookbook

# 1) Fast triage
cfg_fast = GIVPConfig(;
    max_iterations=20, vnd_iterations=50, ils_iterations=5,
    use_elite_pool=false, use_convergence_monitor=false,
)

# 2) Production-quality with wall-clock budget
cfg_quality = GIVPConfig(;
    max_iterations=200, vnd_iterations=300, ils_iterations=15,
    elite_size=10, path_relink_frequency=5,
    adaptive_alpha=true, alpha_min=0.05, alpha_max=0.20,
    time_limit=600.0,
)

# 3) Maximization
cfg_max = GIVPConfig(; direction=maximize, max_iterations=100)

result = givp(sphere, bounds; config=cfg_quality, seed=42, verbose=true)

Julia result fields

Field Type Meaning
x Vector{Float64} Best solution vector.
fun Float64 Objective value at x, in the original sign.
nit Int Outer GRASP iterations executed.
nfev Int Total objective-function evaluations.
success Bool True when fun is finite.
message String Human-readable termination reason.
direction Direction minimize or maximize (enum).
meta Dict{String,Any} Algorithm-specific extras (cache stats, etc.).

Tuple unpacking works: x, fun = result.

Julia progress monitoring

costs = Float64[]

function log_iter(i, cost, sol)
    push!(costs, cost)
end

result = givp(sphere, bounds; iteration_callback=log_iter, verbose=true)

Running Julia tests and benchmarks

cd julia
julia --project=. -e 'using Pkg; Pkg.test()'
julia --project=. benchmarks/benchmarks.jl

Rust

The Rust port is a zero-dependency (no NumPy), native-performance implementation suitable for embedding in systems code or for maximum throughput. Install via the Rust installation instructions above.

Rust quick start

use givp::{givp, GivpConfig};

let sphere = |x: &[f64]| -> f64 { x.iter().map(|v| v * v).sum() };
let bounds: Vec<(f64, f64)> = vec![(-5.12, 5.12); 5];

let result = givp(sphere, &bounds, GivpConfig::default()).unwrap();
println!("best: {:.6}", result.fun);
println!("x:    {:?}", result.x);
println!("nfev: {}", result.nfev);

Rust bounds and integer variables

Bounds are a &[(f64, f64)] slice. Use integer_split for mixed problems:

use givp::{givp, GivpConfig};

let n_cont = 8usize;
let mut bounds: Vec<(f64, f64)> = vec![(-5.0, 5.0); n_cont];
bounds.extend(vec![(0.0, 3.0); 4]);  // 4 integer variables

let config = GivpConfig {
    integer_split: Some(n_cont),  // indices >= n_cont are rounded to int
    ..Default::default()
};
let result = givp(my_obj, &bounds, config).unwrap();

Rust configuration cookbook

use givp::{givp, GivpConfig, Direction};

// Maximization
let cfg_max = GivpConfig {
    direction: Direction::Maximize,
    seed: Some(42),
    ..Default::default()
};

// Production-quality run with wall-clock budget
let cfg_quality = GivpConfig {
    max_iterations: 200,
    vnd_iterations: 300,
    ils_iterations: 15,
    elite_size: 7,
    path_relink_frequency: 5,
    adaptive_alpha: true,
    alpha_min: 0.05,
    alpha_max: 0.20,
    time_limit: 600.0,
    seed: Some(0),
    ..Default::default()
};

let result = givp(sphere, &bounds, cfg_quality).unwrap();

Rust result fields

Field Type Meaning
x Vec<f64> Best solution vector.
fun f64 Objective value at x, in the original sign.
nit usize Outer GRASP iterations executed.
nfev usize Total objective-function evaluations.
success bool True when fun is finite.
message String Human-readable termination reason.
termination TerminationReason Typed termination enum.

The function returns Result<OptimizeResult, GivpError> — use .unwrap() for quick scripts or pattern-match for production code.

Running Rust tests and benchmarks

cd rust
cargo test
cargo bench

C++

The C++ port is a header-only, zero-runtime-dependency implementation. It uses the same algorithm and identical default hyper-parameters as the Python, Julia, and Rust ports.

C++ quick start

#include <givp/givp.hpp>
#include <iostream>
#include <vector>

int main() {
    auto sphere = [](const std::vector<double>& x) {
        double s = 0.0;
        for (auto v : x) s += v * v;
        return s;
    };

    std::vector<std::pair<double, double>> bounds(10, {-5.0, 5.0});
    givp::OptimizeResult r = givp::givp(sphere, bounds);

    std::cout << "best: " << r.fun  << "\n";  // best objective value
    std::cout << "nfev: " << r.nfev << "\n";  // evaluations used
    std::cout << "nit:  " << r.nit  << "\n";  // outer iterations
}

Maximization:

givp::GivpConfig cfg;
cfg.direction = givp::Direction::Maximize;
auto result = givp::givp(my_func, bounds, cfg);

C++ configuration

givp::GivpConfig cfg;
cfg.max_iterations          = 50;
cfg.vnd_iterations          = 100;
cfg.time_limit              = 30.0;          // wall-clock seconds
cfg.seed                    = 42;
cfg.integer_split           = 8;             // first 8 vars continuous
cfg.verbose                 = true;

givp::OptimizeResult r = givp::givp(sphere, bounds, cfg);

OptimizeResult fields mirror all other ports:

Field Type Meaning
x std::vector<double> Best solution vector.
fun double Objective value at x, in the original sign.
nit std::size_t Outer GRASP iterations executed.
nfev std::size_t Total objective-function evaluations.
success bool True when fun is finite.
message std::string Human-readable termination reason.

Running tests and benchmarks

# Configure and build
cmake -S cpp -B build -DCMAKE_BUILD_TYPE=Release -DGIVP_BUILD_TESTS=ON
cmake --build build

# Run the 41 Catch2 test cases
ctest --test-dir build --output-on-failure

# Build and run nanobench benchmarks
cmake -S cpp -B build_bench -DCMAKE_BUILD_TYPE=Release -DGIVP_BUILD_BENCHMARKS=ON
cmake --build build_bench
./build_bench/benchmarks/givp_benchmarks

Comparison with other optimizers

Library Sense convention Discrete vars? Built-in cache Built-in time budget Language
scipy.optimize.minimize Always minimize No No No Python
scipy.optimize.differential_evolution Always minimize Continuous only No Via callback Python
scipy.optimize.dual_annealing Always minimize No No maxiter only Python
optuna Explicit (direction) Yes Per-trial only Yes (timeout) Python
pygad Always maximize Yes No No Python
givp (Python / Julia / Rust) Explicit (minimize/direction) Yes (mixed) LRU cache Yes (time_limit) Python+Julia+Rust
givp (C++) Explicit (Direction enum) Yes (mixed) LRU cache Yes (time_limit) C++17

Empirical results

Results of 30 independent runs (seeds 0–29) on four standard continuous benchmarks (n = 10 dimensions) comparing the full GIVP pipeline against a GRASP-only baseline (construction phase only, no ILS/VND/path relinking — equivalent to plain GRASP as described by Feo & Resende, 1995).

Each run uses an explicit seed for full reproducibility. To reproduce, run the Notebooks/benchmark_literature_comparison.ipynb notebook.

Note: Values below are representative results from the notebook execution. Run the notebook on your machine to obtain hardware-specific timings.

Sphere — $f(\mathbf{x}) = \sum x_i^2$, global minimum 0 at 0

Algorithm Mean ± Std Best Median NFev (mean)
GIVP-full 0.0002 ± 0.0001 6.2935e-05 1.9862e-04 605 626
GRASP-only 2.1568 ± 0.4827 1.0564e+00 2.1947e+00 4 828

Rosenbrock — global minimum 0 at 1

Algorithm Mean ± Std Best Median NFev (mean)
GIVP-full 0.513 ± 0.325 1.0413e-02 5.1000e-01 571 765
GRASP-only 5441.154 ± 2232.312 1.6380e+03 5.3735e+03 4 834

Rastrigin — multimodal, global minimum 0 at 0

Algorithm Mean ± Std Best Median NFev (mean)
GIVP-full 0.8492 ± 0.6247 9.1427e-03 1.0144e+00 524 825
GRASP-only 28.0927 ± 4.9224 1.8621e+01 2.9218e+01 4 898

Ackley — multimodal, global minimum 0 at 0

Algorithm Mean ± Std Best Median NFev (mean)
GIVP-full 0.1525 ± 0.0277 1.0691e-01 1.5015e-01 477 840
GRASP-only 8.9242 ± 1.0037 7.2171e+00 9.2427e+00 4 852

References

  • Feo, T.A. & Resende, M.G.C. (1995). Greedy randomized adaptive search procedures. Journal of Global Optimization, 6, 109–133.
  • Festa, P. & Resende, M.G.C. (2011). GRASP: An annotated bibliography. Essays and Surveys in Metaheuristics. Springer.

Troubleshooting

ValueError: each element of upper must be strictly greater than lower A bounds entry has low >= high. Even fixed values must use a strictly positive interval ((v - 1e-9, v + 1e-9)) or be removed from the search.

ValueError: bounds length (...) does not match num_vars (...) You passed num_vars explicitly but the bounds disagree. Drop num_vars to let the library infer it from bounds, or fix the mismatch.

ValueError: 'minimize' and 'direction' disagree: ... You passed both flags with conflicting values. Use one or the other (or pass both with matching values).

Optimization converges to inf. Your objective is raising or returning nan. The wrapper coerces non-finite values to +inf so they are always comparable, but if every candidate is infeasible the algorithm has nothing to improve. Lower perturbation_strength, revisit your bounds, or relax the feasibility logic in func.

Run is too slow. Try use_cache=True (with givp[cache] for maximum speed), increase cache_size, raise n_workers (2–4 is a practical sweet spot under the Python GIL; set n_workers=os.cpu_count() for NumPy-heavy objectives), lower num_candidates_per_step, or set a time_limit. For very expensive objectives, also reduce vnd_iterations and ils_iterations.

Final solution looks too "rough" / integer values look noisy. Make sure integer_split is set correctly. With the default (None / num_vars) all variables are treated as continuous and the integer-aware neighborhoods are skipped.


License

MIT

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

givp-1.0.0.tar.gz (84.3 kB view details)

Uploaded Source

Built Distribution

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

givp-1.0.0-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

Details for the file givp-1.0.0.tar.gz.

File metadata

  • Download URL: givp-1.0.0.tar.gz
  • Upload date:
  • Size: 84.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for givp-1.0.0.tar.gz
Algorithm Hash digest
SHA256 8c3d877732838229b0995dcb7f6ab4831d3d60842276bf7793f513499e900b1b
MD5 f21c130980277251d0fec94683571a8e
BLAKE2b-256 b090e60bc9bdd49b99609a544e82ac8676f4209d69419793eddf31154b8488e0

See more details on using hashes here.

Provenance

The following attestation bundles were made for givp-1.0.0.tar.gz:

Publisher: release.yml on Arnime/grasp_ils_vnd_pr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file givp-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: givp-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 56.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for givp-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67f9710620ddddac919aa1c853c98bb33f8e2260c0a7450ac3e357e0c6935733
MD5 bd31530b8bbce21b300ae43b3ee1efe3
BLAKE2b-256 4db10e00b6906a98fbbc0cc9f3e70f887ebcfcb7d5bfb25e6cc4e853a135d519

See more details on using hashes here.

Provenance

The following attestation bundles were made for givp-1.0.0-py3-none-any.whl:

Publisher: release.yml on Arnime/grasp_ils_vnd_pr

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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