Add wiki documentation for frequency_table, frequency_table_with_null, entropy, and average_entropy#1091
Closed
Add wiki documentation for frequency_table, frequency_table_with_null, entropy, and average_entropy#1091
Conversation
Closed
4 tasks
…, entropy, and average_entropy Agent-Logs-Url: https://github.com/ObjectVision/GeoDMS/sessions/c199675d-17f4-40b6-b8b2-de0ac1a8a9b9 Co-authored-by: MaartenHilferink <2284361+MaartenHilferink@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation for new functions in Modus.cpp
Add wiki documentation for frequency_table, frequency_table_with_null, entropy, and average_entropy
Apr 7, 2026
Collaborator
|
@copilot ... how do I get these new pages into the repository's wiki? |
Author
The wiki pages are in the git clone https://github.com/ObjectVision/GeoDMS.wiki.git
cd GeoDMS.wiki
# Copy the new/updated files from the main repo
cp /path/to/GeoDMS/wiki/frequency_table.md .
cp /path/to/GeoDMS/wiki/frequency_table_with_null.md .
cp /path/to/GeoDMS/wiki/entropy.md .
cp /path/to/GeoDMS/wiki/average_entropy.md .
git add frequency_table.md frequency_table_with_null.md entropy.md average_entropy.md
git commit -m "Add documentation for frequency_table, frequency_table_with_null, entropy, and average_entropy"
git push origin masterAlternatively, you can edit the pages directly on GitHub at https://github.com/ObjectVision/GeoDMS/wiki — create new pages for |
Collaborator
|
Already merged into working copy and pushed to wiki. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Four aggregation functions implemented in
Modus.cpphave been undocumented since v14.4.0. This PR adds/updates their wiki pages inwiki/.Changes
wiki/frequency_table.md— Updated stub with full description: per-partition output format ("value1: count1; value2: count2; ..."), null-exclusion behavior, correct value type coverage (any scalar, not just string), and cross-reference tofrequency_table_with_nullwiki/frequency_table_with_null.md— New page; same asfrequency_tablebut null values inaare counted and emitted as<null>: countwiki/entropy.md— New page; documents total Shannon entropy:entropy(a) = −∑ nᵢ · log₂(nᵢ/N)= N · H(a)wiki/average_entropy.md— New page; documents per-element Shannon entropy:average_entropy(a) = H(a) = entropy(a) / N = −∑ pᵢ · log₂(pᵢ)Key distinction between entropy functions
entropy(a, rel)−∑ nᵢ · log₂(nᵢ/N)average_entropy(a, rel)−∑ pᵢ · log₂(pᵢ)All pages follow existing wiki conventions (syntax / definition / description / applies-to / conditions / since version / example / see-also).