Skip to content

Commit 17e7168

Browse files
committed
doc-string tweak
1 parent fe5c86c commit 17e7168

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

src/types.jl

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ choosing `probs` to be an array of one higher dimension than the array
1414
generated.
1515
1616
Here the word "probabilities" is an abuse of terminology as there is
17-
no requirement that the that probabilities actually sum to one. Indeed
18-
there is no restriction on the probabilities at all. In particular,
19-
`UnivariateFinite` objects implement arbitrary non-negative, signed,
20-
or complex measures over finite sets of labelled points. A
21-
`UnivariateDistribution` will be a bona fide probability measure when
22-
constructed using the `augment=true` option (see below) or when `fit`
23-
to data. And the probabilities of a `UnivariateFinite` object `d` must
24-
be non-negative, with a non-zero sum, for `rand(d)` to be defined and
25-
interpretable.
17+
no requirement that the that probabilities actually sum to one. The
18+
only requirement is that the probabilities have a common type `T` for
19+
which `zero(T)` is defined. In particular, `UnivariateFinite` objects
20+
implement arbitrary non-negative, signed, or complex measures over
21+
finite sets of labelled points. A `UnivariateDistribution` will be a
22+
bona fide probability measure when constructed using the
23+
`augment=true` option (see below) or when `fit` to data. And the
24+
probabilities of a `UnivariateFinite` object `d` must be non-negative,
25+
with a non-zero sum, for `rand(d)` to be defined and interpretable.
2626
2727
Unless `pool` is specified, `support` should have type
2828
`AbstractVector{<:CategoricalValue}` and all elements are assumed to

0 commit comments

Comments
 (0)