Allow using mode to pick most frequent string value.

tanaylab · Apr 10, 2024 · 5aed40b · 5aed40b
1 parent 4aa5aec
commit 5aed40b
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 4 deletions.
diff --git a/docs/v0.1.0/.documenter-siteinfo.json b/docs/v0.1.0/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-09T17:27:42","documenter_version":"1.3.0"}}
+{"documenter":{"julia_version":"1.10.2","generation_timestamp":"2024-04-10T08:11:56","documenter_version":"1.3.0"}}
diff --git a/docs/v0.1.0/operations.html b/docs/v0.1.0/operations.html
@@ -938,6 +938,14 @@ <h2 id="Reduction-operations">
 </pre>
 <p>Reduction operation that returns the most frequent value in the input (the &quot;mode&quot;).
 </p>
+<div class="admonition is-info">
+<header class="admonition-header">Note
+</header>
+<div class="admonition-body">
+<p>This operation supports strings; most operations do not.
+</p>
+</div>
+</div>
 </div>
 </section>
 </article>

diff --git a/docs/v0.1.0/search_index.js b/docs/v0.1.0/search_index.js
diff --git a/src/operations.jl b/src/operations.jl
@@ -843,6 +843,10 @@ end
     Mode()
 
 Reduction operation that returns the most frequent value in the input (the "mode").
+
+!!! note
+
+    This operation supports strings; most operations do not.
 """
 struct Mode <: ReductionOperation end
 @query_operation Mode
@@ -851,7 +855,7 @@ function Mode(::Token, ::Dict{String, Token})::Mode
     return Mode()
 end
 
-function compute_reduction(operation::Mode, input::StorageMatrix{T})::StorageVector where {T <: StorageNumber}
+function compute_reduction(operation::Mode, input::StorageMatrix)::StorageVector
     output = Vector{reduction_result_type(operation, eltype(input))}(undef, size(input, 2))
     @threads for column_index in 1:length(output)
         column_vector = @view input[:, column_index]
@@ -860,7 +864,7 @@ function compute_reduction(operation::Mode, input::StorageMatrix{T})::StorageVec
     return output
 end
 
-function compute_reduction(::Mode, input::StorageVector{T})::StorageNumber where {T <: StorageNumber}
+function compute_reduction(::Mode, input::StorageVector)::StorageScalar
     return mode(input)
 end