Skip to content

Commit

Permalink
Add documentation for minima & maxima
Browse files Browse the repository at this point in the history
  • Loading branch information
halleysfifthinc committed Mar 30, 2018
1 parent 31dffb0 commit c2286b2
Showing 1 changed file with 22 additions and 0 deletions.
22 changes: 22 additions & 0 deletions src/minmax.jl
Original file line number Diff line number Diff line change
Expand Up @@ -88,3 +88,25 @@ for (funcname, comp) in ((:maxima, :<),
end
end

@doc """
maxima(x,[w=1, includebounds=false])
Find the local maxima of `x`.
If `w` is supplied, point `i` must be the maximum of the surrounding window, `(i-w):(i+w)`.
If `includebounds` is `true`, maxima are allowed to be less than `w` away from the bounds
of the input vector.
""" ->
maxima

@doc """
minima(x,[w=1, includebounds=false])
Find the local minima of `x`.
If `w` is supplied, point `i` must be the minimum of the surrounding window, `(i-w):(i+w)`.
If `includebounds` is `true`, minima are allowed to be less than `w` away from the bounds
of the input vector.
""" ->
minima

0 comments on commit c2286b2

Please sign in to comment.