tests/testthat/test-set_theory.R

In musicMCT: Analyze the Structure of Musical Scales

test_that("sc works", {
  expect_equal(sc(1,1), 0)
  expect_equal(sc(2,4), c(0, 4))
  expect_equal(sc(3, 5), c(0, 1, 6))
  expect_equal(sc(7, 34), c(0, 1, 3, 4, 6, 8, 10))
  expect_equal(sc(11, 1), 0:10)

  expect_error(sc(5, -1))
  expect_error(sc(5, 50))
  expect_error(sc(3, 0))

  expect_error(sc(0,1))
  expect_error(sc(13,5))

  expect_error(sc(4, integer(0)))
  expect_error(sc(7, "oops"))
  expect_error(sc(7, 1:3))
})

test_that("fortenum works", {
  expect_equal(fortenum(3), "1-1")
  expect_equal(fortenum(c(0, 7)), "2-5")
  expect_equal(fortenum(c(0,8,16)), "3-12")
  expect_equal(fortenum(c(0, 4, 7, 10, 12)), "4-27")
  expect_equal(fortenum(setdiff(0:11,6)), "11-1")

  expect_warning(fortenum(c(0,2.5, 6)))
})

test_that("tnprime works", {
  expect_equal(tnprime(NULL), integer(0))
  expect_equal(tnprime(5), 0)
  expect_equal(tnprime(c(0, 3*pi)), c(0, 12-(3*pi)))
  expect_equal(tnprime(c(0, 3, 0)), c(0, 0, 3))
  expect_equal(tnprime(c(0, 1, 7)), c(0, 5, 6))
  expect_equal(tnprime(c(0, 6, 9, 15)), c(0, 3, 6, 9))

  expect_equal(tnprime(c(0, 4, 8), edo=9), c(0, 1, 5))

  just_dia <- 12 * log2(c(1, 9/8, 5/4, 4/3, 3/2, 5/3, 15/8))
  just_tnprime <- 12 * log2(c(1, 16/15, 6/5, 4/3, 64/45, 8/5, 16/9))
  expect_equal(tnprime(just_dia), just_tnprime)
})

test_that("tn works", {
  tetra <- c(0, 2, 3, 6)
  expect_equal(tn(tetra, 1), c(1, 3, 4, 7))
  expect_equal(tn(tetra, 8), c(2, 8, 10, 11))
  expect_equal(tn(tetra, -6), c(0, 6, 8, 9))
  expect_equal(tn(tetra, 8, sorted=FALSE), c(8, 10, 11, 2))
  expect_equal(tn(tetra, 8, edo=31), c(8, 10, 11, 14))

  c_maj <- c(0, 4, 7)
  expect_equal(tn(c_maj, -10), c(2, 6, 9))
  expect_equal(tn(c_maj, -10, octave_equivalence=FALSE), c(-10, -6, -3))
  expect_equal(tn(c_maj, -10, optic="p"), c(-10, -6, -3))
  expect_equal(tn(c_maj, -10, optic=""), c(-10, -6, -3))
  expect_warning(tn(c_maj, 5, optic="opti"))
  expect_warning(tn(c_maj, 5, optic="q"))
  
  satb_cmaj <- c(0, 4, 7, 12)
  expect_equal(tn(satb_cmaj, 5), c(0, 5, 5, 9))
  expect_equal(tn(satb_cmaj, 5, optic=""), c(5, 9, 12, 17))
  expect_equal(tn(satb_cmaj, 5, optic="o"), c(5, 9, 0, 5))
  expect_equal(tn(satb_cmaj, 5, optic="p"), c(5, 9, 12, 17))
  expect_equal(tn(satb_cmaj, 5, optic="c"), c(5, 9, 12, 17))
  expect_equal(tn(satb_cmaj, 5, optic="op"), c(0, 5, 5, 9))
  expect_equal(tn(satb_cmaj, 5, optic="oc"), c(5, 9, 0, 5))
  expect_equal(tn(satb_cmaj, 5, optic="pc"), c(5, 9, 12, 17))
  expect_equal(tn(satb_cmaj, 5, optic="opc"), c(0, 5, 9))  
})

test_that("tni works", {
  tetra <- c(0, 2, 3, 6)
  expect_equal(tni(tetra, 6), c(0, 3, 4, 6))
  expect_equal(tni(tetra, 0), c(0, 6, 9, 10))
  expect_equal(tni(tetra, -11), c(1, 7, 10, 11))
  expect_equal(tni(tetra, 8, sorted=FALSE), c(8, 6, 5, 2))
  expect_equal(tni(tetra, 3, edo=19), c(0, 1, 3, 16))

  test_multiset <- c(0, 1, 0)
  expect_equal(tni(test_multiset, 0), c(0, 0, 11)) 
  expect_equal(tni(test_multiset, 0, optic=""), c(0, -1, 0)) 
  expect_equal(tni(test_multiset, 0, optic="o"), c(0, 11, 0))  
  expect_equal(tni(test_multiset, 0, optic="opc"), c(0, 11)) 

  expect_equal(tni(test_multiset, 0, edo=53), c(0, 0, 52)) 
  expect_equal(tni(test_multiset, 0, optic="", edo=53), c(0, -1, 0)) 
  expect_equal(tni(test_multiset, 0, optic="o", edo=53), c(0, 52, 0)) 
  expect_equal(tni(test_multiset, 0, optic="opc", edo=53), c(0, 52)) 

  expect_equal(tni(c(0, 4, 7)), c(0, 3, 7))
  expect_equal(tni(c(0, 3, 7)), c(0, 4, 7))
  expect_equal(tni(c(1, 5, 8)), c(1, 4, 8))
  expect_equal(tni(c(0, 11, 7)), c(0, 7, 8))
  expect_equal(tni(c(0, 11, 7), optic="p"), c(-4, 0, 7))
  expect_equal(tni(c(0, 11, 7), optic="c"), c(7, -4, 0))
  expect_equal(tni(c(0, 11, 7), optic="o"), c(7, 8, 0))
})

test_that("startzero works", {
  expect_equal(startzero(c(1, 6)), c(0, 5))
  expect_equal(startzero(c(6, 1)), c(0, 7))
  expect_equal(startzero(c(2, 9, 6), sorted=FALSE), c(0, 7, 4))
  expect_equal(startzero(c(1, 3, 9), edo=7), c(0, 1, 2))
})

test_that("charm works", {
  expect_equal(charm(c(2, 6, 9)), c(0, 3, 7))
  expect_equal(charm(c(1, 3, 6, 9)), c(0, 3, 6, 8))
  expect_equal(charm(c(0, 6, 11), edo=19), c(0, 5, 11))
})

test_that("hook_optimize works", {
  test_set <- c(1.2, -.7, -1.7, -1, 1)
  expect_equal(hook_optimize(test_set), 1)
  expect_equal(hook_optimize(test_set, octave_equivalence=FALSE), -0.7)
  expect_equal(hook_optimize(test_set, edo=.71), 0.01)
})

test_that("normal_form works", {
  expect_equal(normal_form(c(-1, 1), optic="ti"), c(0, 2))
  expect_equal(normal_form(c(-2, 1), optic="pi"), c(-1, 2))
  expect_equal(normal_form(c(0, 6), edo=7, optic="op"), c(6, 0))

  two_as <- c(-3, -3)
  expect_equal(normal_form(two_as, optic="t"), c(0, 0))
  expect_equal(normal_form(two_as, optic="tc"), 0)
  expect_equal(normal_form(two_as, optic="i"), c(3, 3))
  expect_equal(normal_form(two_as, optic="ic"), 3)
  expect_equal(normal_form(two_as, optic="oc"), 9)
  expect_equal(normal_form(two_as, optic="c"), -3)
  expect_equal(normal_form(two_as, optic="o"), c(9, 9))
  expect_equal(normal_form(two_as, optic="pc"), -3)

  alpha <- c(-5, -11, 14, 9, 14, 14, 2)
  expect_equal(normal_form(alpha, optic="optic"), c(0, 1, 5, 7))

  expect_equal(normal_form(alpha, optic=""), alpha)
  expect_equal(normal_form(alpha, optic="o"), c(7, 1, 2, 9, 2, 2, 2))
  expect_equal(normal_form(alpha, optic="p"), c(-11, -5, 2, 9, 14, 14, 14))
  expect_equal(normal_form(alpha, optic="op"), c(7, 9, 1, 2, 2, 2, 2))
  expect_equal(normal_form(alpha, optic="oc"), c(7, 1, 2, 9, 2))
  expect_equal(normal_form(alpha, optic="pc"), c(-11, -5, 2, 9, 14))
  expect_equal(normal_form(alpha, optic="opc"), c(7, 9, 1, 2))

  expect_equal(normal_form(alpha, optic="t"), c(0, -6, 19, 14, 19, 19, 7))
  expect_equal(normal_form(alpha, optic="ot"), c(0, 6, 7, 2, 7, 7, 7))
  expect_equal(normal_form(alpha, optic="pt"), c(0, 6, 13, 20, 25, 25, 25))
  expect_equal(normal_form(alpha, optic="tc"), c(0, -6, 19, 14, 19, 7))
  expect_equal(normal_form(alpha, optic="opt"), c(0, 2, 6, 7, 7, 7, 7))
  expect_equal(normal_form(alpha, optic="otc"), c(0, 6, 7, 2, 7))
  expect_equal(normal_form(alpha, optic="ptc"), c(0, 6, 13, 20, 25))
  expect_equal(normal_form(alpha, optic="optc"), c(0, 2, 6, 7))

  expect_equal(normal_form(alpha, optic="i"), c(5, 11, -14, -9, -14, -14, -2))
  expect_equal(normal_form(alpha, optic="oi"), c(5, 11, 10, 3, 10, 10, 10))
  expect_equal(normal_form(alpha, optic="pi"), c(-14, -14, -14, -9, -2, 5, 11))
  expect_equal(normal_form(alpha, optic="ic"), c(5, 11, -14, -9, -14, -2))
  expect_equal(normal_form(alpha, optic="opi"), c(10, 10, 10, 10, 11, 3, 5))
  expect_equal(normal_form(alpha, optic="oic"), c(5, 11, 10, 3, 10))
  expect_equal(normal_form(alpha, optic="pic"), c(-14, -9, -2, 5, 11))
  expect_equal(normal_form(alpha, optic="opic"), c(10, 11, 3, 5))

  expect_equal(normal_form(alpha, optic="ti"), c(0, 6, -19, -14, -19, -19, -7))
  expect_equal(normal_form(alpha, optic="oti"), c(0, 6, 5, 10, 5, 5, 5))
  expect_equal(normal_form(alpha, optic="pti"), c(0, 0, 0, 5, 12, 19, 25))
  expect_equal(normal_form(alpha, optic="tic"), c(0, 6, -19, -14, -19, -7))
  expect_equal(normal_form(alpha, optic="opti"), c(0, 0, 0, 0, 1, 5, 7))
  expect_equal(normal_form(alpha, optic="otic"), c(0, 6, 5, 10, 5))
  expect_equal(normal_form(alpha, optic="ptic"), c(0, 5, 12, 19, 25))
  expect_equal(normal_form(alpha, optic="optic"), c(0, 1, 5, 7))
})

test_that("primeform works", {
  expect_equal(primeform(c(0,1,7)), c(0,1,6))
  expect_equal(primeform(c(0,3,4,8)), c(0,1,4,8))
  expect_equal(primeform(c(4,6,9,10,1)), c(0,1,4,6,9))
  expect_equal(primeform(c(10,4,6,9,1)), c(0,1,4,6,9))  
  expect_equal(primeform(c(0,1,2,4,5,7,9,10)), c(0,1,3,4,5,7,8,10))
  expect_equal(primeform(c(3, 14, 0, 2, 6, 12, 9, 11, 17), edo=19), 
                         c(0, 1, 3, 5, 8, 10, 11, 13, 16))

  just_dia <- 12 * log2(c(1, 9/8, 5/4, 4/3, 3/2, 5/3, 15/8))
  just_prime <- 12 * log2(c(1, 16/15, 32/27, 4/3, 64/45, 8/5, 16/9))
  expect_equal(primeform(just_dia), just_prime)
})

test_that("isym works", {
  expect_true(isym(3))
  expect_true(isym(c(0,4)))
  expect_true(isym(c(0,3,6)))
  expect_false(isym(c(0,3,7)))
  expect_true(isym(c(0,3.5,7)))
  
  just_dia <- 12 * log2(c(1, 9/8, 5/4, 4/3, 3/2, 5/3, 15/8))
  expect_false(isym(just_dia))

  qcm_mmin <- sort((c(0,2,3,4,5,6,8) * meantone_fifth())%%12)
  expect_true(isym(qcm_mmin))
  expect_false(isym(qcm_mmin, rounder=15))

  expect_true(isym(c(0,1,2,4), edo=6))
})

test_that("isym index and degree work", {
  expect_equal(isym(c(0, 3, 6), return_index=TRUE), 6)
  expect_equal(isym(c(0, 1, 6, 7), return_index=TRUE), 7)
  expect_equal(isym_index(c(0, 1, 6, 7)), 7)
  expect_equal(isym(c(1, 6, 7, 12), return_index=TRUE), 1)
  expect_equal(isym(c(0, 1, 6), return_index=TRUE, edo=7), 0)
  expect_equal(isym_index(c(0, 1, 6), edo=7), 0)

  expect_equal(isym(c(0, 2, 4, 5, 7, 9, 11), return_index=TRUE), 4)
  expect_equal(isym(c(0, 2, 3, 5, 7, 9, 10), return_index=TRUE), 0)
  expect_equal(isym(c(0, 1, 3, 5, 7, 8, 10), return_index=TRUE), 8)

  expect_true(is.na(isym(c(0, 3, 7), return_index=TRUE)))
  expect_true(is.na(isym(c(1, 6, 7, 0), return_index=TRUE)))

  expect_equal(isym_degree(c(0, 3, 7)), 0)
  expect_equal(isym_degree(c(0, 4, 8)), 3)
  expect_equal(isym_degree(c(1, 5, 9)), 3)
  expect_equal(isym_degree(c(0, 2, 6, 8)), 2)
  expect_equal(isym_degree(c(0, 1, 3, 6, 7, 9)), 0)
})

test_that("tsym works", {
  expect_false(tsym(NULL))
  expect_false(tsym(1))

  expect_true(tsym(c(0, 1, 6, 7)))
  expect_true(tsym(c(0, 3, 6, 9)))
  expect_false(tsym(c(0, 1, 4, 8)))

  s <- 12 * log2(213/199)
  expect_true(tsym(c(0, s, 4, 4+s, 8, 8+s)))
 
  expect_true(tsym(c(0, 4, 8, 12), edo=16))
  expect_false(tsym(c(0, 4, 8, 12)))
  expect_true(tsym(c(0, 1, 3, 6, 7, 9)))
})

test_that("tsym index and degree work", {
  expect_equal(tsym(0, return_index=TRUE), 0)
  expect_equal(tsym(c(0, 2, 4), return_index=TRUE), 0)
  expect_equal(tsym(c(0, 2, 6, 8), return_index=TRUE), c(0, 6))
  expect_equal(tsym(c(0, 1, 4, 5, 8, 9), return_index=TRUE), c(0, 4, 8))
  expect_equal(tsym(c(0, 1, 3, 6, 7, 9), return_index=TRUE), c(0, 6))
  expect_equal(tsym(c(0, 1, 3, 6, 7, 9), return_index=TRUE, edo=13), 0)
  expect_equal(tsym(c(0, 5, 10), return_index=TRUE, edo=15), c(0, 5, 10))

  expect_equal(tsym_index(0), 0)
  expect_equal(tsym_index(c(0, 2, 4)), 0)
  expect_equal(tsym_index(c(0, 2, 6, 8)), c(0, 6))
  expect_equal(tsym_index(c(0, 1, 4, 5, 8, 9)), c(0, 4, 8))
  expect_equal(tsym_index(c(0, 1, 3, 6, 7, 9)), c(0, 6))
  expect_equal(tsym_index(c(0, 1, 3, 6, 7, 9), edo=13), 0)
  expect_equal(tsym_index(c(0, 5, 10), edo=15), c(0, 5, 10))

  expect_equal(tsym_degree(c(0, 4, 8)), 3)
  expect_equal(tsym_degree(edoo(41)), 41)
})

test_that("ivec works", {
  expect_equal(ivec(c(0, 1, 2, 4, 6, 8, 10)), c(2, 6, 2, 6, 2, 3))
  expect_equal(ivec(c(0, 2, 4, 7, 9), edo=13), c(0, 3, 1, 2, 2, 2))
})

test_that("tc works", {
  expect_equal(tc(c(0, 4, 7), c(0, 1)),
               c(0, 1, 4, 5, 7, 8))
  expect_equal(tc(c(0, 6, 11), c(0, 3, 9), edo=19),
               c(0, 1, 3, 6, 9, 11, 14, 15))
  expect_equal(tc(c(0, 2, 7)), 
               c(0, 2, 4, 7, 9))
})

test_that("clockface works", {
  just_dia <- 12 * log2(c(1, 9/8, 5/4, 4/3, 3/2, 5/3, 15/8))
  jdia_cf <- function() clockface(just_dia)
  vdiffr::expect_doppelganger("Clockface plot of just dia", jdia_cf)

  double_tresillo <- c(0, 3, 6, 9, 12, 14)
  dt_cf <- function() clockface(double_tresillo, edo=16)
  vdiffr::expect_doppelganger("Clockface plot of double tresillo", dt_cf)
})