summaryrefslogtreecommitdiffstats
path: root/src/arrow/r/man/MemoryPool.Rd
diff options
context:
space:
mode:
Diffstat (limited to 'src/arrow/r/man/MemoryPool.Rd')
-rw-r--r--src/arrow/r/man/MemoryPool.Rd24
1 files changed, 24 insertions, 0 deletions
diff --git a/src/arrow/r/man/MemoryPool.Rd b/src/arrow/r/man/MemoryPool.Rd
new file mode 100644
index 000000000..75f1882d2
--- /dev/null
+++ b/src/arrow/r/man/MemoryPool.Rd
@@ -0,0 +1,24 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/memory-pool.R
+\docType{class}
+\name{MemoryPool}
+\alias{MemoryPool}
+\title{class arrow::MemoryPool}
+\description{
+class arrow::MemoryPool
+}
+\section{Methods}{
+
+\itemize{
+\item \code{backend_name}: one of "jemalloc", "mimalloc", or "system". Alternative
+memory allocators are optionally enabled at build time. Windows builds
+generally have \code{mimalloc}, and most others have both \code{jemalloc} (used by
+default) and \code{mimalloc}. To change memory allocators at runtime, set the
+environment variable \code{ARROW_DEFAULT_MEMORY_POOL} to one of those strings
+prior to loading the \code{arrow} library.
+\item \code{bytes_allocated}
+\item \code{max_memory}
+}
+}
+
+\keyword{internal}