Megrez // Add isExplicitlyOverridden property to GramInPath, etc.

Author: ShikiSuen

Sources/Megrez/2_PathFinder.swift

@@ -70,7 +70,8 @@ extension Megrez {
         guard let node = parent[currentPos] else { break }
         let insertable = Megrez.GramInPath(
           gram: node.currentUnigram,
-          isOverridden: node.isOverridden
+          isOverridden: node.isOverridden,
+          isExplicitlyOverridden: node.isExplicitlyOverridden
         )
         reversedSentence.append(insertable)
         currentPos -= node.keyArray.count

Sources/Megrez/3_KeyValuePaired.swift

@@ -156,7 +156,7 @@ extension Megrez.Compositor {
           default: break
           }
         }
-        result.append(.init(keyArray: theNode.keyArray, value: gram.value))
+        result.append(.init(keyArray: theNode.keyArray, value: gram.value, score: gram.score))
       }
     }
     return result
@@ -176,6 +176,7 @@ extension Megrez.Compositor {
   public func overrideCandidate(
     _ candidate: Megrez.KeyValuePaired, at location: Int,
     overrideType: Megrez.Node.OverrideType = .withSpecified,
+    isExplicitlyOverridden: Bool = false,
     enforceRetokenization: Bool = false,
     perceptionHandler: ((Megrez.PerceptionIntel) -> ())? = nil
   )
@@ -186,6 +187,7 @@ extension Megrez.Compositor {
       value: candidate.value,
       score: candidate.score < 0 ? candidate.score : nil,
       type: overrideType,
+      isExplicitlyOverridden: isExplicitlyOverridden,
       enforceRetokenization: enforceRetokenization,
       perceptionHandler: perceptionHandler
     )
@@ -205,6 +207,7 @@ extension Megrez.Compositor {
   public func overrideCandidateLiteral(
     _ candidate: String,
     at location: Int, overrideType: Megrez.Node.OverrideType = .withSpecified,
+    isExplicitlyOverridden: Bool = false,
     enforceRetokenization: Bool = false,
     perceptionHandler: ((Megrez.PerceptionIntel) -> ())? = nil
   )
@@ -215,6 +218,7 @@ extension Megrez.Compositor {
       value: candidate,
       score: nil,
       type: overrideType,
+      isExplicitlyOverridden: isExplicitlyOverridden,
       enforceRetokenization: enforceRetokenization,
       perceptionHandler: perceptionHandler
     )
@@ -238,6 +242,7 @@ extension Megrez.Compositor {
     value: String,
     score specifiedScore: Double? = nil,
     type: Megrez.Node.OverrideType,
+    isExplicitlyOverridden: Bool,
     enforceRetokenization: Bool,
     perceptionHandler: ((Megrez.PerceptionIntel) -> ())? = nil
   )
@@ -285,6 +290,7 @@ extension Megrez.Compositor {
           anchor.node.overrideStatus = .init(
             overridingScore: desiredScore,
             currentOverrideType: .withSpecified,
+            isExplicitlyOverridden: isExplicitlyOverridden,
             currentUnigramIndex: anchor.node.currentUnigramIndex
           )
         }
@@ -333,6 +339,7 @@ extension Megrez.Compositor {
           anchor.node.overrideStatus = .init(
             overridingScore: demotionScore,
             currentOverrideType: .withSpecified,
+            isExplicitlyOverridden: anchor.node.isExplicitlyOverridden,
             currentUnigramIndex: anchor.node.currentUnigramIndex
           )
         }

Sources/Megrez/5_Node.swift

@@ -45,6 +45,7 @@ extension Megrez {
       self.segLength = node.segLength
       self.unigrams = node.unigrams.map(\.copy)
       self.currentOverrideType = node.currentOverrideType
+      self.isExplicitlyOverridden = node.isExplicitlyOverridden
       self.currentUnigramIndex = node.currentUnigramIndex
     }
 
@@ -80,6 +81,8 @@ extension Megrez {
     public private(set) var unigrams: [Megrez.Unigram]
     /// 該節點目前的覆寫狀態種類。為 `nil` 時表示無覆寫行為。
     public private(set) var currentOverrideType: Node.OverrideType?
+    /// 是否為使用者明確覆寫（explicit override）、而非出於自動機制進行的複寫。
+    public private(set) var isExplicitlyOverridden: Bool = false
 
     /// 當前該節點所指向的（單元圖陣列內的）單元圖索引位置。
     public private(set) var currentUnigramIndex: Int = 0 {
@@ -124,12 +127,14 @@ extension Megrez {
         NodeOverrideStatus(
           overridingScore: overridingScore,
           currentOverrideType: currentOverrideType,
+          isExplicitlyOverridden: isExplicitlyOverridden,
           currentUnigramIndex: currentUnigramIndex
         )
       }
       set {
         overridingScore = newValue.overridingScore
         currentOverrideType = newValue.currentOverrideType
+        isExplicitlyOverridden = newValue.isExplicitlyOverridden
         // 防範 UnigramIndex 溢出，如果溢出則重設覆寫狀態
         if newValue.currentUnigramIndex >= 0, newValue.currentUnigramIndex < unigrams.count {
           currentUnigramIndex = newValue.currentUnigramIndex
@@ -221,10 +226,12 @@ public struct NodeOverrideStatus: Codable, Hashable {
   public init(
     overridingScore: Double = 114_514,
     currentOverrideType: Megrez.Node.OverrideType? = nil,
+    isExplicitlyOverridden: Bool = false,
     currentUnigramIndex: Int = 0
   ) {
     self.overridingScore = overridingScore
     self.currentOverrideType = currentOverrideType
+    self.isExplicitlyOverridden = isExplicitlyOverridden
     self.currentUnigramIndex = currentUnigramIndex
   }
 
@@ -236,4 +243,6 @@ public struct NodeOverrideStatus: Codable, Hashable {
   public var currentOverrideType: Megrez.Node.OverrideType?
   /// 當前單元圖索引位置
   public var currentUnigramIndex: Int
+  /// 使用者是否明確覆寫（explicit override）
+  public var isExplicitlyOverridden: Bool
 }

Sources/Megrez/8_GramInPath.swift

@@ -12,15 +12,21 @@ extension Megrez {
   public struct GramInPath: Codable, Hashable {
     // MARK: Lifecycle
 
-    public init(gram: Unigram, isOverridden: Bool) {
+    public init(
+      gram: Unigram,
+      isOverridden: Bool,
+      isExplicitlyOverridden: Bool = false
+    ) {
       self.gram = gram
       self.isOverridden = isOverridden
+      self.isExplicitlyOverridden = isExplicitlyOverridden
     }
 
     // MARK: Public
 
     public let gram: Unigram
     public let isOverridden: Bool
+    public let isExplicitlyOverridden: Bool
 
     public var keyArray: [String] { gram.keyArray }
     public var value: String { gram.value }