Refactored quality estimation to match Machine conventions

Author: pmachapman

src/SIL.Machine/QualityEstimation/BookScores.cs

@@ -0,0 +1,29 @@
+using System.Collections.Generic;
+
+namespace SIL.Machine.QualityEstimation
+{
+    internal class ScriptureBookScores
+    {
+        private readonly Dictionary<string, List<double>> _segmentUsabilities = new Dictionary<string, List<double>>();
+
+        public readonly Dictionary<string, Score> Scores = new Dictionary<string, Score>();
+
+        public void AddScore(string book, Score score) => Scores[book] = score;
+
+        public Score GetScore(string book) => Scores.TryGetValue(book, out Score score) ? score : null;
+
+        public void AppendSegmentUsability(string book, double usability)
+        {
+            if (!_segmentUsabilities.TryGetValue(book, out List<double> list))
+            {
+                list = new List<double>();
+                _segmentUsabilities[book] = list;
+            }
+
+            list.Add(usability);
+        }
+
+        public List<double> GetSegmentUsabilities(string book) =>
+            _segmentUsabilities.TryGetValue(book, out List<double> list) ? new List<double>(list) : new List<double>();
+    }
+}

src/SIL.Machine/QualityEstimation/ChapterUsability.cs

@@ -1,8 +1,8 @@
 namespace SIL.Machine.QualityEstimation
 {
-    public class BookUsability : UsabilityBase
+    public class ScriptureBookUsability : UsabilityBase
     {
-        public BookUsability(string book, UsabilityLabel label, double projectedChrF3, double usability)
+        public ScriptureBookUsability(string book, UsabilityLabel label, double projectedChrF3, double usability)
             : base(label, projectedChrF3, usability)
         {
             Book = book;

…lityEstimation/ChrF3QualityEstimation.cs …alityEstimation/ChrF3QualityEstimator.cssrc/SIL.Machine/QualityEstimation/ChrF3QualityEstimation.cs renamed to src/SIL.Machine/QualityEstimation/ChrF3QualityEstimator.cs src/SIL.Machine/QualityEstimation/ChrF3QualityEstimation.cs renamed to src/SIL.Machine/QualityEstimation/ChrF3QualityEstimator.cs

@@ -2,9 +2,9 @@
 
 namespace SIL.Machine.QualityEstimation
 {
-    internal class ChapterScores
+    internal class ScriptureChapterScores
     {
-        private readonly Dictionary<string, Dictionary<int, List<double>>> _verseUsabilities =
+        private readonly Dictionary<string, Dictionary<int, List<double>>> _segmentUsabilities =
             new Dictionary<string, Dictionary<int, List<double>>>();
 
         public readonly Dictionary<string, Dictionary<int, Score>> Scores =
@@ -27,12 +27,12 @@ public Score GetScore(string book, int chapter) =>
                 ? score
                 : null;
 
-        public void AppendVerseUsability(string book, int chapter, double usability)
+        public void AppendSegmentUsability(string book, int chapter, double usability)
         {
-            if (!_verseUsabilities.TryGetValue(book, out Dictionary<int, List<double>> chapters))
+            if (!_segmentUsabilities.TryGetValue(book, out Dictionary<int, List<double>> chapters))
             {
                 chapters = new Dictionary<int, List<double>>();
-                _verseUsabilities[book] = chapters;
+                _segmentUsabilities[book] = chapters;
             }
 
             if (!chapters.TryGetValue(chapter, out List<double> list))
@@ -44,8 +44,8 @@ public void AppendVerseUsability(string book, int chapter, double usability)
             list.Add(usability);
         }
 
-        public List<double> GetVerseUsabilities(string book, int chapter) =>
-            _verseUsabilities.TryGetValue(book, out Dictionary<int, List<double>> chapters)
+        public List<double> GetSegmentUsabilities(string book, int chapter) =>
+            _segmentUsabilities.TryGetValue(book, out Dictionary<int, List<double>> chapters)
             && chapters.TryGetValue(chapter, out List<double> list)
                 ? new List<double>(list)
                 : new List<double>();

src/SIL.Machine/QualityEstimation/ScriptureBookScores.cs

@@ -0,0 +1,19 @@
+namespace SIL.Machine.QualityEstimation
+{
+    public class ScriptureChapterUsability : ScriptureBookUsability
+    {
+        public ScriptureChapterUsability(
+            string book,
+            int chapter,
+            UsabilityLabel label,
+            double projectedChrF3,
+            double usability
+        )
+            : base(book, label, projectedChrF3, usability)
+        {
+            Chapter = chapter;
+        }
+
+        public int Chapter { get; }
+    }
+}

…chine/QualityEstimation/BookUsability.cs …lityEstimation/ScriptureBookUsability.cssrc/SIL.Machine/QualityEstimation/BookUsability.cs renamed to src/SIL.Machine/QualityEstimation/ScriptureBookUsability.cs src/SIL.Machine/QualityEstimation/BookUsability.cs renamed to src/SIL.Machine/QualityEstimation/ScriptureBookUsability.cs

@@ -2,9 +2,9 @@
 
 namespace SIL.Machine.QualityEstimation
 {
-    internal class VerseScore : Score
+    internal class ScriptureSegmentScore : Score
     {
-        public VerseScore(double slope, double confidence, double intercept, ScriptureRef scriptureRef)
+        public ScriptureSegmentScore(double slope, double confidence, double intercept, ScriptureRef scriptureRef)
             : base(slope, confidence, intercept)
         {
             ScriptureRef = scriptureRef;

…chine/QualityEstimation/ChapterScores.cs …lityEstimation/ScriptureChapterScores.cssrc/SIL.Machine/QualityEstimation/ChapterScores.cs renamed to src/SIL.Machine/QualityEstimation/ScriptureChapterScores.cs src/SIL.Machine/QualityEstimation/ChapterScores.cs renamed to src/SIL.Machine/QualityEstimation/ScriptureChapterScores.cs

@@ -0,0 +1,20 @@
+using SIL.Machine.Corpora;
+
+namespace SIL.Machine.QualityEstimation
+{
+    public class ScriptureSegmentUsability : ScriptureChapterUsability
+    {
+        public ScriptureSegmentUsability(
+            ScriptureRef scriptureRef,
+            UsabilityLabel label,
+            double projectedChrF3,
+            double usability
+        )
+            : base(scriptureRef.Book, scriptureRef.ChapterNum, label, projectedChrF3, usability)
+        {
+            ScriptureRef = scriptureRef;
+        }
+
+        public ScriptureRef ScriptureRef { get; }
+    }
+}