R/is.equal-tempered.R

Defines functions is.equal_tempered.sparse_pi_spectrum is.equal_tempered.pc_chord is.equal_tempered.pc_set is.equal_tempered.pi_chord is.equal_tempered

Documented in is.equal_tempered is.equal_tempered.pc_chord is.equal_tempered.pc_set is.equal_tempered.pi_chord is.equal_tempered.sparse_pi_spectrum

#' Check for equal temperament
#'
#' Checks whether a chord is equal-tempered.
#' @param x Chord to check.
#' @param ... Further arguments passed to other methods.
#' @return Returns \code{TRUE} if the chord is equal-tempered,
#' \code{FALSE} otherwise.
#' @rdname is.equal_tempered
#' @export
is.equal_tempered <- function(x, ...) {
  UseMethod("is.equal_tempered")
}

#' @rdname is.equal_tempered
#' @export
is.equal_tempered.pi_chord <- function(x, ...) {
  checkmate::qtest(x, "X")
}

#' @rdname is.equal_tempered
#' @export
is.equal_tempered.pc_set <- function(x, ...) {
  checkmate::qtest(x, "X")
}

#' @rdname is.equal_tempered
#' @export
is.equal_tempered.pc_chord <- function(x, ...) {
  checkmate::qtest(x, "X")
}

#' @rdname is.equal_tempered
#' @export
is.equal_tempered.sparse_pi_spectrum <- function(x, ...) {
  checkmate::qtest(pitch(x), "X")
}
pmcharrison/hrep documentation built on Feb. 18, 2024, 2:33 a.m.