Rename lcm() and gcd() to LCM() and GCD()

NAMESPACE

@@ -1,5 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export(GCD)
+export(LCM)
 export(aoc_delete_day)
 export(aoc_delete_intro)
 export(aoc_delete_year)
@@ -14,6 +16,4 @@ export(aoc_new_year)
 export(aoc_url)
 export(aoc_url_input)
 export(extract_numbers)
-export(gcd)
-export(lcm)
 export(lines_to_matrix)

NEWS.md

@@ -4,5 +4,5 @@
 * Use `readr::read_table()` instead of `readr::read_delim()` in `aoc_input_data_frame()`
 * Add user agent to `aoc_get_input()`
 * Add `extract_numbers()` to extract all numbers from a string
-* Add `gcd()` and `lcm()` for finding greatest common divisor and lowest common multiple
+* Add `GCD()` and `LCM()` for finding greatest common divisor and lowest common multiple
 * Add `lines_to_matrix()`

R/maths-helpers.R

@@ -8,10 +8,10 @@
 #' @return The greatest common divisor of x and y
 #' @export
 #'
-#' @examples gcd(12, 18)
-#' @examples gcd(12, 0)
-#' @examples gcd(13, 2)
-gcd <- function(x, y) {
+#' @examples GCD(12, 18)
+#' @examples GCD(12, 0)
+#' @examples GCD(13, 2)
+GCD <- function(x, y) {
 	while (y != 0) {
 		t <- y
 		y <- x %% y
@@ -21,11 +21,11 @@ gcd <- function(x, y) {
 }
 
 
-#' @rdname gcd
+#' @rdname GCD
 #' @export
-#' @examples lcm(12, 18)
-#' @examples lcm(2, 6)
-#' @examples lcm(3, 5)
-lcm <- function(x, y) {
-	x * y / gcd(x, y)
+#' @examples LCM(12, 18)
+#' @examples LCM(2, 6)
+#' @examples LCM(3, 5)
+LCM <- function(x, y) {
+	x * y / GCD(x, y)
 }

_pkgdown.yml

@@ -40,5 +40,5 @@ reference:
     - extract_numbers
   - title: "Maths helper functions"
     contents:
-    - gcd
-    - lcm
+    - GCD
+    - LCM

tests/testthat/test-maths-helpers.R

@@ -1,13 +1,13 @@
-# write tests for gcd
-test_that("gcd works", {
-	expect_equal(gcd(12, 18), 6)
-	expect_equal(gcd(12, 0), 12)
-	expect_equal(gcd(13, 2), 1)
+# write tests for GCD
+test_that("GCD works", {
+	expect_equal(GCD(12, 18), 6)
+	expect_equal(GCD(12, 0), 12)
+	expect_equal(GCD(13, 2), 1)
 })
 
-# write tests for lcm
-test_that("lcm works", {
-	expect_equal(lcm(12, 18), 36)
-	expect_equal(lcm(2, 6), 6)
-	expect_equal(lcm(3, 5), 15)
+# write tests for LCM
+test_that("LCM works", {
+	expect_equal(LCM(12, 18), 36)
+	expect_equal(LCM(2, 6), 6)
+	expect_equal(LCM(3, 5), 15)
 })