Skip to content

Add docstring for univariate gradlogpdf #2042

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
devmotion merged 5 commits into from
Mar 8, 2026
+8 −2
Merged

Add docstring for univariate gradlogpdf #2042

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07d6540
Add docstring for univariate `gradlogpdf`
abhro Mar 6, 2026
b964672
Update method docstring for `gradlogpdf`
abhro Mar 7, 2026
07f9cd2
Remove `MethodError` throw from default `gradlogpdf`
abhro Mar 7, 2026
d7d876f
Update `gradlogpdf` signature in univariate.md
abhro Mar 7, 2026
846fb14
Update src/univariates.jl
abhro Mar 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/src/univariate.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ pdfsquaredL2norm
insupport(::UnivariateDistribution, x::Any)
pdf(::UnivariateDistribution, ::Real)
logpdf(::UnivariateDistribution, ::Real)
gradlogpdf(::Distribution, ::Any)
gradlogpdf(::ContinuousUnivariateDistribution, ::Real)
loglikelihood(::UnivariateDistribution, ::AbstractArray)
cdf(::UnivariateDistribution, ::Real)
logcdf(::UnivariateDistribution, ::Real)
Expand Down
9 changes: 8 additions & 1 deletion src/univariates.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,8 +419,15 @@ for which `logccdf(d, x) ≤ lp`.
invlogccdf(d::UnivariateDistribution, lp::Real) = quantile(d, -expm1(lp))

# gradlogpdf
"""
gradlogpdf(d::ContinuousUnivariateDistribution, x::Real)

The derivative of the logarithm of the probability density (mass) function `z -> logpdf(d, z)`
with respect to `z`, evaluated at `z = x`.

gradlogpdf(d::ContinuousUnivariateDistribution, x::Real) = throw(MethodError(gradlogpdf, (d, x)))
See also: [`logpdf`](@ref), [`pdf`](@ref).
"""
gradlogpdf(d::ContinuousUnivariateDistribution, x::Real)


function _pdf_fill_outside!(r::AbstractArray, d::DiscreteUnivariateDistribution, X::UnitRange)
Expand Down
Loading