add comments for callable types

Author: xukai92

src/hamiltonian.jl

@@ -6,6 +6,7 @@ struct Hamiltonian{T<:Real,M<:AbstractMetric{T},F1,F2}
     ∂logπ∂θ     ::  F2
 end
 
+# Create a `Hamiltonian` with a new `M⁻¹`
 function (h::Hamiltonian)(M⁻¹)
     return Hamiltonian(h.metric(M⁻¹), h.logπ, h.∂logπ∂θ)
 end

src/integrator.jl

@@ -4,6 +4,7 @@ struct Leapfrog{T<:AbstractFloat} <: AbstractIntegrator
     ϵ   ::  T
 end
 
+# Create a `Leapfrog` with a new `ϵ`
 function (::Leapfrog)(ϵ::AbstractFloat)
     return Leapfrog(ϵ)
 end

src/metric.jl

@@ -8,6 +8,7 @@ function UnitEuclideanMetric(θ::A) where {T<:Real,A<:AbstractVector{T}}
     return UnitEuclideanMetric{T}(length(θ))
 end
 
+# Create a `UnitEuclideanMetric`; required for an unified interface
 function (ue::UnitEuclideanMetric{T})(::Nothing) where {T<:Real}
     return UnitEuclideanMetric{T}(ue.dim)
 end
@@ -22,6 +23,7 @@ struct DiagEuclideanMetric{T<:Real,A<:AbstractVector{T}} <: AbstractMetric{T}
     _temp   ::  A
 end
 
+# Create a `DiagEuclideanMetric` with a new `M⁻¹`
 function (::DiagEuclideanMetric)(M⁻¹::A) where {T<:Real,A<:AbstractVector{T}}
     return DiagEuclideanMetric(M⁻¹)
 end
@@ -46,6 +48,7 @@ struct DenseEuclideanMetric{T<:Real,AV<:AbstractVector{T},AM<:AbstractMatrix{T}}
     _temp   ::  AV
 end
 
+# Create a `DenseEuclideanMetric` with a new `M⁻¹`
 function (::DenseEuclideanMetric)(M⁻¹::A) where {T<:Real,A<:AbstractMatrix{T}}
     return DenseEuclideanMetric(M⁻¹)
 end

src/proposal.jl

@@ -7,6 +7,7 @@ struct TakeLastProposal{I<:AbstractIntegrator} <: StaticTrajectory{I}
     n_steps     ::  Int
 end
 
+# Create a `TakeLastProposal` with a new `ϵ`
 function (tlp::TakeLastProposal)(ϵ::AbstractFloat)
     return TakeLastProposal(tlp.integrator(ϵ), tlp.n_steps)
 end
@@ -22,6 +23,7 @@ struct SliceNUTS{I<:AbstractIntegrator} <: NoUTurnTrajectory{I}
     integrator  ::  I
 end
 
+# Create a `SliceNUTS` with a new `ϵ`
 function (snuts::SliceNUTS)(ϵ::AbstractFloat)
     return SliceNUTS(snuts.integrator(ϵ))
 end