Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jemus42 committed Nov 21, 2024
1 parent fdc5f71 commit e662eb0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 12 deletions.
7 changes: 3 additions & 4 deletions R/RcppExports.R
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@
#' algorithm presented in Zhu (2017).
#'
#' @param Y The \eqn{y} vector of length \eqn{m}
#' @param W The weight matrix \eqn{W} of dimensions \eqn{m x m}
#' @param W The weight matrix \eqn{W} of dimensions \eqn{m \times m}
#' @param m The number of graphs
#' @param eta1 Equals \eqn{\lambda_1 / rho}
#' @param eta2 Equals \eqn{\lambda_2 / rho}
#' @param a Value added to the diagonal of \eqn{-D'D} so that
#' the matrix is positive definite, see
#' \code{\link{matrix_A_inner_ADMM}}
#' the matrix is positive definite, see [CVN::matrix_A_inner_ADMM()]
#' @param rho The ADMM's parameter
#' @param max_iter Maximum number of iterations
#' @param eps Stopping criterion. If differences
Expand All @@ -35,7 +34,7 @@
#' Generalized Lasso Problem. Journal of Computational and Graphical Statistics,
#' 26(1), 195–204. https://doi.org/10.1080/10618600.2015.1114491
#'
#' @seealso \code{\link{genlasso_wrapper}}
#' @seealso genlasso_wrapper
genlassoRcpp <- function(Y, W, m, eta1, eta2, a, rho, max_iter, eps, truncate) {
.Call(`_wflsa_genlassoRcpp`, Y, W, m, eta1, eta2, a, rho, max_iter, eps, truncate)
}
Expand Down
7 changes: 3 additions & 4 deletions man/genlassoRcpp.Rd

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

7 changes: 3 additions & 4 deletions src/genlasso.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,12 @@ using namespace Rcpp;
//' algorithm presented in Zhu (2017).
//'
//' @param Y The \eqn{y} vector of length \eqn{m}
//' @param W The weight matrix \eqn{W} of dimensions \eqn{m x m}
//' @param W The weight matrix \eqn{W} of dimensions \eqn{m \times m}
//' @param m The number of graphs
//' @param eta1 Equals \eqn{\lambda_1 / rho}
//' @param eta2 Equals \eqn{\lambda_2 / rho}
//' @param a Value added to the diagonal of \eqn{-D'D} so that
//' the matrix is positive definite, see
//' \code{\link{matrix_A_inner_ADMM}}
//' the matrix is positive definite, see [CVN::matrix_A_inner_ADMM()]
//' @param rho The ADMM's parameter
//' @param max_iter Maximum number of iterations
//' @param eps Stopping criterion. If differences
Expand All @@ -35,7 +34,7 @@ using namespace Rcpp;
//' Generalized Lasso Problem. Journal of Computational and Graphical Statistics,
//' 26(1), 195–204. https://doi.org/10.1080/10618600.2015.1114491
//'
//' @seealso \code{\link{genlasso_wrapper}}
//' @seealso genlasso_wrapper
// [[Rcpp::export]]
NumericVector genlassoRcpp(const NumericVector Y,
const NumericMatrix W,
Expand Down

0 comments on commit e662eb0

Please sign in to comment.