add average frequency tag

ext/css/display.css

@@ -1934,6 +1934,15 @@ button.footer-notification-close-button {
 :root[data-anki-enabled=false] .action-button[data-action=save-note] {
     display: none;
 }
+
+:root[data-average-frequency=false] .frequency-group-item:last-child {
+    display: none;
+}
+
+:root[data-average-frequency=true] .frequency-group-item:not(:last-child) {
+    display: none;
+}
+
 :root[data-audio-enabled=false] .action-button[data-action=play-audio] {
     display: none;
 }

ext/data/schemas/options-schema.json

@@ -102,6 +102,7 @@
                                     "showGuide",
                                     "enableContextMenuScanSelected",
                                     "compactTags",
+                                    "averageFrequency",
                                     "glossaryLayoutMode",
                                     "mainDictionary",
                                     "popupTheme",
@@ -236,6 +237,10 @@
                                         "type": "boolean",
                                         "default": false
                                     },
+                                    "averageFrequency": {
+                                        "type": "boolean",
+                                        "default": false
+                                    },
                                     "glossaryLayoutMode": {
                                         "type": "string",
                                         "enum": ["default", "compact"],

ext/js/dictionary/dictionary-data-util.js

@@ -82,18 +82,57 @@ export function groupTermFrequencies(dictionaryEntry) {
     }
 
     const results = [];
+
+    /** @type {import('dictionary').AverageFrequencyListTerm} */
+    const averages = {};
     for (const [dictionary, map2] of map1.entries()) {
         const frequencies = [];
         const dictionaryAlias = aliasMap.get(dictionary) ?? dictionary;
-        for (const {term, reading, values} of map2.values()) {
+        for (let {term, reading, values} of map2.values()) {
             frequencies.push({
                 term,
                 reading,
                 values: [...values.values()],
             });
+            const valuesArray = [...values.values()];
+            if (reading === null) { reading = ''; }
+            let {currentAvg, count} = averages[term]?.[reading] ?? {currentAvg: 1, count: 0};
+            if (valuesArray[0].frequency === null) { continue; }
+
+            currentAvg = (count / (currentAvg)) + (1 / (valuesArray[0].frequency));
+            currentAvg = (count + 1) / currentAvg;
+            count += 1;
+
+            averages[term] = {
+                ...averages[term],
+                [reading]: {
+                    currentAvg, count,
+                },
+            };
         }
         results.push({dictionary, frequencies, dictionaryAlias});
     }
+
+    for (const currentTerm of Object.keys(averages)) {
+        const readingArray = Object.keys(averages[currentTerm]);
+        const nullIndex = readingArray.indexOf('');
+        if (readingArray.length === 2 && nullIndex >= 0) {
+            const avg1 = averages[currentTerm][readingArray[0]].currentAvg;
+            const count1 = averages[currentTerm][readingArray[0]].count;
+            const avg2 = averages[currentTerm][readingArray[1]].currentAvg;
+            const count2 = averages[currentTerm][readingArray[1]].count;
+
+            const newcount = count1 + count2;
+            const newavg = newcount / (count1 / avg1 + count2 / avg2);
+
+            averages[currentTerm][readingArray[nullIndex === 0 ? 1 : 0]] = {currentAvg: newavg, count: newcount};
+            delete averages[currentTerm][''];
+        }
+    }
+
+    const avgFrequencies = Object.keys(averages).flatMap((termName) => Object.keys(averages[termName]).map((readingName) => ({term: termName, reading: readingName, values: [{frequency: Math.round(averages[termName][readingName].currentAvg), displayValue: Math.round(averages[termName][readingName].currentAvg).toString()}]})));
+    results.push({dictionary: 'Average', frequencies: avgFrequencies, dictionaryAlias: 'Average'});
+
     return results;
 }
 

ext/js/display/display.js

@@ -1175,6 +1175,7 @@ export class Display extends EventDispatcher {
         data.resultOutputMode = `${options.general.resultOutputMode}`;
         data.glossaryLayoutMode = `${options.general.glossaryLayoutMode}`;
         data.compactTags = `${options.general.compactTags}`;
+        data.averageFrequency = `${options.general.averageFrequency}`;
         data.frequencyDisplayMode = `${options.general.frequencyDisplayMode}`;
         data.termDisplayMode = `${options.general.termDisplayMode}`;
         data.enableSearchTags = `${options.scanning.enableSearchTags}`;

ext/settings.html

@@ -1122,6 +1122,15 @@ <h1>Yomitan Settings</h1>
                 </div></div>
             </div>
         </div>
+        <div class="settings-item"><div class="settings-item-inner">
+            <div class="settings-item-left">
+                <div class="settings-item-label">Average frequencies</div>
+                <div class="settings-item-description">Compress frequency tags into one "Average" freqeuncy tag.</div>
+            </div>
+            <div class="settings-item-right">
+                <label class="toggle"><input type="checkbox" data-setting="general.averageFrequency"><span class="toggle-body"><span class="toggle-track"></span><span class="toggle-knob"></span></span></label>
+            </div>
+        </div></div>
     </div>
 
     <!-- Popup Position & Size -->

test/options-util.test.js

@@ -56,6 +56,7 @@ function createProfileOptionsTestData1() {
             popupScaleRelativeToVisualViewport: true,
             showGuide: true,
             compactTags: false,
+            averageFrequency: false,
             compactGlossaries: false,
             mainDictionary: '',
             popupTheme: 'default',
@@ -278,6 +279,7 @@ function createProfileOptionsUpdatedTestData1() {
             showGuide: true,
             enableContextMenuScanSelected: true,
             compactTags: false,
+            averageFrequency: false,
             glossaryLayoutMode: 'default',
             mainDictionary: '',
             popupTheme: 'light',

types/ext/dictionary.d.ts

@@ -544,3 +544,27 @@ export type TermSource = {
      */
     isPrimary: boolean;
 };
+
+/**
+ * Dictionaries containing the harmonic mean frequency of specific term-reading pairs.
+ */
+export type AverageFrequencyListTerm = {
+    /**
+     * Contains the average frequency of a term, with all its readings.
+     */
+    [term: string]: {
+        /**
+         * Contains the average frequency of a reading.
+         */
+        [reading: string]: {
+            /**
+             * The current average frequency.
+             */
+            currentAvg: number;
+            /**
+             * The number of dictionary frequencies used to compute the average.
+             */
+            count: number;
+        };
+    };
+};

types/ext/settings.d.ts

@@ -127,6 +127,7 @@ export type GeneralOptions = {
     showGuide: boolean;
     enableContextMenuScanSelected: boolean;
     compactTags: boolean;
+    averageFrequency: boolean;
     glossaryLayoutMode: GlossaryLayoutMode;
     mainDictionary: string;
     popupTheme: PopupTheme;