Add a bit of documentation and reorder functions

rism-digital · Oct 19, 2024 · c19e554 · c19e554
1 parent 585804a
commit c19e554
Show file tree

Hide file tree

Showing 2 changed files with 202 additions and 182 deletions.
diff --git a/include/vrv/scoringupfunctor.h b/include/vrv/scoringupfunctor.h
@@ -43,31 +43,32 @@ class ScoringUpFunctor : public Functor {
     ///@{
     std::vector<ArrayOfElementDurPairs> SubdivideIntoBoundedSequences(
         const ArrayOfElementDurPairs &dursInVoiceSameMensur);
+    void ProcessBoundedSequences(const std::vector<ArrayOfElementDurPairs> &listOfSequences);
+    void ProcessBoundedSequences(const ArrayOfElementDurPairs &sequence);
+    ArrayOfElementDurPairs GetBoundedNotes(const ArrayOfElementDurPairs &sequence);
     ///@}
 
     /**
-     * @name: Find @dur.quality of notes (perfecta / imperfecta / altera)
+     * @name: Apply the principles of imperfection and alteration (find @dur.quality of notes, perfecta / imperfecta /
+     * altera) for sequences with or without dots of division
      */
     ///@{
-    void ProcessBoundedSequences(const std::vector<ArrayOfElementDurPairs> &listOfSequences);
-    void ProcessBoundedSequences(const ArrayOfElementDurPairs &sequence);
-    ArrayOfElementDurPairs GetBoundedNotes(const ArrayOfElementDurPairs &sequence);
     bool EvalDotOfDiv(const ArrayOfElementDurPairs &middleSeq, const ArrayOfElementDurPairs &sequence, int dotInd);
     void FindDurQuals(const ArrayOfElementDurPairs &middleSeq, double valueInUnit);
     ///@}
 
     /**
-     * @name: Find the duration value of the note in minims
+     * @name: Find the duration value of the note in minims or another given unit
      */
     ///@{
-    double GetValueInUnit(double valueInMinims, data_DURATION unit);
-    double GetValueInMinims(const ArrayOfElementDurPairs &middleSeq);
     double GetDurNumberValue(
         const std::pair<LayerElement *, data_DURATION> &elementDurPair, bool followedByDot, LayerElement *nextElement);
+    double GetValueInMinims(const ArrayOfElementDurPairs &middleSeq);
+    double GetValueInUnit(double valueInMinims, data_DURATION unit);
     ///@}
 
     /**
-     * @name Apply principles of imperfection and alteration
+     * @name Apply the modifications of imperfection and alteration or leaves the notes with their default perfect value
      */
     ///@{
     Note *ImperfectionAPP(const ArrayOfElementDurPairs &sequence);