add include_self for movmean2

Author: kongdd

DESCRIPTION

@@ -18,7 +18,7 @@ Authors@R: c(
 License: MIT + file LICENSE
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.3
 LinkingTo: 
     Rcpp,
     RcppArmadillo

R/RcppExports.R

@@ -78,16 +78,18 @@ movmean <- function(y, halfwin = 1L, SG_style = FALSE, w = NULL) {
 }
 
 #' @param win_left,win_right windows size in the left and right
+#' @param include_self Whether to include the current point itself in the
+#'   moving window. Default is `TRUE`.
 #' @rdname movmean
 #' @export
-movmean2 <- function(y, win_left = 1L, win_right = 0L, w = NULL) {
-    .Call(`_rtrend_movmean2`, y, win_left, win_right, w)
+movmean2 <- function(y, win_left = 1L, win_right = 0L, w = NULL, include_self = TRUE) {
+    .Call(`_rtrend_movmean2`, y, win_left, win_right, w, include_self)
 }
 
 #' @param mat numeric matrix
 #' @rdname movmean
 #' @export
-movmean_2d <- function(mat, win_left = 3L, win_right = 0L) {
-    .Call(`_rtrend_movmean_2d`, mat, win_left, win_right)
+movmean_2d <- function(mat, win_left = 3L, win_right = 0L, include_self = TRUE) {
+    .Call(`_rtrend_movmean_2d`, mat, win_left, win_right, include_self)
 }
 

man/acf.fft.Rd

@@ -124,29 +124,31 @@ BEGIN_RCPP
 END_RCPP
 }
 // movmean2
-NumericVector movmean2(const arma::rowvec& y, int win_left, int win_right, Nullable<NumericVector> w);
-RcppExport SEXP _rtrend_movmean2(SEXP ySEXP, SEXP win_leftSEXP, SEXP win_rightSEXP, SEXP wSEXP) {
+NumericVector movmean2(const arma::rowvec& y, int win_left, int win_right, Nullable<NumericVector> w, bool include_self);
+RcppExport SEXP _rtrend_movmean2(SEXP ySEXP, SEXP win_leftSEXP, SEXP win_rightSEXP, SEXP wSEXP, SEXP include_selfSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::RNGScope rcpp_rngScope_gen;
     Rcpp::traits::input_parameter< const arma::rowvec& >::type y(ySEXP);
     Rcpp::traits::input_parameter< int >::type win_left(win_leftSEXP);
     Rcpp::traits::input_parameter< int >::type win_right(win_rightSEXP);
     Rcpp::traits::input_parameter< Nullable<NumericVector> >::type w(wSEXP);
-    rcpp_result_gen = Rcpp::wrap(movmean2(y, win_left, win_right, w));
+    Rcpp::traits::input_parameter< bool >::type include_self(include_selfSEXP);
+    rcpp_result_gen = Rcpp::wrap(movmean2(y, win_left, win_right, w, include_self));
     return rcpp_result_gen;
 END_RCPP
 }
 // movmean_2d
-arma::mat movmean_2d(arma::mat& mat, int win_left, int win_right);
-RcppExport SEXP _rtrend_movmean_2d(SEXP matSEXP, SEXP win_leftSEXP, SEXP win_rightSEXP) {
+arma::mat movmean_2d(arma::mat& mat, int win_left, int win_right, bool include_self);
+RcppExport SEXP _rtrend_movmean_2d(SEXP matSEXP, SEXP win_leftSEXP, SEXP win_rightSEXP, SEXP include_selfSEXP) {
 BEGIN_RCPP
     Rcpp::RObject rcpp_result_gen;
     Rcpp::RNGScope rcpp_rngScope_gen;
     Rcpp::traits::input_parameter< arma::mat& >::type mat(matSEXP);
     Rcpp::traits::input_parameter< int >::type win_left(win_leftSEXP);
     Rcpp::traits::input_parameter< int >::type win_right(win_rightSEXP);
-    rcpp_result_gen = Rcpp::wrap(movmean_2d(mat, win_left, win_right));
+    Rcpp::traits::input_parameter< bool >::type include_self(include_selfSEXP);
+    rcpp_result_gen = Rcpp::wrap(movmean_2d(mat, win_left, win_right, include_self));
     return rcpp_result_gen;
 END_RCPP
 }
@@ -161,8 +163,8 @@ static const R_CallMethodDef CallEntries[] = {
     {"_rtrend_smooth_wSG", (DL_FUNC) &_rtrend_smooth_wSG, 4},
     {"_rtrend_smooth_SG", (DL_FUNC) &_rtrend_smooth_SG, 3},
     {"_rtrend_movmean", (DL_FUNC) &_rtrend_movmean, 4},
-    {"_rtrend_movmean2", (DL_FUNC) &_rtrend_movmean2, 4},
-    {"_rtrend_movmean_2d", (DL_FUNC) &_rtrend_movmean_2d, 3},
+    {"_rtrend_movmean2", (DL_FUNC) &_rtrend_movmean2, 5},
+    {"_rtrend_movmean_2d", (DL_FUNC) &_rtrend_movmean_2d, 4},
     {NULL, NULL, 0}
 };
 

man/movmean.Rd

@@ -251,14 +251,17 @@ NumericVector movmean(
 }
 
 //' @param win_left,win_right windows size in the left and right
+//' @param include_self Whether to include the current point itself in the
+//'   moving window. Default is `TRUE`.
 //' @rdname movmean
 //' @export
 // [[Rcpp::export]]
 NumericVector movmean2(
     const arma::rowvec &y,
     int win_left = 1,
     int win_right = 0,
-    Nullable<NumericVector> w = R_NilValue)
+    Nullable<NumericVector> w = R_NilValue,
+    bool include_self = true)
 {
     int n = y.size();
     // arma::rowvec yy(y);
@@ -304,6 +307,7 @@ NumericVector movmean2(
 
         for (int j = i_begin; j <= i_end; j++)
         {
+            if (!include_self && j == i) continue;
             if (Rcpp::traits::is_finite<REALSXP>(y[j]))
             {
                 n_i++;
@@ -324,7 +328,7 @@ NumericVector movmean2(
 //' @rdname movmean
 //' @export
 // [[Rcpp::export]]
-arma::mat movmean_2d(arma::mat& mat, int win_left = 3, int win_right = 0)
+arma::mat movmean_2d(arma::mat& mat, int win_left = 3, int win_right = 0, bool include_self = true)
 {
     int ntime = mat.n_cols;
     int nrow = mat.n_rows;
@@ -338,7 +342,7 @@ arma::mat movmean_2d(arma::mat& mat, int win_left = 3, int win_right = 0)
     // arma::colvec
     for (int i = 0; i < nrow; i++)
     {
-        res.row(i) = Rcpp::as<arma::rowvec>(movmean2(mat.row(i), win_left, win_right));
+        res.row(i) = Rcpp::as<arma::rowvec>(movmean2(mat.row(i), win_left, win_right, R_NilValue, include_self));
     }
     // Rcout << mat << std::endl;
     return res;

man/set_dim.Rd

@@ -20,6 +20,31 @@ test_that("movmean works", {
     expect_true(all.equal(m, m2))
 })
 
+test_that("movmean2 include_self works", {
+    x <- c(4, 8, 6, -1, -2, -3, -1)
+
+    # include_self = TRUE (default): window [i-1, i, i+1]
+    m_with <- movmean2(x, win_left = 1, win_right = 1, include_self = TRUE)
+    # include_self = FALSE: window [i-1, i+1], excludes x[i]
+    m_without <- movmean2(x, win_left = 1, win_right = 1, include_self = FALSE)
+
+    # For interior points they must differ (x is not constant)
+    expect_false(isTRUE(all.equal(m_with[2:6], m_without[2:6])))
+
+    # Manual check for index 2 (1-based): neighbours are x[1]=4 and x[3]=6
+    # include_self=FALSE => mean(4, 6) = 5
+    expect_equal(m_without[2], mean(c(x[1], x[3])))
+
+    # include_self=TRUE  => mean(4, 8, 6) = 6
+    expect_equal(m_with[2], mean(c(x[1], x[2], x[3])))
+
+    # With NA: include_self=FALSE should still skip self even when self is NA
+    x_na <- c(4, NA, 6, -1)
+    m_na <- movmean2(x_na, win_left = 1, win_right = 1, include_self = FALSE)
+    # index 2: neighbours are x[1]=4 and x[3]=6, self (NA) excluded -> mean=5
+    expect_equal(m_na[2], mean(c(x_na[1], x_na[3]), na.rm = TRUE))
+})
+
 
 # test_that("movmean_R works", {
 #     arr = rnorm(5 * 5 * 10) %>% array(dim = c(5, 5, 10))