| % Generated by roxygen2: do not edit by hand |
| % Please edit documentation in R/chunked-array.R |
| \docType{class} |
| \name{ChunkedArray} |
| \alias{ChunkedArray} |
| \alias{chunked_array} |
| \title{ChunkedArray class} |
| \usage{ |
| chunked_array(..., type = NULL) |
| } |
| \arguments{ |
| \item{\dots}{Vectors to coerce} |
| |
| \item{type}{currently ignored} |
| } |
| \description{ |
| A \code{ChunkedArray} is a data structure managing a list of |
| primitive Arrow \link[=Array]{Arrays} logically as one large array. Chunked arrays |
| may be grouped together in a \link{Table}. |
| } |
| \section{Factory}{ |
| |
| The \code{ChunkedArray$create()} factory method instantiates the object from |
| various Arrays or R vectors. \code{chunked_array()} is an alias for it. |
| } |
| |
| \section{Methods}{ |
| |
| \itemize{ |
| \item \verb{$length()}: Size in the number of elements this array contains |
| \item \verb{$chunk(i)}: Extract an \code{Array} chunk by integer position |
| \item \verb{$as_vector()}: convert to an R vector |
| \item \verb{$Slice(offset, length = NULL)}: Construct a zero-copy slice of the array |
| with the indicated offset and length. If length is \code{NULL}, the slice goes |
| until the end of the array. |
| \item \verb{$Take(i)}: return a \code{ChunkedArray} with values at positions given by |
| integers \code{i}. If \code{i} is an Arrow \code{Array} or \code{ChunkedArray}, it will be |
| coerced to an R vector before taking. |
| \item \verb{$Filter(i, keep_na = TRUE)}: return a \code{ChunkedArray} with values at positions where |
| logical vector or Arrow boolean-type \verb{(Chunked)Array} \code{i} is \code{TRUE}. |
| \item \verb{$cast(target_type, safe = TRUE, options = cast_options(safe))}: Alter the |
| data in the array to change its type. |
| \item \verb{$null_count()}: The number of null entries in the array |
| \item \verb{$chunks()}: return a list of \code{Array}s |
| \item \verb{$num_chunks()}: integer number of chunks in the \code{ChunkedArray} |
| \item \verb{$type()}: logical type of data |
| \item \verb{$View(type)}: Construct a zero-copy view of this \code{ChunkedArray} with the |
| given type. |
| \item \verb{$Validate()}: Perform any validation checks to determine obvious inconsistencies |
| within the array's internal data. This can be an expensive check, potentially \code{O(length)} |
| } |
| } |
| |
| \seealso{ |
| \link{Array} |
| } |