floraachy
/
vChewing-macOS
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

LMs // Documentation fix.

This commit is contained in:
ShikiSuen 2022-06-20 12:30:37 +08:00
parent be0142a481
commit 6edbbe4aa6
2 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Source/Modules/LangModelRelated/SubLMs/lmCoreEX.swift
View File

@ -31,7 +31,7 @@ extension vChewing {
/// 資料記錄原理與上游 C++ 的 ParselessLM 差不多，但用的是 Swift 原生手段。 /// 資料記錄原理與上游 C++ 的 ParselessLM 差不多，但用的是 Swift 原生手段。
/// 主要時間消耗仍在 For 迴圈，但這個算法可以顯著減少記憶體佔用。 /// 主要時間消耗仍在 For 迴圈，但這個算法可以顯著減少記憶體佔用。
@frozen public struct LMCoreEX { @frozen public struct LMCoreEX {
/// 資料庫陣列。索引內容為注音字串，資料內容則為字串首尾範圍、方便自 strData 取資料。 /// 資料庫辭典。索引內容為注音字串，資料內容則為字串首尾範圍、方便自 strData 取資料。
var rangeMap: [String: [Range<String.Index>]] = [:] var rangeMap: [String: [Range<String.Index>]] = [:]
/// 資料庫字串陣列。 /// 資料庫字串陣列。
var strData: String = "" var strData: String = ""
@ -66,12 +66,12 @@ extension vChewing {
shouldForceDefaultScore = forceDefaultScore shouldForceDefaultScore = forceDefaultScore
} }
/// 檢測資料庫陣列內是否已經有載入的資料。 /// 檢測資料庫辭典內是否已經有載入的資料。
public func isLoaded() -> Bool { public func isLoaded() -> Bool {
!rangeMap.isEmpty !rangeMap.isEmpty
} }
/// 將資料從檔案讀入至資料庫陣列內。 /// 將資料從檔案讀入至資料庫辭典內。
/// - parameters: /// - parameters:
/// - path: 給定路徑 /// - path: 給定路徑
@discardableResult public mutating func open(_ path: String) -> Bool { @discardableResult public mutating func open(_ path: String) -> Bool {
@ -105,7 +105,7 @@ extension vChewing {
return true return true
} }
/// 將當前語言模組的資料庫陣列自記憶體內卸除。 /// 將當前語言模組的資料庫辭典自記憶體內卸除。
public mutating func close() { public mutating func close() {
if isLoaded() { if isLoaded() {
rangeMap.removeAll() rangeMap.removeAll()
@ -114,7 +114,7 @@ extension vChewing {
// MARK: - Advanced features // MARK: - Advanced features
/// 將當前資料庫陣列的內容以文本的形式輸出至 macOS 內建的 Console.app。 /// 將當前資料庫辭典的內容以文本的形式輸出至 macOS 內建的 Console.app。
/// ///
/// 該功能僅作偵錯之用途。 /// 該功能僅作偵錯之用途。
public func dump() { public func dump() {
@ -130,7 +130,7 @@ extension vChewing {
IME.prtDebugIntel(strDump) IME.prtDebugIntel(strDump)
} }
/// 【該功能無法使用】根據給定的前述讀音索引鍵與當前讀音索引鍵，來獲取資料庫陣列內的對應資料陣列的字串首尾範圍資料、據此自 strData 取得字串形式的資料、生成雙元圖陣列。 /// 【該功能無法使用】根據給定的前述讀音索引鍵與當前讀音索引鍵，來獲取資料庫辭典內的對應資料陣列的字串首尾範圍資料、據此自 strData 取得字串形式的資料、生成雙元圖陣列。
/// ///
/// 威注音輸入法尚未引入雙元圖支援，所以該函式並未擴充相關功能，自然不會起作用。 /// 威注音輸入法尚未引入雙元圖支援，所以該函式並未擴充相關功能，自然不會起作用。
/// - parameters: /// - parameters:
@ -142,7 +142,7 @@ extension vChewing {
precedingKey == key ? [Megrez.Bigram]() : [Megrez.Bigram]() precedingKey == key ? [Megrez.Bigram]() : [Megrez.Bigram]()
} }
/// 根據給定的讀音索引鍵，來獲取資料庫陣列內的對應資料陣列的字串首尾範圍資料、據此自 strData 取得字串形式的資料、生成單元圖陣列。 /// 根據給定的讀音索引鍵，來獲取資料庫辭典內的對應資料陣列的字串首尾範圍資料、據此自 strData 取得字串形式的資料、生成單元圖陣列。
/// - parameters: /// - parameters:
/// - key: 讀音索引鍵 /// - key: 讀音索引鍵
public func unigramsFor(key: String) -> [Megrez.Unigram] { public func unigramsFor(key: String) -> [Megrez.Unigram] {
@ -165,7 +165,7 @@ extension vChewing {
return grams return grams
} }
/// 根據給定的讀音索引鍵來確認資料庫陣列內是否存在對應的資料。 /// 根據給定的讀音索引鍵來確認資料庫辭典內是否存在對應的資料。
/// - parameters: /// - parameters:
/// - key: 讀音索引鍵 /// - key: 讀音索引鍵
public func hasUnigramsFor(key: String) -> Bool { public func hasUnigramsFor(key: String) -> Bool {

16
Source/Modules/LangModelRelated/SubLMs/lmCoreNS.swift
View File

@ -29,7 +29,7 @@ extension vChewing {
/// 這樣一來可以節省在舊 mac 機種內的資料讀入速度。 /// 這樣一來可以節省在舊 mac 機種內的資料讀入速度。
/// 目前僅針對輸入法原廠語彙資料檔案使用 plist 格式。 /// 目前僅針對輸入法原廠語彙資料檔案使用 plist 格式。
@frozen public struct LMCoreNS { @frozen public struct LMCoreNS {
/// 資料庫陣列。索引內容為經過加密的注音字串，資料內容則為 UTF8 資料陣列。 /// 資料庫辭典。索引內容為經過加密的注音字串，資料內容則為 UTF8 資料陣列。
var rangeMap: [String: [Data]] = [:] var rangeMap: [String: [Data]] = [:]
/// 【已作廢】資料庫字串陣列。在 LMCoreNS 內沒有作用。 /// 【已作廢】資料庫字串陣列。在 LMCoreNS 內沒有作用。
var strData: String = "" var strData: String = ""
@ -67,12 +67,12 @@ extension vChewing {
shouldForceDefaultScore = forceDefaultScore shouldForceDefaultScore = forceDefaultScore
} }
/// 檢測資料庫陣列內是否已經有載入的資料。 /// 檢測資料庫辭典內是否已經有載入的資料。
public func isLoaded() -> Bool { public func isLoaded() -> Bool {
!rangeMap.isEmpty !rangeMap.isEmpty
} }
/// 將資料從檔案讀入至資料庫陣列內。 /// 將資料從檔案讀入至資料庫辭典內。
/// - parameters: /// - parameters:
/// - path: 給定路徑 /// - path: 給定路徑
@discardableResult public mutating func open(_ path: String) -> Bool { @discardableResult public mutating func open(_ path: String) -> Bool {
@ -93,7 +93,7 @@ extension vChewing {
return true return true
} }
/// 將當前語言模組的資料庫陣列自記憶體內卸除。 /// 將當前語言模組的資料庫辭典自記憶體內卸除。
public mutating func close() { public mutating func close() {
if isLoaded() { if isLoaded() {
rangeMap.removeAll() rangeMap.removeAll()
@ -102,7 +102,7 @@ extension vChewing {
// MARK: - Advanced features // MARK: - Advanced features
/// 將當前資料庫陣列的內容以文本的形式輸出至 macOS 內建的 Console.app。 /// 將當前資料庫辭典的內容以文本的形式輸出至 macOS 內建的 Console.app。
/// ///
/// 該功能僅作偵錯之用途。 /// 該功能僅作偵錯之用途。
public func dump() { public func dump() {
@ -124,7 +124,7 @@ extension vChewing {
IME.prtDebugIntel(strDump) IME.prtDebugIntel(strDump)
} }
/// 【該功能無法使用】根據給定的前述讀音索引鍵與當前讀音索引鍵，來獲取資料庫陣列內的對應資料陣列的 UTF8 資料、就地分析、生成雙元圖陣列。 /// 【該功能無法使用】根據給定的前述讀音索引鍵與當前讀音索引鍵，來獲取資料庫辭典內的對應資料陣列的 UTF8 資料、就地分析、生成雙元圖陣列。
/// ///
/// 威注音輸入法尚未引入雙元圖支援，所以該函式並未擴充相關功能，自然不會起作用。 /// 威注音輸入法尚未引入雙元圖支援，所以該函式並未擴充相關功能，自然不會起作用。
/// - parameters: /// - parameters:
@ -136,7 +136,7 @@ extension vChewing {
precedingKey == key ? [Megrez.Bigram]() : [Megrez.Bigram]() precedingKey == key ? [Megrez.Bigram]() : [Megrez.Bigram]()
} }
/// 根據給定的讀音索引鍵，來獲取資料庫陣列內的對應資料陣列的 UTF8 資料、就地分析、生成單元圖陣列。 /// 根據給定的讀音索引鍵，來獲取資料庫辭典內的對應資料陣列的 UTF8 資料、就地分析、生成單元圖陣列。
/// - parameters: /// - parameters:
/// - key: 讀音索引鍵 /// - key: 讀音索引鍵
public func unigramsFor(key: String) -> [Megrez.Unigram] { public func unigramsFor(key: String) -> [Megrez.Unigram] {
@ -160,7 +160,7 @@ extension vChewing {
return grams return grams
} }
/// 根據給定的讀音索引鍵來確認資料庫陣列內是否存在對應的資料。 /// 根據給定的讀音索引鍵來確認資料庫辭典內是否存在對應的資料。
/// - parameters: /// - parameters:
/// - key: 讀音索引鍵 /// - key: 讀音索引鍵
public func hasUnigramsFor(key: String) -> Bool { public func hasUnigramsFor(key: String) -> Bool {