Make interval equality operator compare start and end of intervals

NAMESPACE

@@ -244,6 +244,8 @@ exportMethods("*")
 exportMethods("+")
 exportMethods("-")
 exportMethods("/")
+exportMethods("==")
+exportMethods("!=")
 exportMethods("[")
 exportMethods("[<-")
 exportMethods("[[")

R/intervals.r

@@ -656,6 +656,51 @@ setMethod("%within%", signature(a = "Interval", b = "list"), function(a, b) {
   out
 })
 
+#' Equality check for Interval objects
+#'
+#' Check whether `e1` and `e2` have the same start and end date-time objects.
+#'
+#' @param e1 An Interval object
+#' @param e2 Another Interval object
+#' @return TRUE if the start and end of `e1` match the start and end of `e1`, otherwise FALSE
+#' @method == Interval
+#' @export
+#' @examples
+#' int1 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+#' int2 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+#' int3 <- interval(as.Date("2021-01-02"), as.Date("2021-12-31"))
+#'
+#' int1 == int2 # TRUE
+#' int1 == int3 # FALSE
+#' c(int1, int2) == c(int2, int3) # TRUE FALSE
+#' int1 == c(int1, int2, int3) # TRUE TRUE FALSE
+#' c(int1, int2, int3) == int1 # TRUE TRUE FALSE
+setMethod("==", signature(e1 = "Interval", e2 = "Interval"), function(e1, e2) {
+  int_start(e1) == int_start(e2) & int_end(e1) == int_end(e2)
+})
+
+#' Inequality check for Interval objects
+#'
+#' Check whether `e1` and `e2` have different start or end date-time objects.
+#'
+#' @param e1 An Interval object
+#' @param e2 Another Interval object
+#' @return TRUE if the start and end of `e1` do not match the start and end of `e1`, otherwise FALSE
+#' @method != Interval
+#' @export
+#' @examples
+#' int1 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+#' int2 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+#' int3 <- interval(as.Date("2021-01-02"), as.Date("2021-12-31"))
+#'
+#' int1 != int2 # FALSE
+#' int1 != int3 # TRUE
+#' c(int1, int2) != c(int2, int3) # FALSE TRUE
+#' int1 != c(int1, int2, int3) # FALSE FALSE TRUE
+#' c(int1, int2, int3) != int1 # FALSE FALSE TRUE
+setMethod("!=", signature(e1 = "Interval", e2 = "Interval"), function(e1, e2) {
+  int_start(e1) != int_start(e2) | int_end(e1) != int_end(e2)
+})
 
 #' @export
 as.list.Interval <- function(x, ...) {

_pkgdown.yml

@@ -80,6 +80,8 @@ reference:
   - as.interval
   - "`%within%`"
   - Interval-class
+  - "`==,Interval,Interval-method`"
+  - "`!=,Interval,Interval-method`"
 
 - title: Timespans
   desc: >

tests/testthat/test-intervals.R

@@ -883,3 +883,35 @@ test_that("Intervals handles missing numbers", {
 
   expect_equal(intersect(int, int), int)
 })
+
+test_that("Equality operator checks for matching start and end", {
+  int1 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+  int2 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+  int3 <- interval(as.Date("2021-01-02"), as.Date("2021-12-31"))
+  int4 <- interval(as.Date("2020-12-31"), as.Date("2021-12-30"))
+
+  expect_true(int1 == int2)
+  expect_false(int1 == int3)
+
+  expect_equal(c(int1, int2) == c(int2, int1), c(TRUE, TRUE))
+  expect_equal(c(int1, int2) == c(int3, int4), c(FALSE, FALSE))
+  expect_equal(c(int1, int2) == c(int2, int3), c(TRUE, FALSE))
+  expect_equal(int1 == c(int1, int2, int3), c(TRUE, TRUE, FALSE))
+  expect_equal(c(int1, int2, int3) == int1, c(TRUE, TRUE, FALSE))
+})
+
+test_that("Inequality operator checks for non matching start and end", {
+  int1 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+  int2 <- interval(as.Date("2021-01-01"), as.Date("2021-12-30"))
+  int3 <- interval(as.Date("2021-01-02"), as.Date("2021-12-31"))
+  int4 <- interval(as.Date("2020-12-31"), as.Date("2021-12-30"))
+
+  expect_false(int1 != int2)
+  expect_true(int1 != int3)
+
+  expect_equal(c(int1, int2) != c(int2, int1), c(FALSE, FALSE))
+  expect_equal(c(int1, int2) != c(int3, int4), c(TRUE, TRUE))
+  expect_equal(c(int1, int2) != c(int2, int3), c(FALSE, TRUE))
+  expect_equal(int1 != c(int1, int2, int3), c(FALSE, FALSE, TRUE))
+  expect_equal(c(int1, int2, int3) != int1, c(FALSE, FALSE, TRUE))
+})