Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #827

Open
6 tasks
najaverzat opened this issue Apr 21, 2023 · 1 comment
Open
6 tasks

Update documentation #827

najaverzat opened this issue Apr 21, 2023 · 1 comment
Assignees

Comments

@najaverzat
Copy link
Contributor

najaverzat commented Apr 21, 2023

  • Coluna.Branching.perform_branching_phase!

  • Coluna.Branching.eval_children_of_candidate!

  • Branching.AbstractSelectionCriterion (man/algorithms.md)

  • ColunaBase.restore_from_record! (api/storage.jl)

  • dynamicsparsevec and dynamicsparse

  • TODO left at the beginning of Algorithms section

@guimarqu guimarqu self-assigned this Apr 21, 2023
@guimarqu
Copy link
Contributor

guimarqu commented May 16, 2023

Doc review from Ruslan:

  • nice piece of doc for the axis
    ## A user should resort to axes to communicate to Coluna how to decompose a formulation.
    ## Every axis is a set of indices, and each index in an axis indicates one subproblem.
    ## If a variable or constraint has an index from an axis, it belongs to the corresponding subproblem. 
    ## A variable or constraint which does not have an index from an axis remains in the master problem. 
    ## A variable belonging to a subproblem may be used in a constraint of this subproblem or in a master constraint.    
    ## A master variable may be used only in a master constraint. 
    ## A master variable may be declared as an implicit representative variable for several subproblems.
    ## Representative variables are useful to avoid duplication of subproblem variables and accelerate the solution process.
    ## For our problem, we declare an axis over the facilities, thus `facilities_axis` contain subproblem indices.
    ## We must use `facilities_axis` instead of `facilities` in the declaration of the 
    ## variables and constraints that belong to pricing subproblems.
    @axis(facilities_axis, collect(facilities))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants