Skip to content

Commit 7d53614

Browse files
committed
reverse classes/scores order in UnivariateFiniteVector; add kwargs
1 parent 47ea1c1 commit 7d53614

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

src/data_utils.jl

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -332,16 +332,23 @@ UnivariateFinite(::LightInterface, a...; kwargs...) =
332332

333333
const UNIVARIATE_FINITE_VECTOR_DOCSTRING =
334334
"""
335-
UnivariateFiniteVector(scores, classes)
335+
UnivariateFiniteVector(classes, p; pool=nothing, ordered=false)
336336
337337
Container for UnivariateFinite elements optimised for efficiency.
338338
Accessing a single element will construct and return the corresponding
339339
UnivariateFinite lazily.
340+
341+
Here the probabalities `p` should be an array with `size(p, 2) = N`,
342+
where `N = length(classes)` and rows sum to one.
343+
344+
See [`UnivariateFinite`](@ref) for explanation of the `pool` and
345+
`ordered` key-word arguments.
346+
340347
"""
341-
UnivariateFiniteVector(s::AbstractArray) =
342-
UnivariateFiniteVector(get_interface_mode(), s)
343-
UnivariateFiniteVector(s::AbstractArray, c) =
344-
UnivariateFiniteVector(get_interface_mode(), s, c)
348+
UnivariateFiniteVector(s::AbstractArray; kwargs...) =
349+
UnivariateFiniteVector(get_interface_mode(), s; kwargs...)
350+
UnivariateFiniteVector(c::AbstractArray, s::AbstractArray; kwargs...) =
351+
UnivariateFiniteVector(get_interface_mode(), c, s; kwargs...)
345352

346-
UnivariateFiniteVector(::LightInterface, a...) =
353+
UnivariateFiniteVector(::LightInterface, a...; kwargs...) =
347354
errlight("UnivariateFiniteVector")

0 commit comments

Comments
 (0)