tests/testthat/test-sparse.r

In tensorr: Sparse Tensors in R

context("sparse")

# test data
subs <- matrix(c(1,1,1, 1,1,2), c(3,2))
vals <- c(10,20)
dims <- c(2,2,2)
X <- sptensor(subs, vals, dims)

test_that("sparse tensor is initialized given subs, vals, dims", {
  expect_equal(X@subs, subs)
  expect_equal(X@vals, vals)
  expect_equal(X@dims, dims)

  expect_true(is_sptensor(X))
})

test_that("sparse tensor is initialized when vals missing", {
  X <- sptensor(subs, dims = dims)

  expect_equal(X@subs, subs)
  expect_equal(X@vals, c(1,1))
  expect_equal(X@dims, dims)
})

test_that("sparse tensor is initialized with a list of subscripts", {
  subslist <- list(c(1,1,1), c(1,1,2))
  X <- sptensor(subslist, vals, dims = dims)

  expect_equal(X@subs, subs)
  expect_equal(X@vals, vals)
  expect_equal(X@dims, dims)
})

test_that("sparse tensor is initialized correctly", {
  expect_equal(X@subs, subs)
  expect_equal(X@vals, vals)
  expect_equal(X@dims, dims)
})

test_that("sparse tensor throws errors for empty subs, vals, or dims", {
  expect_error(sptensor(numeric(0), vals, dims))
  expect_error(sptensor(subs, double(0), dims))
  expect_error(sptensor(subs, vals, integer(0)))
})

test_that("sparse tensors are considered tensors", {
  expect_true(is_tensor(X))
})

test_that("sparse tensors have correct length", {
  expect_equal(length(X), 8)
})

test_that("sparse tensors show outputs", {
  expect_output(show(X))
})

test_that("sparse tensors show empty outputs", {
  subs2 <- matrix(integer(0L), nrow = length(dims))
  vals2 <- integer(0L)
  X2 <- sptensor(subs2, vals2, dims)
  expect_output(show(X2))
})

test_that("sparse tensors show truncated outputs", {
  subs2 <- array_index(1:8, dims)
  vals2 <- 1:8
  X2 <- sptensor(subs2, vals2, dims)
  expect_output(show(X2))
})

test_that("nzvals returns vals for sparse tensor", {
  expect_equal(nzvals(X), X@vals)
})

test_that("nzsubs returns subs for sparse tensor", {
  expect_equal(nzsubs(X), X@subs)
})

test_that("zsubs returns zero subscripts for dense tensor", {
  expect_equal(zsubs(X), array_index(c(2,3,4,6,7,8), dims))
})

test_that("nzsubs returns non-zero subscripts for dense tensor", {
  expect_equal(allsubs(X), array_index(seq_along(X), dims))
})

test_that("sparse tensor is initialized with a list of NULL dimnames", {
  actual <- dimnames(X)
  expected <- vector("list", length(dims))
  expect_identical(actual, expected)
})

test_that("setting dimnames to NULL will throw warning and convert to list of NULLs", {
  expect_warning(dimnames(X) <- NULL)
  expect_equal(dimnames(X), list(NULL, NULL, NULL))
})

test_that("dimnames cannot be set to arbitrary values", {
  expect_error(dimnames(X) <- 3)
  expect_error(dimnames(X) <- list(NULL, NULL))
  expect_error(dimnames(X) <- list(LETTERS[1:10], LETTERS[1:10], month.abb[1:10]))
})