Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
ArrogantGao committed Nov 24, 2024
1 parent e816f38 commit b7d009f
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 8 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,3 +76,7 @@ which shows that it takes only one branch to find the maximum independent set of
## How to Contribute

If you find any bug or have any suggestion, please open an [issue](https://github.com/ArrogantGao/OptimalBranching.jl/issues).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
19 changes: 15 additions & 4 deletions lib/OptimalBranchingCore/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
# OptimalBranchingCore

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ArrogantGao.github.io/OptimalBranchingCore.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ArrogantGao.github.io/OptimalBranchingCore.jl/dev/)
[![Build Status](https://github.com/ArrogantGao/OptimalBranchingCore.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ArrogantGao/OptimalBranchingCore.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/ArrogantGao/OptimalBranchingCore.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ArrogantGao/OptimalBranchingCore.jl)
Core functions and types for the optimal branching method. One can use it separately or as part of the `OptimalBranching` package.

## Usage

`OptimalBranchingCore` provides the basis tools for developing a branching algorithm, by dividing the branching process into the following steps:
* Reduction of the problem
* Generation of the branches
* Applying the branching rules on the problem

For the optimal branching method, the generation of the branches is further divided into the following sub-steps:
* Solving the branching table
* Pruning the branches
* Selecting the optimal branching rule via the set covering solver

For more details, please refer to the [docs]().
18 changes: 14 additions & 4 deletions lib/OptimalBranchingMIS/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,16 @@
# OptimalBranchingMIS

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://ArrogantGao.github.io/OptimalBranchingMIS.jl/stable/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://ArrogantGao.github.io/OptimalBranchingMIS.jl/dev/)
[![Build Status](https://github.com/ArrogantGao/OptimalBranchingMIS.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/ArrogantGao/OptimalBranchingMIS.jl/actions/workflows/CI.yml?query=branch%3Amain)
[![Coverage](https://codecov.io/gh/ArrogantGao/OptimalBranchingMIS.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/ArrogantGao/OptimalBranchingMIS.jl)
`OptimalBranchingMIS` is a developed based on `OptimalBranchingCore` for the optimal branching method on the maximum independent set (MIS) problem.

## Usage

In this pacakge a set of tools for MIS problem has been provided, including:
* `MISProblem`: the problem type for MIS
* `MISReducer`: the reducer for MIS
* `MISSize` & `MISCount`: different types for the results, returning the size of the maximum independent set or together with the count of branches
* `MinBoundarySelector`: the selectors for the minimum boundary size
* `NumofVertex` & `D3Measure`: different measures for the MIS problem

Additionally, we provide `counting_mis1` and `counting_mis2` functions for counting the maximum independent sets, which are based on the `EliminateGraphs` package.

For more details, please refer to the [docs]().

0 comments on commit b7d009f

Please sign in to comment.