Merge pull request #32 from EmilHvitfeldt/better-interface

make user facing function not start with new_

NAMESPACE

@@ -1,5 +1,5 @@
 # Generated by roxygen2: do not edit by hand
 
-export(new_sparse_double)
+export(sparse_double)
 import(rlang)
 useDynLib(sparsevctrs, .registration = TRUE)

R/altrep.R

@@ -1,4 +1,4 @@
-#' Create sparse numeric vector
+#' Create sparse double vector
 #' 
 #' @param value Numeric vector, values of non-zero entries.
 #' @param position integer vector, indices of non-zero entries.
@@ -11,8 +11,16 @@
 #' setting `options("sparsevctrs.verbose_materialize" = TRUE)` will print a 
 #' message each time a sparse vector has been forced to materialize.
 #'
+#' @examples
+#' sparse_double(numeric(), integer(), 10)
+#' 
+#' sparse_double(c(pi, 5, 0.1), c(2, 5, 10), 10)
+#' 
+#' str(
+#'   sparse_double(c(pi, 5, 0.1), c(2, 5, 10), 1000000000)
+#' )
 #' @export
-new_sparse_double <- function(value, position, length) {
+sparse_double <- function(value, position, length) {
   check_number_whole(length, min = 0)
   if (!is.integer(length)) {
     length <- as.integer(length)
@@ -127,6 +135,10 @@ new_sparse_double <- function(value, position, length) {
     )
   }
 
+  new_sparse_double(value, position, length)
+}
+
+new_sparse_double <- function(value, position, length) {
   x <- list(
     val = value, 
     pos = position, 

README.Rmd

@@ -38,19 +38,19 @@ remotes::install_github("emilhvitfeldt/sparsevctrs")
 ```{r}
 library(sparsevctrs)
 
-x <- new_sparse_vector(4, 7, 10)
+x <- sparse_double(4, 7, 10)
 
 x
 sum(x)
 
-new_sparse_vector(4, 7, 10) + new_sparse_vector(3, 2, 10)
+sparse_double(4, 7, 10) + sparse_double(3, 2, 10)
 ```
 
 This class is compatible with tibbles
 
 ```{r}
 library(tibble)
 
-tibble(x = sample(1:10), y = new_sparse_vector(1, 7, 10))
+tibble(x = sample(1:10), y = sparse_double(1, 7, 10))
 ```
 

README.md

@@ -28,36 +28,35 @@ remotes::install_github("emilhvitfeldt/sparsevctrs")
 ``` r
 library(sparsevctrs)
 
-x <- new_sparse_vector(4, 7, 10)
+x <- sparse_double(4, 7, 10)
 
 x
-#> <sparse_vector[10]>
 #>  [1] 0 0 0 0 0 0 4 0 0 0
 sum(x)
 #> [1] 4
 
-new_sparse_vector(4, 7, 10) + new_sparse_vector(3, 2, 10)
-#> <sparse_vector[10]>
-#>  [1] 0 3 0 0 0 0 4 0 0 0
+sparse_double(4, 7, 10) + sparse_double(3, 2, 10)
+#>  [1] 3.456532e-314 2.847320e-314 2.714492e-314 2.927164e-314 4.940656e-323
+#>  [6]  0.000000e+00  0.000000e+00  3.000000e+00  0.000000e+00  0.000000e+00
 ```
 
 This class is compatible with tibbles
 
 ``` r
 library(tibble)
 
-tibble(x = sample(1:10), y = new_sparse_vector(1, 7, 10))
+tibble(x = sample(1:10), y = sparse_double(1, 7, 10))
 #> # A tibble: 10 × 2
-#>        x       y
-#>    <int> <spvtr>
-#>  1    10       0
-#>  2     6       0
-#>  3     5       0
-#>  4     4       0
-#>  5     1       0
-#>  6     8       0
-#>  7     2       1
-#>  8     7       0
-#>  9     9       0
-#> 10     3       0
+#>        x     y
+#>    <int> <dbl>
+#>  1    10     0
+#>  2     6     0
+#>  3     5     0
+#>  4     4     0
+#>  5     1     0
+#>  6     8     0
+#>  7     2     1
+#>  8     7     0
+#>  9     9     0
+#> 10     3     0
 ```