Coluna.jl icon indicating copy to clipboard operation
Coluna.jl copied to clipboard

Update documentation

Open najaverzat opened this issue 2 years ago • 1 comments

  • [ ] 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

najaverzat avatar Apr 21 '23 13:04 najaverzat

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))

guimarqu avatar May 16 '23 16:05 guimarqu