Uploaded image for project: 'OptaPlanner'
  1. OptaPlanner
  2. PLANNER-628

Improve docs about "explaining the score" and what's in a justification list

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Done
    • Icon: Major Major
    • 7.6.0.Final
    • None
    • optaplanner-core
    • None
    • NEW
    • NEW

      we need to have a text like this , this one is based on the nurse rostering example:

      Let's say you have this rule:
        when
           $e : Employee() // stupid example, you'd just nest that in the next line which is faster
           ShiftAssignment(employee == $e, ...)
        then
          ...
      
      In that case, the justificationList would contain an Employee and a ShiftAssignment, for example [employeeAnn, shiftAssignment745].
      So if you cast shiftAssignment745 to (ShiftAssignment), you could do getPost().getPostGroup().getCustomer() etc.
      
      However, if you got
        when
           $e : Employee()
           accumulate(ShiftAssignment(employee == $e, ...); $s : sum(...); $s > 10)
        then
          ...
      
      then the justificationList only contains an Employee, so for example [employeeAnn].
      

      an image slide to break down a score would be nice too

      and section title might need to be changed to "breaking down the score"

            gdesmet@redhat.com Geoffrey De Smet (Inactive)
            gdesmet@redhat.com Geoffrey De Smet (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: