R/modulo_add.R

Defines functions modulo_add

Documented in modulo_add

#' 1-indexed modular addition
#'
#' Provides modular addition with zero excluded.
#'
#' @param i Starting number
#' @param m Number to be added
#' @param n Modulus. Defaults to 26 for alphabetic modular arithmetic
#'
#' @export
modulo_add <- function(i, m, n = 26) {
  ((i + m - 1) %% n) + 1
}
lewinfox/cypher documentation built on Feb. 4, 2020, 7:24 p.m.