Skip to content

Commit

Permalink
saner compressor method names
Browse files Browse the repository at this point in the history
  • Loading branch information
jakebolewski committed Jul 10, 2018
1 parent ca4bb2f commit 7a25b6b
Show file tree
Hide file tree
Showing 19 changed files with 402 additions and 92 deletions.
6 changes: 2 additions & 4 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@ S3method(is.anonymous,tiledb_dim)
export(attrs)
export(cell_order)
export(compressor)
export(compressor_level)
export(compressor_type)
export(config)
export(datatype)
export(dimensions)
Expand All @@ -29,6 +27,8 @@ export(tiledb_array_schema)
export(tiledb_attr)
export(tiledb_compressor)
export(tiledb_compressor.tiledb_array_schema)
export(tiledb_compressor_level)
export(tiledb_compressor_name)
export(tiledb_config)
export(tiledb_config_load)
export(tiledb_config_save)
Expand Down Expand Up @@ -62,8 +62,6 @@ exportClasses(tiledb_domain)
exportMethods(attrs)
exportMethods(cell_order)
exportMethods(compressor)
exportMethods(compressor_level)
exportMethods(compressor_type)
exportMethods(config)
exportMethods(datatype)
exportMethods(dimensions)
Expand Down
42 changes: 17 additions & 25 deletions R/Compressor.R
Original file line number Diff line number Diff line change
Expand Up @@ -25,48 +25,40 @@ tiledb_compressor.from_ptr <- function(ptr) {
#' Valid compression levels vary depending on the compressor used,
#' consult the TileDB docs for more information.
#'
#' @param type (default "NO_COMPRESSION") TileDB compression type string
#' @param name (default "NO_COMPRESSION") TileDB compressor name string
#' @param level (default -1) compression level, -1 will fallback to the compression algorithm's default
#' @return tiledb_compressor object
#' @examples
#' c <- tiledb_compressor("ZSTD", 3)
#' c
#'
#' @export tiledb_compressor
tiledb_compressor <- function(type = "NO_COMPRESSION", level = -1L) {
if (!is.scalar(type, "character")) {
tiledb_compressor <- function(name = "NO_COMPRESSION", level = -1L) {
if (!is.scalar(name, "character")) {
stop("compressor argument must be scalar string")
}
if (!is.scalar(level, "double") && ! is.scalar(level, "integer")) {
stop("level argument must be a integer or double scalar value")
} else {
level <- as.integer(level)
}
ptr <- libtiledb_compressor(type, level)
ptr <- libtiledb_compressor(name, level)
return(new("tiledb_compressor", ptr = ptr))
}

#' @export
setGeneric("compressor_type", function(object, ...) standardGeneric("compressor_type"))

#' Returns the compressor's compression type
#'
#' Compression library used
#' Returns the name of the compression library used
#'
#' @param object tiledb_compressor
#' @return TileDB compression type string
#' @return TileDB compression name string
#' @examples
#' c <- tiledb_compressor("ZSTD", 3)
#' compressor_type(c)
#' tiledb_compressor_name(c)
#'
#' @export
setMethod("compressor_type", "tiledb_compressor",
function(object) {
return(libtiledb_compressor_type(object@ptr))
})

#' @export
setGeneric("compressor_level", function(object, ...) standardGeneric("compressor_level"))
tiledb_compressor_name <- function(object) {
stopifnot(is(object, "tiledb_compressor"))
return(libtiledb_compressor_type(object@ptr))
}

#' Returns the compressor's compression level
#'
Expand All @@ -77,14 +69,14 @@ setGeneric("compressor_level", function(object, ...) standardGeneric("compressor
#' compressor_level(c)
#'
#' @export
setMethod("compressor_level", "tiledb_compressor",
function(object) {
return(libtiledb_compressor_level(object@ptr));
})
tiledb_compressor_level <- function(object) {
stopifnot(is(object, "tiledb_compressor"))
return(libtiledb_compressor_level(object@ptr))
}

setMethod("show", "tiledb_compressor",
function(object) {
type <- compressor_type(object)
name <- tiledb_compressor_naem(object)
level <- compressor_level(object)
cat("tiledb_compressor(\"", type, "\", level = ", level, ")", sep="")
cat("tiledb_compressor(\"", name, "\", level = ", level, ")", sep="")
})
2 changes: 1 addition & 1 deletion docs/reference/compressor-tiledb_attr-method.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/dimensions-tiledb_array_schema-method.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/reference/dimensions-tiledb_domain-method.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions docs/reference/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/tiledb_array_create.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 4 additions & 4 deletions docs/reference/tiledb_compressor.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

161 changes: 161 additions & 0 deletions docs/reference/tiledb_compressor_level.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading

0 comments on commit 7a25b6b

Please sign in to comment.