Skip to content

Commit

Permalink
update weight docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joshday committed Feb 7, 2018
1 parent 63d6c87 commit 7182228
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/weight.jl
Original file line number Diff line number Diff line change
Expand Up @@ -122,12 +122,12 @@ end
Base.show(io::IO, w::McclainWeight) = print(io, name(w) * "(α = $(w.α))")

#-----------------------------------------------------------------------# Bounded
"""
doc"""
Bounded(w::Weight, λ::Float64)
Bound the weight by a constant.
``γ_{bounded}(t) = max(γ(t), λ)``
``\gamma_t^* = \text{max}(\gamma_t, \lambda)``
# Example
Expand All @@ -143,12 +143,12 @@ Base.max(w::Weight, λ::Float64) = Bounded(w, λ)
Base.max::Float64, w::Weight) = Bounded(w, λ)

#-----------------------------------------------------------------------# Scaled
"""
doc"""
Scaled(w::Weight, λ::Float64)
Scale a weight by a constant.
``γ_{scaled}(t) = λ * γ(t)``
``\gamma_t^* = \lambda * \gamma_t``
# Example
Expand Down

0 comments on commit 7182228

Please sign in to comment.