Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
doccstat committed Apr 8, 2024
1 parent e037173 commit 692ef36
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 14 deletions.
13 changes: 6 additions & 7 deletions R/fastcpd.R
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,12 @@
#' the parameters after each gradient descent step. If not specified, the upper
#' bound is set to be \code{Inf} for all parameters.
#' @param pruning_coef Pruning coefficient $c_0$ used in the pruning step of the
#' PELT algorithm in Eq~\eqref{pruning} with the default value 0. If
#' \code{cost_adjustment} is specified as \code{"MBIC"}, an adjustment term
#' \eqn{p\log(2)}{p * log(2)} will be added to the pruning coefficient. If
#' \code{cost_adjustment} is specified as \code{"MDL"}, an adjustment term
#' \eqn{p\log_2(2)}{p * log2(2)} will be added to the pruning coefficient.
#' Detailed discussion about the pruning coefficient can be found in
#' the references.
#' PELT algorithm with the default value 0. If \code{cost_adjustment} is
#' specified as \code{"MBIC"}, an adjustment term \eqn{p\log(2)}{p * log(2)}
#' will be added to the pruning coefficient. If \code{cost_adjustment} is
#' specified as \code{"MDL"}, an adjustment term \eqn{p\log_2(2)}{p * log2(2)}
#' will be added to the pruning coefficient. Detailed discussion about the
#' pruning coefficient can be found in the references.
#' @param segment_count An initial guess of the number of segments. If not
#' specified, the initial guess of the number of segments is 10. The initial
#' guess affects the initial estimates of the parameters in SeGD.
Expand Down
13 changes: 6 additions & 7 deletions man/fastcpd.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 692ef36

Please sign in to comment.