Skip to content

Commit

Permalink
add README details
Browse files Browse the repository at this point in the history
  • Loading branch information
matbesancon committed Dec 16, 2024
1 parent 5a95b39 commit 757a8e1
Showing 1 changed file with 19 additions and 1 deletion.
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@
[![Build Status](https://github.com/ZIB-IOL/CombinatorialLinearOracles.jl/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/ZIB-IOL/CombinatorialLinearOracles.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/ZIB-IOL/CombinatorialLinearOracles.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ZIB-IOL/CombinatorialLinearOracles.jl)

This package is primarily a companion of [FrankWolfe.jl](https://github.com/ZIB-IOL/FrankWolfe.jl/) and implements several combinatorial linear minimization oracles, for instance for minimizing a linear function over a polytope defined by objects on graphs (spanning trees, matchings, ...).
This package implements linear minimization oracles which compute a minimizer of a linear function over a compact convex set.

CombinatorialLinearOracles is primarily a companion of [FrankWolfe.jl](https://github.com/ZIB-IOL/FrankWolfe.jl/) and implements several combinatorial linear minimization oracles, for instance for minimizing a linear function over a polytope defined by objects on graphs (spanning trees, matchings, ...).

CombinatorialLinearOracles also implements bounded linear minimization oracles (BLMO) for usage in the branch-and-bound of [Boscia.jl](https://github.com/ZIB-IOL/Boscia.jl).

## Installation

Expand All @@ -13,3 +17,17 @@ Pkg.add("https://github.com/ZIB-IOL/CombinatorialLinearOracles.jl")

import CombinatorialLinearOracles
```

## Usage

```julia
import FrankWolfe
import CombinatorialLinearOracles as CLO
using Graphs

g = complete_graph(5)
lmo = CLO.MatchingLMO(g)

direction = randn(Graphs.ne(g))
opt_matching = FrankWolfe.compute_extreme_point(lmo, direction)
```

0 comments on commit 757a8e1

Please sign in to comment.