| |
| |
| <!DOCTYPE html> |
| |
| |
| <html lang="en" data-content_root="" > |
| |
| <head> |
| <meta charset="utf-8" /> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" /> |
| |
| <title>Array Builders — Apache Arrow v17.0.0.dev52</title> |
| |
| |
| |
| <script data-cfasync="false"> |
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; |
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"; |
| </script> |
| |
| <!-- Loaded before other Sphinx assets --> |
| <link href="../../_static/styles/theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/bootstrap.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link href="../../_static/styles/pydata-sphinx-theme.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| |
| |
| <link href="../../_static/vendor/fontawesome/6.5.1/css/all.min.css?digest=8d27b9dea8ad943066ae" rel="stylesheet" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-solid-900.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-brands-400.woff2" /> |
| <link rel="preload" as="font" type="font/woff2" crossorigin href="../../_static/vendor/fontawesome/6.5.1/webfonts/fa-regular-400.woff2" /> |
| |
| <link rel="stylesheet" type="text/css" href="../../_static/pygments.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/copybutton.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css" /> |
| <link rel="stylesheet" type="text/css" href="../../_static/theme_overrides.css" /> |
| |
| <!-- Pre-loaded scripts that we'll load fully later --> |
| <link rel="preload" as="script" href="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae" /> |
| <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae" /> |
| <script src="../../_static/vendor/fontawesome/6.5.1/js/all.min.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script> |
| <script src="../../_static/doctools.js"></script> |
| <script src="../../_static/sphinx_highlight.js"></script> |
| <script src="../../_static/clipboard.min.js"></script> |
| <script src="../../_static/copybutton.js"></script> |
| <script src="../../_static/design-tabs.js"></script> |
| <script>DOCUMENTATION_OPTIONS.pagename = 'cpp/api/builder';</script> |
| <script> |
| DOCUMENTATION_OPTIONS.theme_version = '0.15.2'; |
| DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/docs/_static/versions.json'; |
| DOCUMENTATION_OPTIONS.theme_switcher_version_match = 'dev/'; |
| DOCUMENTATION_OPTIONS.show_version_warning_banner = true; |
| </script> |
| <link rel="canonical" href="https://arrow.apache.org/docs/cpp/api/builder.html" /> |
| <link rel="icon" href="../../_static/favicon.ico"/> |
| <link rel="index" title="Index" href="../../genindex.html" /> |
| <link rel="search" title="Search" href="../../search.html" /> |
| <link rel="next" title="Two-dimensional Datasets" href="table.html" /> |
| <link rel="prev" title="Scalars" href="scalar.html" /> |
| |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <meta name="docsearch:language" content="en"/> |
| |
| <!-- Matomo --> |
| <script> |
| var _paq = window._paq = window._paq || []; |
| /* tracker methods like "setCustomDimension" should be called before "trackPageView" */ |
| /* We explicitly disable cookie tracking to avoid privacy issues */ |
| _paq.push(['disableCookies']); |
| _paq.push(['trackPageView']); |
| _paq.push(['enableLinkTracking']); |
| (function() { |
| var u="https://analytics.apache.org/"; |
| _paq.push(['setTrackerUrl', u+'matomo.php']); |
| _paq.push(['setSiteId', '20']); |
| var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; |
| g.async=true; g.src=u+'matomo.js'; s.parentNode.insertBefore(g,s); |
| })(); |
| </script> |
| <!-- End Matomo Code --> |
| |
| </head> |
| |
| |
| <body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode=""> |
| |
| |
| |
| <a id="pst-skip-link" class="skip-link" href="#main-content">Skip to main content</a> |
| |
| <div id="pst-scroll-pixel-helper"></div> |
| |
| <button type="button" class="btn rounded-pill" id="pst-back-to-top"> |
| <i class="fa-solid fa-arrow-up"></i> |
| Back to top |
| </button> |
| |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__primary" |
| id="__primary"/> |
| <label class="overlay overlay-primary" for="__primary"></label> |
| |
| <input type="checkbox" |
| class="sidebar-toggle" |
| name="__secondary" |
| id="__secondary"/> |
| <label class="overlay overlay-secondary" for="__secondary"></label> |
| |
| <div class="search-button__wrapper"> |
| <div class="search-button__overlay"></div> |
| <div class="search-button__search-container"> |
| <form class="bd-search d-flex align-items-center" |
| action="../../search.html" |
| method="get"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <input type="search" |
| class="form-control" |
| name="q" |
| id="search-input" |
| placeholder="Search the docs ..." |
| aria-label="Search the docs ..." |
| autocomplete="off" |
| autocorrect="off" |
| autocapitalize="off" |
| spellcheck="false"/> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span> |
| </form></div> |
| </div> |
| |
| <header class="bd-header navbar navbar-expand-lg bd-navbar"> |
| <div class="bd-header__inner bd-page-width"> |
| <label class="sidebar-toggle primary-toggle" for="__primary"> |
| <span class="fa-solid fa-bars"></span> |
| </label> |
| |
| |
| <div class="col-lg-3 navbar-header-items__start"> |
| |
| <div class="navbar-item"> |
| |
| |
| |
| <a class="navbar-brand logo" href="../../index.html"> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <img src="../../_static/arrow.png" class="logo__image only-light" alt="Apache Arrow v17.0.0.dev52 - Home"/> |
| <script>document.write(`<img src="../../_static/arrow-dark.png" class="logo__image only-dark" alt="Apache Arrow v17.0.0.dev52 - Home"/>`);</script> |
| |
| |
| </a></div> |
| |
| </div> |
| |
| <div class="col-lg-9 navbar-header-items"> |
| |
| <div class="me-auto navbar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| <div class="navbar-header-items__end"> |
| |
| <div class="navbar-item navbar-persistent--container"> |
| |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-2" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-2" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-2" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-2"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| |
| <div class="navbar-persistent--mobile"> |
| |
| <script> |
| document.write(` |
| <button class="btn navbar-btn search-button-field search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <i class="fa-solid fa-magnifying-glass"></i> |
| <span class="search-button__default-text">Search</span> |
| <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span> |
| </button> |
| `); |
| </script> |
| </div> |
| |
| |
| |
| <label class="sidebar-toggle secondary-toggle" for="__secondary" tabindex="0"> |
| <span class="fa-solid fa-outdent"></span> |
| </label> |
| |
| </div> |
| |
| </header> |
| |
| |
| <div class="bd-container"> |
| <div class="bd-container__inner bd-page-width"> |
| |
| |
| |
| <div class="bd-sidebar-primary bd-sidebar"> |
| |
| |
| |
| <div class="sidebar-header-items sidebar-primary__section"> |
| |
| |
| <div class="sidebar-header-items__center"> |
| |
| <div class="navbar-item"> |
| <nav class="navbar-nav"> |
| <ul class="bd-navbar-elements navbar-nav"> |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../format/index.html"> |
| Specifications |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link nav-internal" href="../../developers/index.html"> |
| Development |
| </a> |
| </li> |
| |
| <li class="nav-item dropdown"> |
| <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2"> |
| Implementations |
| </button> |
| <ul id="pst-nav-more-links-2" class="dropdown-menu"> |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../c_glib/index.html"> |
| C/GLib |
| </a> |
| </li> |
| |
| |
| <li class="nav-item current active"> |
| <a class="nav-link dropdown-item nav-internal" href="../index.html"> |
| C++ |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/csharp/README.md"> |
| C# |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://pkg.go.dev/github.com/apache/arrow/go/v17"> |
| Go |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../java/index.html"> |
| Java |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../js/index.html"> |
| JavaScript |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/julia/"> |
| Julia |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/matlab/README.md"> |
| MATLAB |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/nanoarrow/"> |
| nanoarrow |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../python/index.html"> |
| Python |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../r/index.html"> |
| R |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://github.com/apache/arrow/blob/main/ruby/README.md"> |
| Ruby |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://docs.rs/crate/arrow/"> |
| Rust |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-internal" href="../../status.html"> |
| Implementation Status |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/cpp/"> |
| C++ cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/java/"> |
| Java cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/py/"> |
| Python cookbook |
| </a> |
| </li> |
| |
| |
| <li class="nav-item"> |
| <a class="nav-link dropdown-item nav-external" href="https://arrow.apache.org/cookbook/r/"> |
| R cookbook |
| </a> |
| </li> |
| |
| </ul> |
| </li> |
| |
| </ul> |
| </nav></div> |
| |
| </div> |
| |
| |
| |
| <div class="sidebar-header-items__end"> |
| |
| <div class="navbar-item"> |
| <script> |
| document.write(` |
| <div class="version-switcher__container dropdown"> |
| <button id="pst-version-switcher-button-3" |
| type="button" |
| class="version-switcher__button btn btn-sm navbar-btn dropdown-toggle" |
| data-bs-toggle="dropdown" |
| aria-haspopup="listbox" |
| aria-controls="pst-version-switcher-list-3" |
| aria-label="Version switcher list" |
| > |
| Choose version <!-- this text may get changed later by javascript --> |
| <span class="caret"></span> |
| </button> |
| <div id="pst-version-switcher-list-3" |
| class="version-switcher__menu dropdown-menu list-group-flush py-0" |
| role="listbox" aria-labelledby="pst-version-switcher-button-3"> |
| <!-- dropdown will be populated by javascript on page load --> |
| </div> |
| </div> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"> |
| |
| <script> |
| document.write(` |
| <button class="btn btn-sm navbar-btn theme-switch-button" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip"> |
| <span class="theme-switch nav-link" data-mode="light"><i class="fa-solid fa-sun fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="dark"><i class="fa-solid fa-moon fa-lg"></i></span> |
| <span class="theme-switch nav-link" data-mode="auto"><i class="fa-solid fa-circle-half-stroke fa-lg"></i></span> |
| </button> |
| `); |
| </script></div> |
| |
| <div class="navbar-item"><ul class="navbar-icon-links navbar-nav" |
| aria-label="Icon Links"> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://github.com/apache/arrow" title="GitHub" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-github fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">GitHub</span></a> |
| </li> |
| <li class="nav-item"> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a href="https://twitter.com/ApacheArrow" title="X" class="nav-link" rel="noopener" target="_blank" data-bs-toggle="tooltip" data-bs-placement="bottom"><span><i class="fa-brands fa-square-x-twitter fa-lg" aria-hidden="true"></i></span> |
| <span class="sr-only">X</span></a> |
| </li> |
| </ul></div> |
| |
| </div> |
| |
| </div> |
| |
| <div class="sidebar-primary-items__start sidebar-primary__section"> |
| <div class="sidebar-primary-item"> |
| <nav class="bd-docs-nav bd-links" |
| aria-label="Section Navigation"> |
| <p class="bd-links__title" role="heading" aria-level="1">Section Navigation</p> |
| <div class="bd-toc-item navbar-nav"><ul class="current nav bd-sidenav"> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../getting_started.html">Getting Started</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../build_system.html">Using Arrow C++ in your own project</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../conventions.html">Conventions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/basic_arrow.html">Basic Arrow Data Structures</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/io_tutorial.html">Arrow File I/O</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/compute_tutorial.html">Arrow Compute</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tutorials/datasets_tutorial.html">Arrow Datasets</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../user_guide.html">User Guide</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-2"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../overview.html">High-Level Overview</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../memory.html">Memory Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../arrays.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../datatypes.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../tables.html">Tabular Data</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../compute.html">Compute Functions</a></li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../gandiva.html">The Gandiva Expression Compiler</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-3"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/expr_projector_filter.html">Gandiva Expression, Projector, and Filter</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../gandiva/external_func.html">Gandiva External Functions Development Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2 has-children"><a class="reference internal" href="../streaming_execution.html">Acero: A C++ streaming execution engine</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-4"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/overview.html">Acero Overview</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/user_guide.html">Acero User’s Guide</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/substrait.html">Using Acero with Substrait</a></li> |
| <li class="toctree-l3"><a class="reference internal" href="../acero/developer_guide.html">Developer’s Guide</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l2"><a class="reference internal" href="../io.html">Input / output and filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../ipc.html">Reading and writing the Arrow IPC format</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../orc.html">Reading and Writing ORC files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../parquet.html">Reading and writing Parquet files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../csv.html">Reading and Writing CSV files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../json.html">Reading JSON files</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../dataset.html">Tabular Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../gdb.html">Debugging code using Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../threading.html">Thread Management</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../opentelemetry.html">OpenTelemetry</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../env_vars.html">Environment Variables</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 has-children"><a class="reference internal" href="../examples/index.html">Examples</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-5"><i class="fa-solid fa-chevron-down"></i></label><ul> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/cmake_minimal_build.html">Minimal build using CMake</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/compute_and_write_example.html">Compute and Write CSV Example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_documentation_example.html">Arrow Datasets example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/dataset_skyhook_scan_example.html">Arrow Skyhook example</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/row_columnar_conversion.html">Row to columnar conversion</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/tuple_range_conversion.html">std::tuple-like ranges to Arrow</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="../examples/converting_recordbatch_to_tensor.html">Converting RecordBatch to Tensor</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1 current active has-children"><a class="reference internal" href="../api.html">API Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-6"><i class="fa-solid fa-chevron-down"></i></label><ul class="current"> |
| <li class="toctree-l2"><a class="reference internal" href="support.html">Programming Support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="memory.html">Memory (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="thread.html">Thread (management)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="datatype.html">Data Types</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="array.html">Arrays</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="scalar.html">Scalars</a></li> |
| <li class="toctree-l2 current active"><a class="current reference internal" href="#">Array Builders</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="table.html">Two-dimensional Datasets</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="c_abi.html">C Interfaces</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="compute.html">Compute Functions</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="acero.html">Streaming Execution (Acero)</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="gandiva.html">Gandiva Expression Compiler</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="tensor.html">Tensors</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="utilities.html">Utilities</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="async.html">Asynchronous programming</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="io.html">Input / output</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="ipc.html">Arrow IPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="formats.html">File Formats</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="cuda.html">CUDA support</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="flight.html">Arrow Flight RPC</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="flightsql.html">Arrow Flight SQL</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="filesystem.html">Filesystems</a></li> |
| <li class="toctree-l2"><a class="reference internal" href="dataset.html">Dataset</a></li> |
| </ul> |
| </li> |
| <li class="toctree-l1"><a class="reference external" href="https://arrow.apache.org/cookbook/cpp/">C++ cookbook</a></li> |
| </ul> |
| </div> |
| </nav></div> |
| </div> |
| |
| |
| <div class="sidebar-primary-items__end sidebar-primary__section"> |
| </div> |
| |
| <div id="rtd-footer-container"></div> |
| |
| |
| </div> |
| |
| <main id="main-content" class="bd-main"> |
| |
| |
| <div class="bd-content"> |
| <div class="bd-article-container"> |
| |
| <div class="bd-header-article"> |
| <div class="header-article-items header-article__inner"> |
| |
| <div class="header-article-items__start"> |
| |
| <div class="header-article-item"> |
| |
| |
| |
| <nav aria-label="Breadcrumb"> |
| <ul class="bd-breadcrumbs"> |
| |
| <li class="breadcrumb-item breadcrumb-home"> |
| <a href="../../index.html" class="nav-link" aria-label="Home"> |
| <i class="fa-solid fa-home"></i> |
| </a> |
| </li> |
| |
| <li class="breadcrumb-item"><a href="../index.html" class="nav-link">C++ Implementation</a></li> |
| |
| |
| <li class="breadcrumb-item"><a href="../api.html" class="nav-link">API Reference</a></li> |
| |
| <li class="breadcrumb-item active" aria-current="page">Array Builders</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="array-builders"> |
| <h1>Array Builders<a class="headerlink" href="#array-builders" title="Permalink to this heading">#</a></h1> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilderE"> |
| <span id="_CPPv3N5arrow12ArrayBuilderE"></span><span id="_CPPv2N5arrow12ArrayBuilderE"></span><span id="arrow::ArrayBuilder"></span><span class="target" id="classarrow_1_1_array_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ArrayBuilder</span></span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Base class for all data array builders. </p> |
| <p>This class provides a facilities for incrementally building the null bitmap (see Append methods) and as a side effect the current number of slots and the null count.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Users are expected to use builders as one of the concrete types below. For example, ArrayBuilder* pointing to <a class="reference internal" href="#classarrow_1_1_binary_builder"><span class="std std-ref">BinaryBuilder</span></a> should be downcast before use. </p> |
| </div> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_base_binary_builder"><span class="std std-ref">arrow::BaseBinaryBuilder< LargeBinaryType ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_binary_builder"><span class="std std-ref">arrow::BaseBinaryBuilder< BinaryType ></span></a>, <a class="reference internal" href="#classarrow_1_1_numeric_builder"><span class="std std-ref">arrow::NumericBuilder< DayTimeIntervalType ></span></a>, <a class="reference internal" href="#classarrow_1_1_numeric_builder"><span class="std std-ref">arrow::NumericBuilder< MonthDayNanoIntervalType ></span></a>, arrow::internal::DictionaryBuilderBase< Int32Builder, T >, arrow::internal::DictionaryBuilderBase< AdaptiveIntBuilder, T >, <a class="reference internal" href="#classarrow_1_1_base_binary_builder"><span class="std std-ref">arrow::BaseBinaryBuilder< TYPE ></span></a>, <a class="reference internal" href="#classarrow_1_1_basic_union_builder"><span class="std std-ref">arrow::BasicUnionBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_binary_view_builder"><span class="std std-ref">arrow::BinaryViewBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_boolean_builder"><span class="std std-ref">arrow::BooleanBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_fixed_size_binary_builder"><span class="std std-ref">arrow::FixedSizeBinaryBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_fixed_size_list_builder"><span class="std std-ref">arrow::FixedSizeListBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_map_builder"><span class="std std-ref">arrow::MapBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_null_builder"><span class="std std-ref">arrow::NullBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_numeric_builder"><span class="std std-ref">arrow::NumericBuilder< T ></span></a>, arrow::RunEndEncodedBuilder, <a class="reference internal" href="#classarrow_1_1_struct_builder"><span class="std std-ref">arrow::StructBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_var_length_list_like_builder"><span class="std std-ref">arrow::VarLengthListLikeBuilder< TYPE ></span></a>, arrow::internal::AdaptiveIntBuilderBase, arrow::internal::DictionaryBuilderBase< BuilderType, T >, arrow::internal::DictionaryBuilderBase< BuilderType, NullType >, arrow::internal::RunCompressorBuilder</p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder5childEi"> |
| <span id="_CPPv3N5arrow12ArrayBuilder5childEi"></span><span id="_CPPv2N5arrow12ArrayBuilder5childEi"></span><span id="arrow::ArrayBuilder::child__i"></span><span class="target" id="classarrow_1_1_array_builder_1aad4a1ed2c24204b1cc21e44ab0ad444b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">child</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder5childEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>For nested types. </p> |
| <p>Since the objects are owned by this class instance, we skip shared pointers and just return a raw pointer </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow12ArrayBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder6ResizeE7int64_t"></span><span id="arrow::ArrayBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a994d873bec453c33fbaeb995442d520b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder7ReserveE7int64_t"> |
| <span id="_CPPv3N5arrow12ArrayBuilder7ReserveE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder7ReserveE7int64_t"></span><span id="arrow::ArrayBuilder::Reserve__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reserve</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">additional_capacity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder7ReserveE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that there is enough space allocated to append the indicated number of elements without any further reallocation. </p> |
| <p>Overallocation is used in order to minimize the impact of incremental <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> calls. Note that additional_capacity is relative to the current number of elements rather than to the current capacity, so calls to <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> which are not interspersed with addition of new elements may not increase the capacity.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>additional_capacity</strong> – <strong>[in]</strong> the number of additional array values </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow12ArrayBuilder5ResetEv"></span><span id="_CPPv2N5arrow12ArrayBuilder5ResetEv"></span><span id="arrow::ArrayBuilder::Reset"></span><span class="target" id="classarrow_1_1_array_builder_1a71a25653bdf242da1b3a317f4fd49a98"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow12ArrayBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow12ArrayBuilder10AppendNullEv"></span><span id="arrow::ArrayBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_array_builder_1a6f7c2fbebb93e8630142dca01a328015"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow12ArrayBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder11AppendNullsE7int64_t"></span><span id="arrow::ArrayBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a0900943af067e85d9fa227123c223b14"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow12ArrayBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow12ArrayBuilder16AppendEmptyValueEv"></span><span id="arrow::ArrayBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_array_builder_1a12eeceb1c955c14bd10f2b1a7ee809ba"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow12ArrayBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::ArrayBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1a4422d5a0562be9b6cead62a5a4baa20b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder12AppendScalarERK6Scalar"> |
| <span id="_CPPv3N5arrow12ArrayBuilder12AppendScalarERK6Scalar"></span><span id="_CPPv2N5arrow12ArrayBuilder12AppendScalarERK6Scalar"></span><span id="arrow::ArrayBuilder::AppendScalar__ScalarCR"></span><span class="target" id="classarrow_1_1_array_builder_1aa289802555cc62dfaf529b97ed97748a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendScalar</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="scalar.html#_CPPv4N5arrow6ScalarE" title="arrow::Scalar"><span class="n"><span class="pre">Scalar</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">scalar</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder12AppendScalarERK6Scalar" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a value from a scalar. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow12ArrayBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow12ArrayBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::ArrayBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_array_builder_1ada5cdf224386b577ddd09dec1a39f9a3"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ArrayBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_array_builder_1a0e0aea1c332b472f3671bea9da5ec473"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"> |
| <span id="_CPPv3N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ArrayBuilder::Finish__std::shared_ptr:Array:P"></span><span class="target" id="classarrow_1_1_array_builder_1a67b2227edb4b51bc44425f1c8a439819"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Finish</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow5ArrayE" title="arrow::Array"><span class="n"><span class="pre">Array</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder6FinishEPNSt10shared_ptrI5ArrayEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object. </p> |
| <p>The builder is reset except for <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">DictionaryBuilder</span></a>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ArrayBuilder6FinishEv"> |
| <span id="_CPPv3N5arrow12ArrayBuilder6FinishEv"></span><span id="_CPPv2N5arrow12ArrayBuilder6FinishEv"></span><span id="arrow::ArrayBuilder::Finish"></span><span class="target" id="classarrow_1_1_array_builder_1a144b377476995f39dc0b4335170d6fbe"></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow5ArrayE" title="arrow::Array"><span class="n"><span class="pre">Array</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Finish</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow12ArrayBuilder6FinishEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object. </p> |
| <p>The builder is reset except for <a class="reference internal" href="#classarrow_1_1_dictionary_builder"><span class="std std-ref">DictionaryBuilder</span></a>.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>The finalized <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> object </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow12ArrayBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow12ArrayBuilder4typeEv"></span><span id="_CPPv2NK5arrow12ArrayBuilder4typeEv"></span><span id="arrow::ArrayBuilder::typeC"></span><span class="target" id="classarrow_1_1_array_builder_1a39b4b420be1fcf4fe7219fe953eb65c7"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4NK5arrow12ArrayBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <section id="concrete-builder-subclasses"> |
| <h2>Concrete builder subclasses<a class="headerlink" href="#concrete-builder-subclasses" title="Permalink to this heading">#</a></h2> |
| <section id="primitive"> |
| <h3>Primitive<a class="headerlink" href="#primitive" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilderE"> |
| <span id="_CPPv3N5arrow11NullBuilderE"></span><span id="_CPPv2N5arrow11NullBuilderE"></span><span id="arrow::NullBuilder"></span><span class="target" id="classarrow_1_1_null_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NullBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow11NullBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow11NullBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow11NullBuilder11AppendNullsE7int64_t"></span><span id="arrow::NullBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_null_builder_1a16d3ef02a9cd9ac54c1d0f4c450e6d3b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append the specified number of null elements. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow11NullBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow11NullBuilder10AppendNullEv"></span><span id="arrow::NullBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_null_builder_1af2c0562e2cb8a6e899bc07ab3c72858c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a single null element. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow11NullBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow11NullBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::NullBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_null_builder_1ac32470dfdd0799cdad5386d776dc48ed"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow11NullBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow11NullBuilder16AppendEmptyValueEv"></span><span id="arrow::NullBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_null_builder_1a69c9500de0b998d8b9c3606dc5b1c8fd"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow11NullBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow11NullBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::NullBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_null_builder_1af2a842ec1dcf0e6c9c88acc9e49c09d7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="p"><span class="pre">&</span></span>, <span class="n"><span class="pre">int64_t</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::NullBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_null_builder_1a11081e4904045bb75039fa6eacbeceed"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow11NullBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow11NullBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow11NullBuilder4typeEv"></span><span id="_CPPv2NK5arrow11NullBuilder4typeEv"></span><span id="arrow::NullBuilder::typeC"></span><span class="target" id="classarrow_1_1_null_builder_1aa6a17412ccc108d7e1fc3acd8d3a6083"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow11NullBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilderE"> |
| <span id="_CPPv3N5arrow14BooleanBuilderE"></span><span id="_CPPv2N5arrow14BooleanBuilderE"></span><span id="arrow::BooleanBuilder"></span><span class="target" id="classarrow_1_1_boolean_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BooleanBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrayBuilderExtraOps</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow14BooleanBuilderE" title="arrow::BooleanBuilder"><span class="n"><span class="pre">BooleanBuilder</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder11AppendNullsE7int64_t"></span><span id="arrow::BooleanBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1a3ac08ddd73dd5be1d27f2f148cf95d75"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow14BooleanBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow14BooleanBuilder10AppendNullEv"></span><span id="arrow::BooleanBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_boolean_builder_1aae9f39dbf89f8d1874cc8a4a90aec06b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow14BooleanBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow14BooleanBuilder16AppendEmptyValueEv"></span><span id="arrow::BooleanBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_boolean_builder_1aa8909b910e8f5c2b8e1c6ae51b3292f1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::BooleanBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1a0ae219ef17e2330a6746540b2274cae1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder6AppendEKb"> |
| <span id="_CPPv3N5arrow14BooleanBuilder6AppendEKb"></span><span id="_CPPv2N5arrow14BooleanBuilder6AppendEKb"></span><span id="arrow::BooleanBuilder::Append__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a8780642eb6e5a4a45e31222e78c1cc09"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder6AppendEKb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> append. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12UnsafeAppendEKb"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12UnsafeAppendEKb"></span><span id="_CPPv2N5arrow14BooleanBuilder12UnsafeAppendEKb"></span><span id="arrow::BooleanBuilder::UnsafeAppend__bC"></span><span class="target" id="classarrow_1_1_boolean_builder_1a3695606656e7e71457473c59d1cee0a8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnsafeAppend</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12UnsafeAppendEKb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> append, without checking for capacity. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_boolean_builder_1a60382b2dd40f2d0e66b7ac318fe1d71d"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous array of bytes (non-zero is 1) </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t7int64_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t7int64_t"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1ab2d842a19b6fe248405b9450bd07c0cc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">validity</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tPK7uint8_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a bitmap of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>validity</strong> – <strong>[in]</strong> a validity bitmap to copy (may be null) </p></li> |
| <li><p><strong>offset</strong> – <strong>[in]</strong> an offset into the values and validity bitmaps </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__uint8_tCP.int64_t.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ab257c69eaabe3d00eafae7a598f83e91"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesEPK7uint8_t7int64_tRKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>is_valid</strong> – <strong>[in]</strong> an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a1cfd3c422525a51a4b1b9fa45ab773be"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">uint8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEERKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a std::vector of bytes </p></li> |
| <li><p><strong>is_valid</strong> – <strong>[in]</strong> an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:uint8_t:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a2e10c5bbd21da120a3c343519977b4c1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">uint8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorI7uint8_tEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>values</strong> – <strong>[in]</strong> a std::vector of bytes </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1ac6075414fa190df919ec081884771acc"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEERKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> an std::vector<bool> indicating true (1) or false </p></li> |
| <li><p><strong>is_valid</strong> – <strong>[in]</strong> an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE"></span><span id="arrow::BooleanBuilder::AppendValues__std::vector:b:CR"></span><span class="target" id="classarrow_1_1_boolean_builder_1a54d7f7893e1f9b4ea55172a9af4f1bb3"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder12AppendValuesERKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>values</strong> – <strong>[in]</strong> an std::vector<bool> indicating true (1) or false </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow14BooleanBuilder12AppendValuesE6Status10ValuesIter10ValuesIter"> |
| <span id="_CPPv3I0EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2I0EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValuesIter</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_boolean_builder_1ae2a6d1b574abe92480d25c9736c51e69"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN5arrow14BooleanBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="arrow::BooleanBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_begin</span></span>, <a class="reference internal" href="#_CPPv4I0EN5arrow14BooleanBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="arrow::BooleanBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_end</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN5arrow14BooleanBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values_begin</strong> – <strong>[in]</strong> InputIterator to the beginning of the values </p></li> |
| <li><p><strong>values_end</strong> – <strong>[in]</strong> InputIterator pointing to the end of the values or null(0) values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter"> |
| <span id="_CPPv3I00EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2I00EN5arrow14BooleanBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValuesIter</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValidIter</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_boolean_builder_1aedf2ef31c0989d7507e7241fc535a29b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="utilities.html#_CPPv4I_b0E11enable_if_t" title="enable_if_t"><span class="n"><span class="pre">enable_if_t</span></span></a><span class="p"><span class="pre"><</span></span><span class="o"><span class="pre">!</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_pointer</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::BooleanBuilder::AppendValues::ValidIter"><span class="n"><span class="pre">ValidIter</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::BooleanBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_begin</span></span>, <a class="reference internal" href="#_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::BooleanBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_end</span></span>, <a class="reference internal" href="#_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::BooleanBuilder::AppendValues::ValidIter"><span class="n"><span class="pre">ValidIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">valid_begin</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00EN5arrow14BooleanBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot, with a specified nullmap. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values_begin</strong> – <strong>[in]</strong> InputIterator to the beginning of the values </p></li> |
| <li><p><strong>values_end</strong> – <strong>[in]</strong> InputIterator pointing to the end of the values </p></li> |
| <li><p><strong>valid_begin</strong> – <strong>[in]</strong> InputIterator with elements indication valid(1) or null(0) values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::BooleanBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1aa91055df376327f50843485ab1f09895"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BooleanBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_boolean_builder_1a84e5ee3cc0ae427135093c80b014765c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow14BooleanBuilder5ResetEv"></span><span id="_CPPv2N5arrow14BooleanBuilder5ResetEv"></span><span id="arrow::BooleanBuilder::Reset"></span><span class="target" id="classarrow_1_1_boolean_builder_1a5c7274589b0a49432cac36e0badbf742"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BooleanBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow14BooleanBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow14BooleanBuilder6ResizeE7int64_t"></span><span id="arrow::BooleanBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_boolean_builder_1a4f2626da73f59eb1c0473c7adacdf470"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14BooleanBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14BooleanBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow14BooleanBuilder4typeEv"></span><span id="_CPPv2NK5arrow14BooleanBuilder4typeEv"></span><span id="arrow::BooleanBuilder::typeC"></span><span class="target" id="classarrow_1_1_boolean_builder_1aa3517d917b67cb7221fe3ef21fe553c6"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow14BooleanBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv414DecimalBuilder"> |
| <span id="_CPPv314DecimalBuilder"></span><span id="_CPPv214DecimalBuilder"></span><span class="target" id="group__numeric-builders_1ga59bcac644b0f2cd8e7034643d09e23bb"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DecimalBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">Decimal128Builder</span></span><a class="headerlink" href="#_CPPv414DecimalBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv412UInt8Builder"> |
| <span id="_CPPv312UInt8Builder"></span><span id="_CPPv212UInt8Builder"></span><span class="target" id="group__numeric-builders_1gadab028f188008a82d790cd69ac351a3b"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UInt8Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">UInt8Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv412UInt8Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413UInt16Builder"> |
| <span id="_CPPv313UInt16Builder"></span><span id="_CPPv213UInt16Builder"></span><span class="target" id="group__numeric-builders_1ga6f7720234c751cfa79a0d6d4e2014485"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UInt16Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">UInt16Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv413UInt16Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413UInt32Builder"> |
| <span id="_CPPv313UInt32Builder"></span><span id="_CPPv213UInt32Builder"></span><span class="target" id="group__numeric-builders_1ga54e6101656a21b97a88179c8d1c453b9"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UInt32Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">UInt32Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv413UInt32Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413UInt64Builder"> |
| <span id="_CPPv313UInt64Builder"></span><span id="_CPPv213UInt64Builder"></span><span class="target" id="group__numeric-builders_1ga1777cb0f7c98036ad6f078fa0f1a6829"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UInt64Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">UInt64Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv413UInt64Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv411Int8Builder"> |
| <span id="_CPPv311Int8Builder"></span><span id="_CPPv211Int8Builder"></span><span class="target" id="group__numeric-builders_1ga9675d2aecdd6ad622ee1358c358ba278"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Int8Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Int8Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv411Int8Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv412Int16Builder"> |
| <span id="_CPPv312Int16Builder"></span><span id="_CPPv212Int16Builder"></span><span class="target" id="group__numeric-builders_1gab5ad5330bb34a045c6e87ecee875057e"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Int16Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Int16Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv412Int16Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv412Int32Builder"> |
| <span id="_CPPv312Int32Builder"></span><span id="_CPPv212Int32Builder"></span><span class="target" id="group__numeric-builders_1ga031c893d8d592c7a099bb9bea3a25f86"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Int32Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Int32Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv412Int32Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv412Int64Builder"> |
| <span id="_CPPv312Int64Builder"></span><span id="_CPPv212Int64Builder"></span><span class="target" id="group__numeric-builders_1ga08fa80026c56e0f1ff24b43c4dc33e61"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Int64Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Int64Type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv412Int64Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv416HalfFloatBuilder"> |
| <span id="_CPPv316HalfFloatBuilder"></span><span id="_CPPv216HalfFloatBuilder"></span><span class="target" id="group__numeric-builders_1gae87957f6c01fb918bb573f04c5188ca4"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HalfFloatBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">HalfFloatType</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv416HalfFloatBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv412FloatBuilder"> |
| <span id="_CPPv312FloatBuilder"></span><span id="_CPPv212FloatBuilder"></span><span class="target" id="group__numeric-builders_1gafc7f8a9698e4a5b6e8c3884c2cf3aedb"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FloatBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">FloatType</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv412FloatBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413DoubleBuilder"> |
| <span id="_CPPv313DoubleBuilder"></span><span id="_CPPv213DoubleBuilder"></span><span class="target" id="group__numeric-builders_1gab98cad76b29efffe92c6c88af8947873"></span><span class="k"><span class="pre">using</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DoubleBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">DoubleType</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv413DoubleBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19AdaptiveUIntBuilderE"> |
| <span id="_CPPv3N5arrow19AdaptiveUIntBuilderE"></span><span id="_CPPv2N5arrow19AdaptiveUIntBuilderE"></span><span id="arrow::AdaptiveUIntBuilder"></span><span class="target" id="classarrow_1_1_adaptive_u_int_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AdaptiveUIntBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AdaptiveIntBuilderBase</span></span><a class="headerlink" href="#_CPPv4N5arrow19AdaptiveUIntBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_adaptive.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19AdaptiveUIntBuilder6AppendEK8uint64_t"> |
| <span id="_CPPv3N5arrow19AdaptiveUIntBuilder6AppendEK8uint64_t"></span><span id="_CPPv2N5arrow19AdaptiveUIntBuilder6AppendEK8uint64_t"></span><span id="arrow::AdaptiveUIntBuilder::Append__uint64_tC"></span><span class="target" id="classarrow_1_1_adaptive_u_int_builder_1a7e4738b0c9b10cc48d51031b010cdac1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow19AdaptiveUIntBuilder6AppendEK8uint64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> append. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19AdaptiveUIntBuilder12AppendValuesEPK8uint64_t7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow19AdaptiveUIntBuilder12AppendValuesEPK8uint64_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow19AdaptiveUIntBuilder12AppendValuesEPK8uint64_t7int64_tPK7uint8_t"></span><span id="arrow::AdaptiveUIntBuilder::AppendValues__uint64_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_adaptive_u_int_builder_1a43b340b8e30c02b62ff11f0391b61b92"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint64_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow19AdaptiveUIntBuilder12AppendValuesEPK8uint64_t7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19AdaptiveUIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow19AdaptiveUIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow19AdaptiveUIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::AdaptiveUIntBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_adaptive_u_int_builder_1a9482e808befeda60e397cdc728b28fc3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow19AdaptiveUIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19AdaptiveUIntBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow19AdaptiveUIntBuilder4typeEv"></span><span id="_CPPv2NK5arrow19AdaptiveUIntBuilder4typeEv"></span><span id="arrow::AdaptiveUIntBuilder::typeC"></span><span class="target" id="classarrow_1_1_adaptive_u_int_builder_1a12c11724ed7a9121909400beb33aed30"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow19AdaptiveUIntBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18AdaptiveIntBuilderE"> |
| <span id="_CPPv3N5arrow18AdaptiveIntBuilderE"></span><span id="_CPPv2N5arrow18AdaptiveIntBuilderE"></span><span id="arrow::AdaptiveIntBuilder"></span><span class="target" id="classarrow_1_1_adaptive_int_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AdaptiveIntBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">AdaptiveIntBuilderBase</span></span><a class="headerlink" href="#_CPPv4N5arrow18AdaptiveIntBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_adaptive.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18AdaptiveIntBuilder6AppendEK7int64_t"> |
| <span id="_CPPv3N5arrow18AdaptiveIntBuilder6AppendEK7int64_t"></span><span id="_CPPv2N5arrow18AdaptiveIntBuilder6AppendEK7int64_t"></span><span id="arrow::AdaptiveIntBuilder::Append__int64_tC"></span><span class="target" id="classarrow_1_1_adaptive_int_builder_1a1c0b400ac1a3622a1585ac4ae19287a4"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18AdaptiveIntBuilder6AppendEK7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="scalar.html#structarrow_1_1_scalar"><span class="std std-ref">Scalar</span></a> append. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18AdaptiveIntBuilder12AppendValuesEPK7int64_t7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow18AdaptiveIntBuilder12AppendValuesEPK7int64_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow18AdaptiveIntBuilder12AppendValuesEPK7int64_t7int64_tPK7uint8_t"></span><span id="arrow::AdaptiveIntBuilder::AppendValues__int64_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_adaptive_int_builder_1ad0e3e63d185e4fb53d885eb89c71ad57"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18AdaptiveIntBuilder12AppendValuesEPK7int64_t7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18AdaptiveIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow18AdaptiveIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow18AdaptiveIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::AdaptiveIntBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_adaptive_int_builder_1aec148417ee3a6e40b8ac1514d3347d1b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow18AdaptiveIntBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18AdaptiveIntBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow18AdaptiveIntBuilder4typeEv"></span><span id="_CPPv2NK5arrow18AdaptiveIntBuilder4typeEv"></span><span id="arrow::AdaptiveIntBuilder::typeC"></span><span class="target" id="classarrow_1_1_adaptive_int_builder_1a2f06153316565ee72f0140057e1b5337"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow18AdaptiveIntBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal128BuilderE"> |
| <span id="_CPPv3N5arrow17Decimal128BuilderE"></span><span id="_CPPv2N5arrow17Decimal128BuilderE"></span><span id="arrow::Decimal128Builder"></span><span class="target" id="classarrow_1_1_decimal128_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Decimal128Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow22FixedSizeBinaryBuilderE" title="arrow::FixedSizeBinaryBuilder"><span class="n"><span class="pre">FixedSizeBinaryBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17Decimal128BuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_decimal.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal128Builder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_decimal128_builder_1a1024061ca0b17d1af0967f008ec47313"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17Decimal128Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17Decimal128Builder4typeEv"> |
| <span id="_CPPv3NK5arrow17Decimal128Builder4typeEv"></span><span id="_CPPv2NK5arrow17Decimal128Builder4typeEv"></span><span id="arrow::Decimal128Builder::typeC"></span><span class="target" id="classarrow_1_1_decimal128_builder_1a0c86d55c78f2080023eaa290cb40c01f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow17Decimal128Builder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal128Builder5ResetEv"> |
| <span id="_CPPv3N5arrow17Decimal128Builder5ResetEv"></span><span id="_CPPv2N5arrow17Decimal128Builder5ResetEv"></span><span id="arrow::Decimal128Builder::Reset"></span><span class="target" id="classarrow_1_1_decimal128_builder_1af646f4d380162134d7d18ad4af81f056"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17Decimal128Builder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal256BuilderE"> |
| <span id="_CPPv3N5arrow17Decimal256BuilderE"></span><span id="_CPPv2N5arrow17Decimal256BuilderE"></span><span id="arrow::Decimal256Builder"></span><span class="target" id="classarrow_1_1_decimal256_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Decimal256Builder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow22FixedSizeBinaryBuilderE" title="arrow::FixedSizeBinaryBuilder"><span class="n"><span class="pre">FixedSizeBinaryBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17Decimal256BuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_decimal.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal256Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17Decimal256Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17Decimal256Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::Decimal256Builder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_decimal256_builder_1ac3887ce453690ae04b5a16140afc81f4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17Decimal256Builder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17Decimal256Builder4typeEv"> |
| <span id="_CPPv3NK5arrow17Decimal256Builder4typeEv"></span><span id="_CPPv2NK5arrow17Decimal256Builder4typeEv"></span><span id="arrow::Decimal256Builder::typeC"></span><span class="target" id="classarrow_1_1_decimal256_builder_1af2ffe5ea4f29bd7e311a510d2275c599"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow17Decimal256Builder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17Decimal256Builder5ResetEv"> |
| <span id="_CPPv3N5arrow17Decimal256Builder5ResetEv"></span><span id="_CPPv2N5arrow17Decimal256Builder5ResetEv"></span><span id="arrow::Decimal256Builder::Reset"></span><span class="target" id="classarrow_1_1_decimal256_builder_1af646f4d380162134d7d18ad4af81f056"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17Decimal256Builder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow14NumericBuilderE"> |
| <span id="_CPPv3I0EN5arrow14NumericBuilderE"></span><span id="_CPPv2I0EN5arrow14NumericBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_numeric_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NumericBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrayBuilderExtraOps</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="arrow::NumericBuilder"><span class="n"><span class="pre">NumericBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="arrow::NumericBuilder::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="arrow::NumericBuilder::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">c_type</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_primitive.h></em></div> |
| <p>Base class for all Builders that emit an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> of a scalar numerical type. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder6AppendEK10value_type"> |
| <span id="_CPPv3N5arrow14NumericBuilder6AppendEK10value_type"></span><span id="_CPPv2N5arrow14NumericBuilder6AppendEK10value_type"></span><span id="arrow::NumericBuilder::Append__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1e2842359a508f3d23ba6fc766c7eeb0"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">value_type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder6AppendEK10value_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a single scalar and increase the size if necessary. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder11AppendNullsE7int64_t"></span><span id="arrow::NumericBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1e67c6dc6ade96b660c75ab3031ac8b7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Write nulls as uint8_t* (0 value indicates null) into pre-allocated memory The memory at the corresponding data slot is set to 0 to prevent uninitialized memory access. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow14NumericBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow14NumericBuilder10AppendNullEv"></span><span id="arrow::NumericBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_numeric_builder_1a1acc20f9680309d7ad1d55ab7401f815"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a single null element. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow14NumericBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow14NumericBuilder16AppendEmptyValueEv"></span><span id="arrow::NumericBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_numeric_builder_1ac7b96b71cda5db98b19a3cef961e0652"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a empty element. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::NumericBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1ab4cf46f2b4f6e2083def34ac8aae3f32"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append several empty elements. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow14NumericBuilder5ResetEv"></span><span id="_CPPv2N5arrow14NumericBuilder5ResetEv"></span><span id="arrow::NumericBuilder::Reset"></span><span class="target" id="classarrow_1_1_numeric_builder_1a7ceb2d5bc1adb0cf2f7cb3912b813e2b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder6ResizeE7int64_t"></span><span id="arrow::NumericBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1ad006024991f00da4ad8aa2890bdb0c83"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t"></span><span id="arrow::NumericBuilder::AppendValues__value_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_numeric_builder_1a3915eb06a4672f31eb27423e691cf0a2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">value_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t7int64_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t7int64_t"></span><span id="arrow::NumericBuilder::AppendValues__value_typeCP.int64_t.uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1adcccf23e7cdca3b3813d340b0349962f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">value_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">bitmap</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">bitmap_offset</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tPK7uint8_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>bitmap</strong> – <strong>[in]</strong> a validity bitmap to copy (may be null) </p></li> |
| <li><p><strong>bitmap_offset</strong> – <strong>[in]</strong> an offset into the validity bitmap </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE"></span><span id="arrow::NumericBuilder::AppendValues__value_typeCP.int64_t.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1a65bb6b23c8af350d196fafb77a7c8dcc"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">value_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12AppendValuesEPK10value_type7int64_tRKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of values </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>is_valid</strong> – <strong>[in]</strong> an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE"> |
| <span id="_CPPv3N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE"></span><span id="arrow::NumericBuilder::AppendValues__std::vector:value_type:CR.std::vector:b:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1aa1a26f86af18021733b560584e05df3b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">value_type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">bool</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEERKNSt6vectorIbEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a std::vector of values </p></li> |
| <li><p><strong>is_valid</strong> – <strong>[in]</strong> an std::vector<bool> indicating valid (1) or null (0). Equal in length to values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE"> |
| <span id="_CPPv3N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE"></span><span id="_CPPv2N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE"></span><span id="arrow::NumericBuilder::AppendValues__std::vector:value_type:CR"></span><span class="target" id="classarrow_1_1_numeric_builder_1a2ec37ffd870fb48037cb993f16d7209a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">value_type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12AppendValuesERKNSt6vectorI10value_typeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>values</strong> – <strong>[in]</strong> a std::vector of values </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::NumericBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_numeric_builder_1a63949674fe5401e01fd62b012dabe14c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow14NumericBuilder12AppendValuesE6Status10ValuesIter10ValuesIter"> |
| <span id="_CPPv3I0EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span id="_CPPv2I0EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValuesIter</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_numeric_builder_1a9c3316f90bbf3c02d12bca34739456c5"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="arrow::NumericBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_begin</span></span>, <a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="arrow::NumericBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_end</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN5arrow14NumericBuilder12AppendValuesE6Status10ValuesIter10ValuesIter" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values_begin</strong> – <strong>[in]</strong> InputIterator to the beginning of the values </p></li> |
| <li><p><strong>values_end</strong> – <strong>[in]</strong> InputIterator pointing to the end of the values </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter"> |
| <span id="_CPPv3I00EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span id="_CPPv2I00EN5arrow14NumericBuilder12AppendValuesE10ValuesIter10ValuesIter9ValidIter"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValuesIter</span></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ValidIter</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_numeric_builder_1aca0586ee57cd48f9729ac0669805aa25"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="utilities.html#_CPPv4I_b0E11enable_if_t" title="enable_if_t"><span class="n"><span class="pre">enable_if_t</span></span></a><span class="p"><span class="pre"><</span></span><span class="o"><span class="pre">!</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">is_pointer</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::NumericBuilder::AppendValues::ValidIter"><span class="n"><span class="pre">ValidIter</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::NumericBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_begin</span></span>, <a class="reference internal" href="#_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::NumericBuilder::AppendValues::ValuesIter"><span class="n"><span class="pre">ValuesIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">values_end</span></span>, <a class="reference internal" href="#_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="arrow::NumericBuilder::AppendValues::ValidIter"><span class="n"><span class="pre">ValidIter</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">valid_begin</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00EN5arrow14NumericBuilder12AppendValuesE11enable_if_tIXntNSt10is_pointerI9ValidIterE5valueEE6StatusE10ValuesIter10ValuesIter9ValidIter" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of elements in one shot, with a specified nullmap. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values_begin</strong> – <strong>[in]</strong> InputIterator to the beginning of the values </p></li> |
| <li><p><strong>values_end</strong> – <strong>[in]</strong> InputIterator pointing to the end of the values </p></li> |
| <li><p><strong>valid_begin</strong> – <strong>[in]</strong> InputIterator with elements indication valid(1) or null(0) values. </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow14NumericBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow14NumericBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::NumericBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_numeric_builder_1a4ae26da3f712f9a9879d887a7afede9a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14NumericBuilder12UnsafeAppendEK10value_type"> |
| <span id="_CPPv3N5arrow14NumericBuilder12UnsafeAppendEK10value_type"></span><span id="_CPPv2N5arrow14NumericBuilder12UnsafeAppendEK10value_type"></span><span id="arrow::NumericBuilder::UnsafeAppend__value_typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1a7ad22f6fc4114b23bcfb74e61636d911"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnsafeAppend</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">value_type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14NumericBuilder12UnsafeAppendEK10value_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a single scalar under the assumption that the underlying <a class="reference internal" href="memory.html#classarrow_1_1_buffer"><span class="std std-ref">Buffer</span></a> is large enough. </p> |
| <p>This method does not capacity-check; make sure to call Reserve beforehand. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14NumericBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow14NumericBuilder4typeEv"></span><span id="_CPPv2NK5arrow14NumericBuilder4typeEv"></span><span id="arrow::NumericBuilder::typeC"></span><span class="target" id="classarrow_1_1_numeric_builder_1ae51e115a30d7881f9d7d143256355c30"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow14NumericBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="temporal"> |
| <h3>Temporal<a class="headerlink" href="#temporal" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413Date32Builder"> |
| <span id="_CPPv313Date32Builder"></span><span id="_CPPv213Date32Builder"></span><span id="Date32Builder"></span><span class="target" id="group__temporal-builders_1gadcb521d3f703682dd58904c6b3a0d184"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Date32Type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Date32Builder</span></span></span><a class="headerlink" href="#_CPPv413Date32Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413Date64Builder"> |
| <span id="_CPPv313Date64Builder"></span><span id="_CPPv213Date64Builder"></span><span id="Date64Builder"></span><span class="target" id="group__temporal-builders_1ga0f6f5ba414e7dce870af9fc1fa6f96aa"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Date64Type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Date64Builder</span></span></span><a class="headerlink" href="#_CPPv413Date64Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413Time32Builder"> |
| <span id="_CPPv313Time32Builder"></span><span id="_CPPv213Time32Builder"></span><span id="Time32Builder"></span><span class="target" id="group__temporal-builders_1gad48a5da822678dcfb566dd1df839f4c2"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Time32Type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Time32Builder</span></span></span><a class="headerlink" href="#_CPPv413Time32Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv413Time64Builder"> |
| <span id="_CPPv313Time64Builder"></span><span id="_CPPv213Time64Builder"></span><span id="Time64Builder"></span><span class="target" id="group__temporal-builders_1gac10bcef81b16eedc8fe72f9471833d79"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">Time64Type</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Time64Builder</span></span></span><a class="headerlink" href="#_CPPv413Time64Builder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv416TimestampBuilder"> |
| <span id="_CPPv316TimestampBuilder"></span><span id="_CPPv216TimestampBuilder"></span><span id="TimestampBuilder"></span><span class="target" id="group__temporal-builders_1ga06c8b697ab3c8b10f4653b088351c4a0"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">TimestampType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TimestampBuilder</span></span></span><a class="headerlink" href="#_CPPv416TimestampBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv420MonthIntervalBuilder"> |
| <span id="_CPPv320MonthIntervalBuilder"></span><span id="_CPPv220MonthIntervalBuilder"></span><span id="MonthIntervalBuilder"></span><span class="target" id="group__temporal-builders_1ga783d6afff2e438807d51420d1578efad"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">MonthIntervalType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MonthIntervalBuilder</span></span></span><a class="headerlink" href="#_CPPv420MonthIntervalBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv415DurationBuilder"> |
| <span id="_CPPv315DurationBuilder"></span><span id="_CPPv215DurationBuilder"></span><span id="DurationBuilder"></span><span class="target" id="group__temporal-builders_1ga5412573121f38ea49de2cde738edb938"></span><span class="k"><span class="pre">typedef</span></span><span class="w"> </span><span class="n"><span class="pre">NumericBuilder</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">DurationType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DurationBuilder</span></span></span><a class="headerlink" href="#_CPPv415DurationBuilder" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22DayTimeIntervalBuilderE"> |
| <span id="_CPPv3N5arrow22DayTimeIntervalBuilderE"></span><span id="_CPPv2N5arrow22DayTimeIntervalBuilderE"></span><span id="arrow::DayTimeIntervalBuilder"></span><span class="target" id="classarrow_1_1_day_time_interval_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DayTimeIntervalBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="arrow::NumericBuilder"><span class="n"><span class="pre">NumericBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow19DayTimeIntervalTypeE" title="arrow::DayTimeIntervalType"><span class="n"><span class="pre">DayTimeIntervalType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow22DayTimeIntervalBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_time.h></em></div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow27MonthDayNanoIntervalBuilderE"> |
| <span id="_CPPv3N5arrow27MonthDayNanoIntervalBuilderE"></span><span id="_CPPv2N5arrow27MonthDayNanoIntervalBuilderE"></span><span id="arrow::MonthDayNanoIntervalBuilder"></span><span class="target" id="classarrow_1_1_month_day_nano_interval_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MonthDayNanoIntervalBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow14NumericBuilderE" title="arrow::NumericBuilder"><span class="n"><span class="pre">NumericBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow24MonthDayNanoIntervalTypeE" title="arrow::MonthDayNanoIntervalType"><span class="n"><span class="pre">MonthDayNanoIntervalType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow27MonthDayNanoIntervalBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_time.h></em></div> |
| </dd></dl> |
| |
| </section> |
| <section id="binary-like"> |
| <h3>Binary-like<a class="headerlink" href="#binary-like" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow17BaseBinaryBuilderE"> |
| <span id="_CPPv3I0EN5arrow17BaseBinaryBuilderE"></span><span id="_CPPv2I0EN5arrow17BaseBinaryBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TYPE</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_base_binary_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BaseBinaryBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ArrayBuilderExtraOps</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow17BaseBinaryBuilderE" title="arrow::BaseBinaryBuilder"><span class="n"><span class="pre">BaseBinaryBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow17BaseBinaryBuilderE" title="arrow::BaseBinaryBuilder::TYPE"><span class="n"><span class="pre">TYPE</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN5arrow17BaseBinaryBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder13ExtendCurrentEPK7uint8_t11offset_type"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder13ExtendCurrentEPK7uint8_t11offset_type"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder13ExtendCurrentEPK7uint8_t11offset_type"></span><span id="arrow::BaseBinaryBuilder::ExtendCurrent__uint8_tCP.offset_type"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a53679b912449e0185040f02af41a86e3"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExtendCurrent</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span>, <span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder13ExtendCurrentEPK7uint8_t11offset_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Extend the last appended value by appending more data at the end. </p> |
| <p>Unlike Append, this does not create a new offset. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder11AppendNullsE7int64_t"></span><span id="arrow::BaseBinaryBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_base_binary_builder_1ad3d58ebc0b0233d4d99c69f4d8509c28"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder10AppendNullEv"></span><span id="arrow::BaseBinaryBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_base_binary_builder_1adc7a7beaf773747268a8b51d163ad801"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder16AppendEmptyValueEv"></span><span id="arrow::BaseBinaryBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a93166656f91b20ff47a633e0ab93b834"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::BaseBinaryBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a226d6740e9b90eb3ef7f1807f371adea"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder12UnsafeAppendEPK7uint8_t11offset_type"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder12UnsafeAppendEPK7uint8_t11offset_type"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder12UnsafeAppendEPK7uint8_t11offset_type"></span><span id="arrow::BaseBinaryBuilder::UnsafeAppend__uint8_tCP.offset_type"></span><span class="target" id="classarrow_1_1_base_binary_builder_1adde0685931a1474bc8bb316a2983e63d"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnsafeAppend</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span>, <span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder12UnsafeAppendEPK7uint8_t11offset_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append without checking capacity. </p> |
| <p>Offsets and data should have been presized using <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> and <a class="reference internal" href="#classarrow_1_1_base_binary_builder_1a5b7e9f0b08c07fc417c47c9f601156ee"><span class="std std-ref">ReserveData()</span></a>, respectively. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder19UnsafeExtendCurrentEPK7uint8_t11offset_type"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder19UnsafeExtendCurrentEPK7uint8_t11offset_type"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder19UnsafeExtendCurrentEPK7uint8_t11offset_type"></span><span id="arrow::BaseBinaryBuilder::UnsafeExtendCurrent__uint8_tCP.offset_type"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a790a5ba91be1e070b9872195360ac950"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnsafeExtendCurrent</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span>, <span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder19UnsafeExtendCurrentEPK7uint8_t11offset_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Like ExtendCurrent, but do not check capacity. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t"></span><span id="arrow::BaseBinaryBuilder::AppendValues__std::vector:ss:CR.uint8_tCP"></span><span class="target" id="classarrow_1_1_base_binary_builder_1afdc7c1c5d0e2e0ce2cf4db0c6f67238e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder12AppendValuesERKNSt6vectorINSt6stringEEEPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of strings in one shot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a vector of strings </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder12AppendValuesEPPKc7int64_tPK7uint8_t"></span><span id="arrow::BaseBinaryBuilder::AppendValues__cCPP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_base_binary_builder_1ae7d4b55b71abcbeaa76a3e60c1e14544"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder12AppendValuesEPPKc7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a sequence of nul-terminated strings in one shot. </p> |
| <p>If one of the values is NULL, it is processed as a null value even if the corresponding valid_bytes entry is 1.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>values</strong> – <strong>[in]</strong> a contiguous C array of nul-terminated char * </p></li> |
| <li><p><strong>length</strong> – <strong>[in]</strong> the number of values to append </p></li> |
| <li><p><strong>valid_bytes</strong> – <strong>[in]</strong> an optional sequence of bytes where non-zero indicates a valid (non-null) value </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::BaseBinaryBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a3b8d48d95dbbf0ae5f9cd513f4da33a5"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder5ResetEv"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder5ResetEv"></span><span id="arrow::BaseBinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a8b28644573282a55a360478ba160fa8f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder6ResizeE7int64_t"></span><span id="arrow::BaseBinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a39a192382af4e821b8c7686bb0b0f3f7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder11ReserveDataE7int64_t"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder11ReserveDataE7int64_t"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder11ReserveDataE7int64_t"></span><span id="arrow::BaseBinaryBuilder::ReserveData__int64_t"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a5b7e9f0b08c07fc417c47c9f601156ee"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReserveData</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">elements</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder11ReserveDataE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BaseBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17BaseBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17BaseBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BaseBinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a083a647ec622d5da23981aaa7ad77fe6"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BaseBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder10value_dataEv"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder10value_dataEv"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder10value_dataEv"></span><span id="arrow::BaseBinaryBuilder::value_dataC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a37ce09233654b14608e0dc9b8aa9ff07"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">value_data</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder10value_dataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>data pointer of the value date builder </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder17value_data_lengthEv"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder17value_data_lengthEv"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder17value_data_lengthEv"></span><span id="arrow::BaseBinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a67c35b69662e4193c9e67b2ea7facc1c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">value_data_length</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder17value_data_lengthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>size of values buffer so far </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder19value_data_capacityEv"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder19value_data_capacityEv"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder19value_data_capacityEv"></span><span id="arrow::BaseBinaryBuilder::value_data_capacityC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1ab1ab8ec0b4d22c1d371c8115cb69c8fe"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">value_data_capacity</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder19value_data_capacityEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>capacity of values buffer </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder12offsets_dataEv"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder12offsets_dataEv"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder12offsets_dataEv"></span><span id="arrow::BaseBinaryBuilder::offsets_dataC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1abb30d4a728b15429d40a486409ffc570"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">offsets_data</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder12offsets_dataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>data pointer of the value date builder </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder8GetValueE7int64_tP11offset_type"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder8GetValueE7int64_tP11offset_type"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder8GetValueE7int64_tP11offset_type"></span><span id="arrow::BaseBinaryBuilder::GetValue__int64_t.offset_typePC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1a58fb7bdf885da9f2ffaeb50776852a9c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetValue</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span>, <span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out_length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder8GetValueE7int64_tP11offset_type" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Temporary access to a value. </p> |
| <p>This pointer becomes invalid on the next modifying operation. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BaseBinaryBuilder7GetViewE7int64_t"> |
| <span id="_CPPv3NK5arrow17BaseBinaryBuilder7GetViewE7int64_t"></span><span id="_CPPv2NK5arrow17BaseBinaryBuilder7GetViewE7int64_t"></span><span id="arrow::BaseBinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_base_binary_builder_1ae8f272658647dea284b0128f8eeecbe2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetView</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BaseBinaryBuilder7GetViewE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Temporary access to a value. </p> |
| <p>This view becomes invalid on the next modifying operation. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13BinaryBuilderE"> |
| <span id="_CPPv3N5arrow13BinaryBuilderE"></span><span id="_CPPv2N5arrow13BinaryBuilderE"></span><span id="arrow::BinaryBuilder"></span><span class="target" id="classarrow_1_1_binary_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BinaryBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow17BaseBinaryBuilderE" title="arrow::BaseBinaryBuilder"><span class="n"><span class="pre">BaseBinaryBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow10BinaryTypeE" title="arrow::BinaryType"><span class="n"><span class="pre">BinaryType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow13BinaryBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Builder class for variable-length binary data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_builder"><span class="std std-ref">arrow::StringBuilder</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13BinaryBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow13BinaryBuilder4typeEv"></span><span id="_CPPv2NK5arrow13BinaryBuilder4typeEv"></span><span id="arrow::BinaryBuilder::typeC"></span><span class="target" id="classarrow_1_1_binary_builder_1a6d1c09cbc3b70c842335d449383140f0"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow13BinaryBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StringBuilderE"> |
| <span id="_CPPv3N5arrow13StringBuilderE"></span><span id="_CPPv2N5arrow13StringBuilderE"></span><span id="arrow::StringBuilder"></span><span class="target" id="classarrow_1_1_string_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StringBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow13BinaryBuilderE" title="arrow::BinaryBuilder"><span class="n"><span class="pre">BinaryBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow13StringBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Builder class for UTF8 strings. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13StringBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow13StringBuilder4typeEv"></span><span id="_CPPv2NK5arrow13StringBuilder4typeEv"></span><span id="arrow::StringBuilder::typeC"></span><span class="target" id="classarrow_1_1_string_builder_1a57f3e39d2beab058c7f5726a033cc619"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow13StringBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18LargeBinaryBuilderE"> |
| <span id="_CPPv3N5arrow18LargeBinaryBuilderE"></span><span id="_CPPv2N5arrow18LargeBinaryBuilderE"></span><span id="arrow::LargeBinaryBuilder"></span><span class="target" id="classarrow_1_1_large_binary_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LargeBinaryBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow17BaseBinaryBuilderE" title="arrow::BaseBinaryBuilder"><span class="n"><span class="pre">BaseBinaryBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow15LargeBinaryTypeE" title="arrow::LargeBinaryType"><span class="n"><span class="pre">LargeBinaryType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow18LargeBinaryBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Builder class for large variable-length binary data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_large_string_builder"><span class="std std-ref">arrow::LargeStringBuilder</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18LargeBinaryBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow18LargeBinaryBuilder4typeEv"></span><span id="_CPPv2NK5arrow18LargeBinaryBuilder4typeEv"></span><span id="arrow::LargeBinaryBuilder::typeC"></span><span class="target" id="classarrow_1_1_large_binary_builder_1a6d7dcefdbdd95cba0fd4e775e450a159"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow18LargeBinaryBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18LargeStringBuilderE"> |
| <span id="_CPPv3N5arrow18LargeStringBuilderE"></span><span id="_CPPv2N5arrow18LargeStringBuilderE"></span><span id="arrow::LargeStringBuilder"></span><span class="target" id="classarrow_1_1_large_string_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LargeStringBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow18LargeBinaryBuilderE" title="arrow::LargeBinaryBuilder"><span class="n"><span class="pre">LargeBinaryBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow18LargeStringBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Builder class for large UTF8 strings. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18LargeStringBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow18LargeStringBuilder4typeEv"></span><span id="_CPPv2NK5arrow18LargeStringBuilder4typeEv"></span><span id="arrow::LargeStringBuilder::typeC"></span><span class="target" id="classarrow_1_1_large_string_builder_1ab5f86d865a9d466544760bffe0dd73b8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow18LargeStringBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilderE"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilderE"></span><span id="_CPPv2N5arrow17BinaryViewBuilderE"></span><span id="arrow::BinaryViewBuilder"></span><span class="target" id="classarrow_1_1_binary_view_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BinaryViewBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_view_builder"><span class="std std-ref">arrow::StringViewBuilder</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder12SetBlockSizeE7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder12SetBlockSizeE7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder12SetBlockSizeE7int64_t"></span><span id="arrow::BinaryViewBuilder::SetBlockSize__int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a54c1ef2171929cbacbf033989966f27f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetBlockSize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">blocksize</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder12SetBlockSizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set the size for future preallocated data buffers. </p> |
| <p>The default size is 32KB, so after each 32KB of string data appended to the builder a new data buffer will be allocated. Adjust this to a larger value to decrease the frequency of allocation, or to a smaller value to lower the overhead of each allocation. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BinaryViewBuilder29current_block_bytes_remainingEv"> |
| <span id="_CPPv3NK5arrow17BinaryViewBuilder29current_block_bytes_remainingEv"></span><span id="_CPPv2NK5arrow17BinaryViewBuilder29current_block_bytes_remainingEv"></span><span id="arrow::BinaryViewBuilder::current_block_bytes_remainingC"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a4f68f96dc33e599347f3ace97383631f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">current_block_bytes_remaining</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BinaryViewBuilder29current_block_bytes_remainingEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of bytes which can be appended to this builder without allocating another data buffer. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder12UnsafeAppendEPK7uint8_t7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder12UnsafeAppendEPK7uint8_t7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder12UnsafeAppendEPK7uint8_t7int64_t"></span><span id="arrow::BinaryViewBuilder::UnsafeAppend__uint8_tCP.int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a4ba67878e7e4b5708a3ac66575906d7d"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UnsafeAppend</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">value</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder12UnsafeAppendEPK7uint8_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append without checking capacity. </p> |
| <p>Builder should have been presized using <a class="reference internal" href="#classarrow_1_1_array_builder_1afe8448fda39a8529a119bde5ba7ba119"><span class="std std-ref">Reserve()</span></a> and <a class="reference internal" href="#classarrow_1_1_binary_view_builder_1aa8ee0610e96c455f33d07a3692b74c71"><span class="std std-ref">ReserveData()</span></a>, respectively, and the value must not be larger than 2GB </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder11ReserveDataE7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder11ReserveDataE7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder11ReserveDataE7int64_t"></span><span id="arrow::BinaryViewBuilder::ReserveData__int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1aa8ee0610e96c455f33d07a3692b74c71"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReserveData</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder11ReserveDataE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensures there is enough allocated available capacity in the out-of-line data heap to append the indicated number of bytes without additional allocations. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder11AppendNullsE7int64_t"></span><span id="arrow::BinaryViewBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1aac0b8fb921e8afeef5f62d8eae7bce53"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow17BinaryViewBuilder10AppendNullEv"></span><span id="arrow::BinaryViewBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_binary_view_builder_1aa3fe6a0582ff3b119abfc4732d095992"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a single null element. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow17BinaryViewBuilder16AppendEmptyValueEv"></span><span id="arrow::BinaryViewBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_binary_view_builder_1aeff2b12f898224dfc794a7e22c2ad9eb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a empty element (length-0 inline string) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::BinaryViewBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a3dbd8b89a45170da442849ed44f5cf8e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append several empty elements. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::BinaryViewBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a9cd4fb7763002f49ab60d6bc560ab3f3"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a slice of a <a class="reference internal" href="array.html#classarrow_1_1_binary_view_array"><span class="std std-ref">BinaryViewArray</span></a> passed as an ArraySpan. </p> |
| <p>Copies the underlying out-of-line string memory to avoid memory lifetime issues </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder5ResetEv"></span><span id="_CPPv2N5arrow17BinaryViewBuilder5ResetEv"></span><span id="arrow::BinaryViewBuilder::Reset"></span><span class="target" id="classarrow_1_1_binary_view_builder_1ad6f46c874abc89475615092c2b0e336d"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow17BinaryViewBuilder6ResizeE7int64_t"></span><span id="arrow::BinaryViewBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a5537f613f498ff8e95453d6f78b4f14f"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BinaryViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17BinaryViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17BinaryViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BinaryViewBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_binary_view_builder_1abf93975b5e961cb8719987b17b04a0b6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BinaryViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BinaryViewBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow17BinaryViewBuilder4typeEv"></span><span id="_CPPv2NK5arrow17BinaryViewBuilder4typeEv"></span><span id="arrow::BinaryViewBuilder::typeC"></span><span class="target" id="classarrow_1_1_binary_view_builder_1a89f739f2e9196336c79df23c16ff1e3a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BinaryViewBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17StringViewBuilderE"> |
| <span id="_CPPv3N5arrow17StringViewBuilderE"></span><span id="_CPPv2N5arrow17StringViewBuilderE"></span><span id="arrow::StringViewBuilder"></span><span class="target" id="classarrow_1_1_string_view_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StringViewBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow17BinaryViewBuilderE" title="arrow::BinaryViewBuilder"><span class="n"><span class="pre">BinaryViewBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17StringViewBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17StringViewBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow17StringViewBuilder4typeEv"></span><span id="_CPPv2NK5arrow17StringViewBuilder4typeEv"></span><span id="arrow::StringViewBuilder::typeC"></span><span class="target" id="classarrow_1_1_string_view_builder_1a2f13c473746890c647e988222730cd4e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow17StringViewBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilderE"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilderE"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilderE"></span><span id="arrow::FixedSizeBinaryBuilder"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FixedSizeBinaryBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_binary.h></em></div> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_decimal128_builder"><span class="std std-ref">arrow::Decimal128Builder</span></a>, <a class="reference internal" href="#classarrow_1_1_decimal256_builder"><span class="std std-ref">arrow::Decimal256Builder</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder10AppendNullEv"></span><span id="arrow::FixedSizeBinaryBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1aef21d518e5d67d6ee0bf71bd0dc699a0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder11AppendNullsE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a1b0f9b13338aef6618b24898542189f8"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder16AppendEmptyValueEv"></span><span id="arrow::FixedSizeBinaryBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a7c9730926310ab369e56a071a1ad5049"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af51de9d555b10b0961f740e1742b95fa"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a3074b101b3b182e69b8ece4bb447f725"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder11ReserveDataE7int64_t"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder11ReserveDataE7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder11ReserveDataE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::ReserveData__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a4651aa716a1d2a5ca29380eeaf72d4db"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ReserveData</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">elements</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder11ReserveDataE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensures there is enough allocated capacity to append the indicated number of bytes to the value data buffer without additional allocations. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder5ResetEv"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder5ResetEv"></span><span id="arrow::FixedSizeBinaryBuilder::Reset"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af646f4d380162134d7d18ad4af81f056"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1acab2531151f38e2752dc0d6400a22ec2"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::FixedSizeBinaryBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1af4abbc3596d4e7bb4b5bb843f361540e"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow22FixedSizeBinaryBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"> |
| <span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv"></span><span id="arrow::FixedSizeBinaryBuilder::value_data_lengthC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a9d4ee907329c71703a139b803a4ba4fe"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">value_data_length</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow22FixedSizeBinaryBuilder17value_data_lengthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>size of values buffer so far </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"> |
| <span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetValue__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1ac232789ccc1f36f3d847e6736e78fa9d"></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetValue</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow22FixedSizeBinaryBuilder8GetValueE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Temporary access to a value. </p> |
| <p>This pointer becomes invalid on the next modifying operation. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"> |
| <span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t"></span><span id="arrow::FixedSizeBinaryBuilder::GetView__int64_tC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1ae5ae2b6b2faaeda2a7199dba30478232"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string_view</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetView</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow22FixedSizeBinaryBuilder7GetViewE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Temporary access to a value. </p> |
| <p>This view becomes invalid on the next modifying operation. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow22FixedSizeBinaryBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow22FixedSizeBinaryBuilder4typeEv"></span><span id="_CPPv2NK5arrow22FixedSizeBinaryBuilder4typeEv"></span><span id="arrow::FixedSizeBinaryBuilder::typeC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_builder_1a76883cc379d8422428762e902bed364c"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow22FixedSizeBinaryBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="nested"> |
| <h3>Nested<a class="headerlink" href="#nested" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow24VarLengthListLikeBuilderE"> |
| <span id="_CPPv3I0EN5arrow24VarLengthListLikeBuilderE"></span><span id="_CPPv2I0EN5arrow24VarLengthListLikeBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TYPE</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_var_length_list_like_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VarLengthListLikeBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4I0EN5arrow24VarLengthListLikeBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_base_list_builder"><span class="std std-ref">arrow::BaseListBuilder< LargeListType ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_list_builder"><span class="std std-ref">arrow::BaseListBuilder< ListType ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_list_view_builder"><span class="std std-ref">arrow::BaseListViewBuilder< LargeListViewType ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_list_view_builder"><span class="std std-ref">arrow::BaseListViewBuilder< ListViewType ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_list_builder"><span class="std std-ref">arrow::BaseListBuilder< TYPE ></span></a>, <a class="reference internal" href="#classarrow_1_1_base_list_view_builder"><span class="std std-ref">arrow::BaseListViewBuilder< TYPE ></span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder24VarLengthListLikeBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder24VarLengthListLikeBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder24VarLengthListLikeBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::VarLengthListLikeBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:DataType:CR.int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1aeceb6b9f28b6a94f28b2af08b5bfe558"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">VarLengthListLikeBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value_builder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alignment</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">kDefaultBufferAlignment</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder24VarLengthListLikeBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to incrementally build the value array along with offsets and null bitmap. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder6ResizeE7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1af0965fb1bf474cd470ec41144b803048"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder5ResetEv"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder5ResetEv"></span><span id="arrow::VarLengthListLikeBuilder::Reset"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a3e8e83d9461c0d9d22b2a9ce2662b606"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder6AppendEb7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder6AppendEb7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder6AppendEb7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::Append__b.int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1aceaec737ac520a9e5a2d8a91187f3884"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">is_valid</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">list_length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder6AppendEb7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start a new variable-length list slot. </p> |
| <p>This function should be called before appending elements to the value builder. Elements appended to the value builder before this function is called for the first time, will not be members of any list value.</p> |
| <p>After this function is called, list_length elements SHOULD be appended to the values builder. If this contract is violated, the behavior is defined by the concrete builder implementation and SHOULD NOT be relied upon unless the caller is specifically building a [Large]List or [Large]ListView array.</p> |
| <p>For [Large]List arrays, the list slot length will be the number of elements appended to the values builder before the next call to Append* or Finish. For [Large]ListView arrays, the list slot length will be exactly list_length, but if Append* is called before at least list_length elements are appended to the values builder, the current list slot will share elements with the next list slots or an invalid [Large]ListView array will be generated because there aren’t enough elements in the values builder to fill the list slots.</p> |
| <p>If you’re building a [Large]List and don’t need to be compatible with [Large]ListView, then <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_base_list_builder_1ada18b5551213c8eb7b7a56dceabaefb7"><span class="std std-ref"><span class="pre">BaseListBuilder::Append(bool</span> <span class="pre">is_valid)</span></span></a></code> is a simpler API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>is_valid</strong> – Whether the new list slot is valid </p></li> |
| <li><p><strong>list_length</strong> – The number of elements in the list </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Pre<span class="colon">:</span></dt> |
| <dd class="field-even"><p>if is_valid is false, list_length MUST be 0 </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder10AppendNullEv"></span><span id="arrow::VarLengthListLikeBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1aa7d88e7ccf60101874de350bf5afd9f0"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder11AppendNullsE7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a1a38cb44f04720d09027587164ff1293"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder16AppendEmptyValueEv"></span><span id="arrow::VarLengthListLikeBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a0b4d37adc46021d97b21ffdbf29210c6"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append an empty list slot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Post<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Another call to Append* or Finish should be made before appending to the values builder to ensure list slot remains empty </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a67dd45b38d26ea3404e7ebb5ce957371"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append an empty list slot. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Post<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>Another call to Append* or Finish should be made before appending to the values builder to ensure the last list slot remains empty </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="arrow::VarLengthListLikeBuilder::AppendValues__offset_typeCP.offset_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1ae366a479dd1e39d602227a7065a11f16"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">offsets</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">sizes</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="m"><span class="pre">0</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>For list-array builders, the sizes are inferred from the offsets. BaseListBuilder<T> provides an implementation that doesn’t take sizes, but this virtual function allows dispatching calls to both list-array and list-view-array builders (which need the sizes)</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>offsets</strong> – The offsets of the variable-length lists </p></li> |
| <li><p><strong>sizes</strong> – The sizes of the variable-length lists </p></li> |
| <li><p><strong>length</strong> – The number of offsets, sizes, and validity bits to append </p></li> |
| <li><p><strong>valid_bytes</strong> – If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24VarLengthListLikeBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow24VarLengthListLikeBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow24VarLengthListLikeBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::VarLengthListLikeBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a518b5c5db8ccb0c80de8c9d5f2efd2f7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow24VarLengthListLikeBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow24VarLengthListLikeBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow24VarLengthListLikeBuilder4typeEv"></span><span id="_CPPv2NK5arrow24VarLengthListLikeBuilder4typeEv"></span><span id="arrow::VarLengthListLikeBuilder::typeC"></span><span class="target" id="classarrow_1_1_var_length_list_like_builder_1a8f0f0f5dc9c34625ca633d1fcee2392a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow24VarLengthListLikeBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow15BaseListBuilderE"> |
| <span id="_CPPv3I0EN5arrow15BaseListBuilderE"></span><span id="_CPPv2I0EN5arrow15BaseListBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TYPE</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_base_list_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BaseListBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow24VarLengthListLikeBuilderE" title="arrow::VarLengthListLikeBuilder"><span class="n"><span class="pre">VarLengthListLikeBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow15BaseListBuilderE" title="arrow::BaseListBuilder::TYPE"><span class="n"><span class="pre">TYPE</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN5arrow15BaseListBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15BaseListBuilder6AppendEb"> |
| <span id="_CPPv3N5arrow15BaseListBuilder6AppendEb"></span><span id="_CPPv2N5arrow15BaseListBuilder6AppendEb"></span><span id="arrow::BaseListBuilder::Append__b"></span><span class="target" id="classarrow_1_1_base_list_builder_1ada18b5551213c8eb7b7a56dceabaefb7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow15BaseListBuilder6AppendEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start a new variable-length list slot. </p> |
| <p>This function should be called before beginning to append elements to the value builder </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15BaseListBuilder12AppendValuesEPK11offset_type7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow15BaseListBuilder12AppendValuesEPK11offset_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow15BaseListBuilder12AppendValuesEPK11offset_type7int64_tPK7uint8_t"></span><span id="arrow::BaseListBuilder::AppendValues__offset_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_base_list_builder_1a901b86feaa270241a0f46564a2be9afa"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">offsets</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow15BaseListBuilder12AppendValuesEPK11offset_type7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15BaseListBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow15BaseListBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow15BaseListBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="arrow::BaseListBuilder::AppendValues__offset_typeCP.offset_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_base_list_builder_1a5e6da6b0bbe323e10d0d0247c9f993fc"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">offsets</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">sizes</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow15BaseListBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>For list-array builders, the sizes are inferred from the offsets. BaseListBuilder<T> provides an implementation that doesn’t take sizes, but this virtual function allows dispatching calls to both list-array and list-view-array builders (which need the sizes)</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>offsets</strong> – The offsets of the variable-length lists </p></li> |
| <li><p><strong>sizes</strong> – The sizes of the variable-length lists </p></li> |
| <li><p><strong>length</strong> – The number of offsets, sizes, and validity bits to append </p></li> |
| <li><p><strong>valid_bytes</strong> – If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15BaseListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow15BaseListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow15BaseListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BaseListBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_base_list_builder_1a935a4b7804a1f9eec4e334c31838d679"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow15BaseListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15BaseListBuilder6AppendEb7int64_t"> |
| <span id="_CPPv3N5arrow15BaseListBuilder6AppendEb7int64_t"></span><span id="_CPPv2N5arrow15BaseListBuilder6AppendEb7int64_t"></span><span id="arrow::BaseListBuilder::Append__b.int64_t"></span><span class="target" id="classarrow_1_1_base_list_builder_1aceaec737ac520a9e5a2d8a91187f3884"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">is_valid</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">list_length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow15BaseListBuilder6AppendEb7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start a new variable-length list slot. </p> |
| <p>This function should be called before appending elements to the value builder. Elements appended to the value builder before this function is called for the first time, will not be members of any list value.</p> |
| <p>After this function is called, list_length elements SHOULD be appended to the values builder. If this contract is violated, the behavior is defined by the concrete builder implementation and SHOULD NOT be relied upon unless the caller is specifically building a [Large]List or [Large]ListView array.</p> |
| <p>For [Large]List arrays, the list slot length will be the number of elements appended to the values builder before the next call to Append* or Finish. For [Large]ListView arrays, the list slot length will be exactly list_length, but if Append* is called before at least list_length elements are appended to the values builder, the current list slot will share elements with the next list slots or an invalid [Large]ListView array will be generated because there aren’t enough elements in the values builder to fill the list slots.</p> |
| <p>If you’re building a [Large]List and don’t need to be compatible with [Large]ListView, then <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_base_list_builder_1ada18b5551213c8eb7b7a56dceabaefb7"><span class="std std-ref"><span class="pre">BaseListBuilder::Append(bool</span> <span class="pre">is_valid)</span></span></a></code> is a simpler API.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>is_valid</strong> – Whether the new list slot is valid </p></li> |
| <li><p><strong>list_length</strong> – The number of elements in the list </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Pre<span class="colon">:</span></dt> |
| <dd class="field-even"><p>if is_valid is false, list_length MUST be 0 </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11ListBuilderE"> |
| <span id="_CPPv3N5arrow11ListBuilderE"></span><span id="_CPPv2N5arrow11ListBuilderE"></span><span id="arrow::ListBuilder"></span><span class="target" id="classarrow_1_1_list_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow15BaseListBuilderE" title="arrow::BaseListBuilder"><span class="n"><span class="pre">BaseListBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8ListTypeE" title="arrow::ListType"><span class="n"><span class="pre">ListType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow11ListBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Builder class for variable-length list array value types. </p> |
| <p>To use this class, you must append values to the child array builder and use the Append function to delimit each distinct list value (once the values have been appended to the child array) or use the bulk API to append a sequence of offsets and null values.</p> |
| <p>A note on types. Per arrow/type.h all types in the c++ implementation are logical so even though this class always builds list array, this can represent multiple different logical types. If no logical type is provided at construction time, the class defaults to List<T> where t is taken from the value_builder/values that the object is constructed with. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow16LargeListBuilderE"> |
| <span id="_CPPv3N5arrow16LargeListBuilderE"></span><span id="_CPPv2N5arrow16LargeListBuilderE"></span><span id="arrow::LargeListBuilder"></span><span class="target" id="classarrow_1_1_large_list_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LargeListBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow15BaseListBuilderE" title="arrow::BaseListBuilder"><span class="n"><span class="pre">BaseListBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow13LargeListTypeE" title="arrow::LargeListType"><span class="n"><span class="pre">LargeListType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow16LargeListBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Builder class for large variable-length list array value types. </p> |
| <p>Like <a class="reference internal" href="#classarrow_1_1_list_builder"><span class="std std-ref">ListBuilder</span></a>, but to create large list arrays (with 64-bit offsets). </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow19BaseListViewBuilderE"> |
| <span id="_CPPv3I0EN5arrow19BaseListViewBuilderE"></span><span id="_CPPv2I0EN5arrow19BaseListViewBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TYPE</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_base_list_view_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BaseListViewBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow24VarLengthListLikeBuilderE" title="arrow::VarLengthListLikeBuilder"><span class="n"><span class="pre">VarLengthListLikeBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow19BaseListViewBuilderE" title="arrow::BaseListViewBuilder::TYPE"><span class="n"><span class="pre">TYPE</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN5arrow19BaseListViewBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19BaseListViewBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow19BaseListViewBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow19BaseListViewBuilder6ResizeE7int64_t"></span><span id="arrow::BaseListViewBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_base_list_view_builder_1ac605131e9c0384a1c58a3960ca02eedb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow19BaseListViewBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19BaseListViewBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow19BaseListViewBuilder5ResetEv"></span><span id="_CPPv2N5arrow19BaseListViewBuilder5ResetEv"></span><span id="arrow::BaseListViewBuilder::Reset"></span><span class="target" id="classarrow_1_1_base_list_view_builder_1a4dc077b98a48b2cc3ae027442dd9aa5e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow19BaseListViewBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19BaseListViewBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow19BaseListViewBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow19BaseListViewBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t"></span><span id="arrow::BaseListViewBuilder::AppendValues__offset_typeCP.offset_typeCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_base_list_view_builder_1a404accaa20c2798167134e1fc9ff423b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">offsets</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">offset_type</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">sizes</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow19BaseListViewBuilder12AppendValuesEPK11offset_typePK11offset_type7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19BaseListViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow19BaseListViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow19BaseListViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BaseListViewBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_base_list_view_builder_1a4c7833959bfe1cf9df22480ad905cd70"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow19BaseListViewBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15ListViewBuilderE"> |
| <span id="_CPPv3N5arrow15ListViewBuilderE"></span><span id="_CPPv2N5arrow15ListViewBuilderE"></span><span id="arrow::ListViewBuilder"></span><span class="target" id="classarrow_1_1_list_view_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ListViewBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow19BaseListViewBuilderE" title="arrow::BaseListViewBuilder"><span class="n"><span class="pre">BaseListViewBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow12ListViewTypeE" title="arrow::ListViewType"><span class="n"><span class="pre">ListViewType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow15ListViewBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20LargeListViewBuilderE"> |
| <span id="_CPPv3N5arrow20LargeListViewBuilderE"></span><span id="_CPPv2N5arrow20LargeListViewBuilderE"></span><span id="arrow::LargeListViewBuilder"></span><span class="target" id="classarrow_1_1_large_list_view_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LargeListViewBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow19BaseListViewBuilderE" title="arrow::BaseListViewBuilder"><span class="n"><span class="pre">BaseListViewBuilder</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow17LargeListViewTypeE" title="arrow::LargeListViewType"><span class="n"><span class="pre">LargeListViewType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow20LargeListViewBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilderE"> |
| <span id="_CPPv3N5arrow10MapBuilderE"></span><span id="_CPPv2N5arrow10MapBuilderE"></span><span id="arrow::MapBuilder"></span><span class="target" id="classarrow_1_1_map_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MapBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10MapBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Builder class for arrays of variable-size maps. </p> |
| <p>To use this class, you must use the Append function to delimit each distinct map before appending values to the key and item array builders, or use the bulk API to append a sequence of offsets and null maps.</p> |
| <p>Key uniqueness and ordering are not validated. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv3N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::MapBuilder::MapBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_map_builder_1a30ad6e4fcd4628360681cd710f56560f"></span><span class="sig-name descname"><span class="n"><span class="pre">MapBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key_builder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">item_builder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to define the built array’s type explicitly. </p> |
| <p>If key_builder or item_builder has indeterminate type, this builder will also. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEEb"> |
| <span id="_CPPv3N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEEb"></span><span id="_CPPv2N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEEb"></span><span id="arrow::MapBuilder::MapBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:ArrayBuilder:CR.b"></span><span class="target" id="classarrow_1_1_map_builder_1aa0c7f6ecb6f35b534e8fc4489eba81d2"></span><span class="sig-name descname"><span class="n"><span class="pre">MapBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">key_builder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">item_builder</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">keys_sorted</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">false</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder10MapBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI12ArrayBuilderEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to infer the built array’s type. </p> |
| <p>If key_builder or item_builder has indeterminate type, this builder will also. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow10MapBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow10MapBuilder6ResizeE7int64_t"></span><span id="arrow::MapBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_map_builder_1a2740b157594106cdee063de3c6d40173"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow10MapBuilder5ResetEv"></span><span id="_CPPv2N5arrow10MapBuilder5ResetEv"></span><span id="arrow::MapBuilder::Reset"></span><span class="target" id="classarrow_1_1_map_builder_1aedad1aa92a893f60a677f2a59e30d65f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow10MapBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow10MapBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::MapBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_map_builder_1a6ee03b643d8dc1ff7d5fe5009f852412"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow10MapBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow10MapBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t"></span><span id="arrow::MapBuilder::AppendValues__int32_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_map_builder_1ac688d7bd31692bcbfc6e3cdd5dadcd37"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">offsets</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder12AppendValuesEPK7int32_t7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>If passed, valid_bytes is of equal length to values, and any zero byte will be considered as a null for that slot </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder6AppendEv"> |
| <span id="_CPPv3N5arrow10MapBuilder6AppendEv"></span><span id="_CPPv2N5arrow10MapBuilder6AppendEv"></span><span id="arrow::MapBuilder::Append"></span><span class="target" id="classarrow_1_1_map_builder_1a7f9750c01d1f8fa3cffcfb6af27d661b"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder6AppendEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Start a new variable-length map slot. </p> |
| <p>This function should be called before beginning to append elements to the key and item builders </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow10MapBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow10MapBuilder10AppendNullEv"></span><span id="arrow::MapBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_map_builder_1ab93134c7e0033f61f7e151dbcd4becca"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow10MapBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow10MapBuilder11AppendNullsE7int64_t"></span><span id="arrow::MapBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_map_builder_1a7df073c6ced7e1766d7577c844a7772b"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow10MapBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow10MapBuilder16AppendEmptyValueEv"></span><span id="arrow::MapBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_map_builder_1a9b94819640ced50ed46c1117bc59ed8c"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow10MapBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow10MapBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::MapBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_map_builder_1a8685a41fe0a2b81c4f7e8e8ed5d92d56"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10MapBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow10MapBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow10MapBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::MapBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_map_builder_1a21241ae208de5aee517ad85ede9b293b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow10MapBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10MapBuilder11key_builderEv"> |
| <span id="_CPPv3NK5arrow10MapBuilder11key_builderEv"></span><span id="_CPPv2NK5arrow10MapBuilder11key_builderEv"></span><span id="arrow::MapBuilder::key_builderC"></span><span class="target" id="classarrow_1_1_map_builder_1a0bb40712348e55725178e9b94cc57b08"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">key_builder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10MapBuilder11key_builderEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get builder to append keys. </p> |
| <p>Append a key with this builder should be followed by appending an item or null value with <a class="reference internal" href="#classarrow_1_1_map_builder_1a1e431353da3d8e696589ff40780175b2"><span class="std std-ref">item_builder()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10MapBuilder12item_builderEv"> |
| <span id="_CPPv3NK5arrow10MapBuilder12item_builderEv"></span><span id="_CPPv2NK5arrow10MapBuilder12item_builderEv"></span><span id="arrow::MapBuilder::item_builderC"></span><span class="target" id="classarrow_1_1_map_builder_1a1e431353da3d8e696589ff40780175b2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">item_builder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10MapBuilder12item_builderEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get builder to append items. </p> |
| <p>Appending an item with this builder should have been preceded by appending a key with <a class="reference internal" href="#classarrow_1_1_map_builder_1a0bb40712348e55725178e9b94cc57b08"><span class="std std-ref">key_builder()</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10MapBuilder13value_builderEv"> |
| <span id="_CPPv3NK5arrow10MapBuilder13value_builderEv"></span><span id="_CPPv2NK5arrow10MapBuilder13value_builderEv"></span><span id="arrow::MapBuilder::value_builderC"></span><span class="target" id="classarrow_1_1_map_builder_1aae188ddffd83c7590f33fd784f146d36"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">value_builder</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10MapBuilder13value_builderEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get builder to add Map entries as struct values. </p> |
| <p>This is used instead of <a class="reference internal" href="#classarrow_1_1_map_builder_1a0bb40712348e55725178e9b94cc57b08"><span class="std std-ref">key_builder()</span></a>/item_builder() and allows the Map to be built as a list of struct values. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10MapBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow10MapBuilder4typeEv"></span><span id="_CPPv2NK5arrow10MapBuilder4typeEv"></span><span id="arrow::MapBuilder::typeC"></span><span class="target" id="classarrow_1_1_map_builder_1a468ecd7d5d0b7236324528b3011373d2"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow10MapBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilderE"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilderE"></span><span id="_CPPv2N5arrow20FixedSizeListBuilderE"></span><span id="arrow::FixedSizeListBuilder"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FixedSizeListBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Builder class for fixed-length list array value types. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEE7int32_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEE7int32_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEE7int32_t"></span><span id="arrow::FixedSizeListBuilder::FixedSizeListBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.int32_t"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a9151e6de548480935d1ebf3d0e76d38b"></span><span class="sig-name descname"><span class="n"><span class="pre">FixedSizeListBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value_builder</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">list_size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEE7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to define the built array’s type explicitly. </p> |
| <p>If value_builder has indeterminate type, this builder will also. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::FixedSizeListBuilder::FixedSizeListBuilder__MemoryPoolP.std::shared_ptr:ArrayBuilder:CR.std::shared_ptr:DataType:CR"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a6f5a153c843b4d2a4429d7645ec4908b"></span><span class="sig-name descname"><span class="n"><span class="pre">FixedSizeListBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">value_builder</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder20FixedSizeListBuilderEP10MemoryPoolRKNSt10shared_ptrI12ArrayBuilderEERKNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to infer the built array’s type. </p> |
| <p>If value_builder has indeterminate type, this builder will also. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder6ResizeE7int64_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder6ResizeE7int64_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder6ResizeE7int64_t"></span><span id="arrow::FixedSizeListBuilder::Resize__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1aeca1c0c6bf23b4e79d118df9dd90fab4"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Resize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder6ResizeE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Ensure that enough memory has been allocated to fit the indicated number of total elements in the builder, including any that have already been appended. </p> |
| <p>Does not account for reallocations that may be due to variable size data, like binary values. To make space for incremental appends, use Reserve instead.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>capacity</strong> – <strong>[in]</strong> the minimum number of total array values to accommodate. Must be greater than the current capacity. </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder5ResetEv"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder5ResetEv"></span><span id="arrow::FixedSizeListBuilder::Reset"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a980758c124ac9ae650fae2a7a72b0397"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::FixedSizeListBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a5a2cd1a8d758cc46c83b898051e79e07"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder6AppendEv"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder6AppendEv"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder6AppendEv"></span><span id="arrow::FixedSizeListBuilder::Append"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a46fbe6292114ea1d20f1fc37f8114d89"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder6AppendEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a valid fixed length list. </p> |
| <p>This function affects only the validity bitmap; the child values must be appended using the child array builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder12AppendValuesE7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="arrow::FixedSizeListBuilder::AppendValues__int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a00479ecda3949919c13c7940168719b1"></span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder12AppendValuesE7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Vector append. </p> |
| <p>If passed, valid_bytes will be read and any zero byte will cause the corresponding slot to be null</p> |
| <p>This function affects only the validity bitmap; the child values must be appended using the child array builder. This includes appending nulls for null lists. XXX this restriction is confusing, should this method be omitted? </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder10AppendNullEv"></span><span id="arrow::FixedSizeListBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a165e35124aece9f8d7757f0d1642a8bc"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null fixed length list. </p> |
| <p>The child array builder will have the appropriate number of nulls appended automatically. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder11AppendNullsE7int64_t"></span><span id="arrow::FixedSizeListBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1abaa33ff731317d6c6690e551598a41bb"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append length null fixed length lists. </p> |
| <p>The child array builder will have the appropriate number of nulls appended automatically. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder16AppendEmptyValueEv"></span><span id="arrow::FixedSizeListBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1a9c9c55b0cd43c6f8773cbd8151241c04"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::FixedSizeListBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1ab5381ec9b1c25811761b5134460fa224"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow20FixedSizeListBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow20FixedSizeListBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow20FixedSizeListBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::FixedSizeListBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1ab7e2104a9a6d1c094e3b9853daa0cc34"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow20FixedSizeListBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow20FixedSizeListBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow20FixedSizeListBuilder4typeEv"></span><span id="_CPPv2NK5arrow20FixedSizeListBuilder4typeEv"></span><span id="arrow::FixedSizeListBuilder::typeC"></span><span class="target" id="classarrow_1_1_fixed_size_list_builder_1aba8f3c8d4888dcda3f8bba3bfb9888e0"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow20FixedSizeListBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilderE"> |
| <span id="_CPPv3N5arrow13StructBuilderE"></span><span id="_CPPv2N5arrow13StructBuilderE"></span><span id="arrow::StructBuilder"></span><span class="target" id="classarrow_1_1_struct_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">StructBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow13StructBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_nested.h></em></div> |
| <p>Append, Resize and Reserve methods are acting on <a class="reference internal" href="#classarrow_1_1_struct_builder"><span class="std std-ref">StructBuilder</span></a>. </p> |
| <p>Please make sure all these methods of all child-builders’ are consistently called to maintain data-structure consistency. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder13StructBuilderERKNSt10shared_ptrI8DataTypeEEP10MemoryPoolNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEE"> |
| <span id="_CPPv3N5arrow13StructBuilder13StructBuilderERKNSt10shared_ptrI8DataTypeEEP10MemoryPoolNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEE"></span><span id="_CPPv2N5arrow13StructBuilder13StructBuilderERKNSt10shared_ptrI8DataTypeEEP10MemoryPoolNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEE"></span><span id="arrow::StructBuilder::StructBuilder__std::shared_ptr:DataType:CR.MemoryPoolP.std::vector:std::shared_ptr:ArrayBuilder::"></span><span class="target" id="classarrow_1_1_struct_builder_1ad14feb1d1dd205eab0e9c2cca78f36d9"></span><span class="sig-name descname"><span class="n"><span class="pre">StructBuilder</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span>, <a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">field_builders</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder13StructBuilderERKNSt10shared_ptrI8DataTypeEEP10MemoryPoolNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If any of field_builders has indeterminate type, this builder will also. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::StructBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_struct_builder_1afd9ece86557f3fec253e10a2edbd4840"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t"></span><span id="arrow::StructBuilder::AppendValues__int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_struct_builder_1ab9839275df1391fdafde9a4cb1398e0b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder12AppendValuesE7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Null bitmap is of equal length to every child field, and any zero byte will be considered as a null for that field, but users must using app- end methods or advance methods of the child builders’ independently to insert data. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder6AppendEb"> |
| <span id="_CPPv3N5arrow13StructBuilder6AppendEb"></span><span id="_CPPv2N5arrow13StructBuilder6AppendEb"></span><span id="arrow::StructBuilder::Append__b"></span><span class="target" id="classarrow_1_1_struct_builder_1a772833e76ddabfe510acf04279673867"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">is_valid</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">true</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder6AppendEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append an element to the Struct. </p> |
| <p>All child-builders’ Append method must be called independently to maintain data-structure consistency. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow13StructBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow13StructBuilder10AppendNullEv"></span><span id="arrow::StructBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_struct_builder_1affc04333f5da18873a56fa281e8f8b1e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value. </p> |
| <p>Automatically appends an empty value to each child builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow13StructBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow13StructBuilder11AppendNullsE7int64_t"></span><span id="arrow::StructBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_struct_builder_1a3715e75de72f58a9727bff979c227fd7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append multiple null values. </p> |
| <p>Automatically appends empty values to each child builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow13StructBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow13StructBuilder16AppendEmptyValueEv"></span><span id="arrow::StructBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_struct_builder_1a52aba202d324777d32810d92bb0772d7"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow13StructBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow13StructBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::StructBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_struct_builder_1afe5a5d77c5d22037bd15b58f60226adc"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow13StructBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow13StructBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::StructBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_struct_builder_1a16a46cc6adf9ad534617d028ec7b4ffa"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13StructBuilder5ResetEv"> |
| <span id="_CPPv3N5arrow13StructBuilder5ResetEv"></span><span id="_CPPv2N5arrow13StructBuilder5ResetEv"></span><span id="arrow::StructBuilder::Reset"></span><span class="target" id="classarrow_1_1_struct_builder_1a361986b08279c6cb0ed7ec337e096767"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Reset</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow13StructBuilder5ResetEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Reset the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13StructBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow13StructBuilder4typeEv"></span><span id="_CPPv2NK5arrow13StructBuilder4typeEv"></span><span id="arrow::StructBuilder::typeC"></span><span class="target" id="classarrow_1_1_struct_builder_1a3ac0956447f482a35ae1a5c26f538e32"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow13StructBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BasicUnionBuilderE"> |
| <span id="_CPPv3N5arrow17BasicUnionBuilderE"></span><span id="_CPPv2N5arrow17BasicUnionBuilderE"></span><span id="arrow::BasicUnionBuilder"></span><span class="target" id="classarrow_1_1_basic_union_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BasicUnionBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17BasicUnionBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_union.h></em></div> |
| <p>Base class for union array builds. </p> |
| <p>Note that while we subclass <a class="reference internal" href="#classarrow_1_1_array_builder"><span class="std std-ref">ArrayBuilder</span></a>, as union types do not have a validity bitmap, the bitmap builder member of <a class="reference internal" href="#classarrow_1_1_array_builder"><span class="std std-ref">ArrayBuilder</span></a> is not used. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_dense_union_builder"><span class="std std-ref">arrow::DenseUnionBuilder</span></a>, <a class="reference internal" href="#classarrow_1_1_sparse_union_builder"><span class="std std-ref">arrow::SparseUnionBuilder</span></a></p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BasicUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17BasicUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17BasicUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::BasicUnionBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_basic_union_builder_1a1e76f1afc12889c884e66d87c48d1e9f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17BasicUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17BasicUnionBuilder11AppendChildERKNSt10shared_ptrI12ArrayBuilderEERKNSt6stringE"> |
| <span id="_CPPv3N5arrow17BasicUnionBuilder11AppendChildERKNSt10shared_ptrI12ArrayBuilderEERKNSt6stringE"></span><span id="_CPPv2N5arrow17BasicUnionBuilder11AppendChildERKNSt10shared_ptrI12ArrayBuilderEERKNSt6stringE"></span><span id="arrow::BasicUnionBuilder::AppendChild__std::shared_ptr:ArrayBuilder:CR.ssCR"></span><span class="target" id="classarrow_1_1_basic_union_builder_1a2109b919ac8e8338f5b405e59217e59b"></span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendChild</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">new_child</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">field_name</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="s"><span class="pre">""</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17BasicUnionBuilder11AppendChildERKNSt10shared_ptrI12ArrayBuilderEERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Make a new child builder available to the <a class="reference internal" href="array.html#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>new_child</strong> – <strong>[in]</strong> the child builder </p></li> |
| <li><p><strong>field_name</strong> – <strong>[in]</strong> the name of the field in the union array type if type inference is used </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>child index, which is the “type” argument that needs to be passed to the “Append” method to add a new element to the union array. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17BasicUnionBuilder4typeEv"> |
| <span id="_CPPv3NK5arrow17BasicUnionBuilder4typeEv"></span><span id="_CPPv2NK5arrow17BasicUnionBuilder4typeEv"></span><span id="arrow::BasicUnionBuilder::typeC"></span><span class="target" id="classarrow_1_1_basic_union_builder_1a0eea959637a833f5a859df78fb00f51f"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4NK5arrow17BasicUnionBuilder4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type of the built <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilderE"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilderE"></span><span id="_CPPv2N5arrow17DenseUnionBuilderE"></span><span id="arrow::DenseUnionBuilder"></span><span class="target" id="classarrow_1_1_dense_union_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DenseUnionBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow17BasicUnionBuilderE" title="arrow::BasicUnionBuilder"><span class="n"><span class="pre">BasicUnionBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_union.h></em></div> |
| <p>This API is EXPERIMENTAL. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPool7int64_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPool7int64_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPool7int64_t"></span><span id="arrow::DenseUnionBuilder::DenseUnionBuilder__MemoryPoolP.int64_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a0c731711e1e5d53f01930da198a39f44"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DenseUnionBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alignment</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">kDefaultBufferAlignment</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPool7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to initialize the UnionBuilder with no child builders, allowing type to be inferred. </p> |
| <p>You will need to call AppendChild for each of the children builders you want to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="arrow::DenseUnionBuilder::DenseUnionBuilder__MemoryPoolP.std::vector:std::shared_ptr:ArrayBuilder::CR.std::shared_ptr:DataType:CR.int64_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a5b1e2ebca97de3d0b5d6237a487e8445"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DenseUnionBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">children</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alignment</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">kDefaultBufferAlignment</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder17DenseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to specify the type explicitly. </p> |
| <p>You can still add child builders to the union after using this constructor </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow17DenseUnionBuilder10AppendNullEv"></span><span id="arrow::DenseUnionBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a478cd1f119d4da61a5bc9103ee10bf34"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder11AppendNullsE7int64_t"></span><span id="arrow::DenseUnionBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1ad452ffd9af60da52879566666b0a3fd5"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of null values to builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow17DenseUnionBuilder16AppendEmptyValueEv"></span><span id="arrow::DenseUnionBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a6f20f74661fd21c40531f747d59fed4a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::DenseUnionBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a71e21b897656b83d73acfaa170781a97"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder6AppendE6int8_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder6AppendE6int8_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder6AppendE6int8_t"></span><span id="arrow::DenseUnionBuilder::Append__int8_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1acdc167139945b1c5f143c94602035f17"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">next_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder6AppendE6int8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append an element to the <a class="reference internal" href="array.html#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a>. </p> |
| <p>This must be followed by an append to the appropriate child builder.</p> |
| <p> |
| The corresponding child builder must be appended to independently after this method is called. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>next_type</strong> – <strong>[in]</strong> type_id of the child to which the next value will be appended.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow17DenseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::DenseUnionBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a376009894920b41a4e862cbc630ab1f0"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DenseUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3N5arrow17DenseUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2N5arrow17DenseUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::DenseUnionBuilder::FinishInternal__std::shared_ptr:ArrayData:P"></span><span class="target" id="classarrow_1_1_dense_union_builder_1a5d9c77eb75838636f2604bba9674a3e5"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FinishInternal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">out</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow17DenseUnionBuilder14FinishInternalEPNSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return result of builder as an internal generic <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object. </p> |
| <p>Resets builder except for dictionary builder</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>out</strong> – <strong>[out]</strong> the finalized <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> object </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p><a class="reference internal" href="support.html#classarrow_1_1_status"><span class="std std-ref">Status</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilderE"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilderE"></span><span id="_CPPv2N5arrow18SparseUnionBuilderE"></span><span id="arrow::SparseUnionBuilder"></span><span class="target" id="classarrow_1_1_sparse_union_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SparseUnionBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow17BasicUnionBuilderE" title="arrow::BasicUnionBuilder"><span class="n"><span class="pre">BasicUnionBuilder</span></span></a><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/array/builder_union.h></em></div> |
| <p>This API is EXPERIMENTAL. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPool7int64_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPool7int64_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPool7int64_t"></span><span id="arrow::SparseUnionBuilder::SparseUnionBuilder__MemoryPoolP.int64_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1a8010cfcd1cb327751da3e8a6e9d39ea9"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">explicit</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SparseUnionBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alignment</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">kDefaultBufferAlignment</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPool7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to initialize the UnionBuilder with no child builders, allowing type to be inferred. </p> |
| <p>You will need to call AppendChild for each of the children builders you want to use. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t"></span><span id="arrow::SparseUnionBuilder::SparseUnionBuilder__MemoryPoolP.std::vector:std::shared_ptr:ArrayBuilder::CR.std::shared_ptr:DataType:CR.int64_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1aadefa245bf5bd3118b731a1992cce161"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SparseUnionBuilder</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">vector</span></span><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">children</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">type</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">alignment</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">kDefaultBufferAlignment</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder18SparseUnionBuilderEP10MemoryPoolRKNSt6vectorINSt10shared_ptrI12ArrayBuilderEEEERKNSt10shared_ptrI8DataTypeEE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Use this constructor to specify the type explicitly. </p> |
| <p>You can still add child builders to the union after using this constructor </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder10AppendNullEv"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder10AppendNullEv"></span><span id="_CPPv2N5arrow18SparseUnionBuilder10AppendNullEv"></span><span id="arrow::SparseUnionBuilder::AppendNull"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1afdf9f674dc658d3007b07afc46c16064"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNull</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder10AppendNullEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a null value. </p> |
| <p>A null is appended to the first child, empty values to the other children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder11AppendNullsE7int64_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder11AppendNullsE7int64_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder11AppendNullsE7int64_t"></span><span id="arrow::SparseUnionBuilder::AppendNulls__int64_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1a2a5f145546117068cf70d071e317cfb8"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendNulls</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder11AppendNullsE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append multiple null values. </p> |
| <p>Nulls are appended to the first child, empty values to the other children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder16AppendEmptyValueEv"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder16AppendEmptyValueEv"></span><span id="_CPPv2N5arrow18SparseUnionBuilder16AppendEmptyValueEv"></span><span id="arrow::SparseUnionBuilder::AppendEmptyValue"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1aaf260dacebd4114c810a677e148e0012"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValue</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder16AppendEmptyValueEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a non-null value to builder. </p> |
| <p>The appended value is an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending a null value to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder17AppendEmptyValuesE7int64_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder17AppendEmptyValuesE7int64_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder17AppendEmptyValuesE7int64_t"></span><span id="arrow::SparseUnionBuilder::AppendEmptyValues__int64_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1aec623c249ab78db6c1a34d2c42be9b95"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendEmptyValues</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">final</span></span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder17AppendEmptyValuesE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a number of non-null values to builder. </p> |
| <p>The appended values are an implementation detail, but the corresponding memory slot is guaranteed to be initialized. This method is useful when appending null values to a parent nested type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder6AppendE6int8_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder6AppendE6int8_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder6AppendE6int8_t"></span><span id="arrow::SparseUnionBuilder::Append__int8_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1ad0e6dd3e1d50504c24c0467e873ad17b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Append</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int8_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">next_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder6AppendE6int8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append an element to the <a class="reference internal" href="array.html#classarrow_1_1_union_array"><span class="std std-ref">UnionArray</span></a>. </p> |
| <p>This must be followed by an append to the appropriate child builder.</p> |
| <p> |
| The corresponding child builder must be appended to independently after this method is called, and all other child builders must have null or empty value appended. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>next_type</strong> – <strong>[in]</strong> type_id of the child to which the next value will be appended.</p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18SparseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"> |
| <span id="_CPPv3N5arrow18SparseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="_CPPv2N5arrow18SparseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t"></span><span id="arrow::SparseUnionBuilder::AppendArraySlice__ArraySpanCR.int64_t.int64_t"></span><span class="target" id="classarrow_1_1_sparse_union_builder_1ad24468b2b21fbd1345445081cd56de76"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendArraySlice</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">ArraySpan</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">offset</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">override</span></span><a class="headerlink" href="#_CPPv4N5arrow18SparseUnionBuilder16AppendArraySliceERK9ArraySpan7int64_t7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append a range of values from an array. </p> |
| <p>The given array must be the same type as the builder. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="dictionary-encoded"> |
| <h3>Dictionary-encoded<a class="headerlink" href="#dictionary-encoded" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow17DictionaryBuilderE"> |
| <span id="_CPPv3I0EN5arrow17DictionaryBuilderE"></span><span id="_CPPv2I0EN5arrow17DictionaryBuilderE"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_dictionary_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DictionaryBuilder</span></span></span><span class="w"> </span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="k"><span class="pre">public</span></span><span class="w"> </span><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">internal</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">DictionaryBuilderBase</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow18AdaptiveIntBuilderE" title="arrow::AdaptiveIntBuilder"><span class="n"><span class="pre">AdaptiveIntBuilder</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5arrow17DictionaryBuilderE" title="arrow::DictionaryBuilder::T"><span class="n"><span class="pre">T</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4I0EN5arrow17DictionaryBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A <a class="reference internal" href="array.html#classarrow_1_1_dictionary_array"><span class="std std-ref">DictionaryArray</span></a> builder that uses <a class="reference internal" href="#classarrow_1_1_adaptive_int_builder"><span class="std std-ref">AdaptiveIntBuilder</span></a> to return the smallest index size that can accommodate the dictionary indices. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17DictionaryBuilder13AppendIndicesEPK7int64_t7int64_tPK7uint8_t"> |
| <span id="_CPPv3N5arrow17DictionaryBuilder13AppendIndicesEPK7int64_t7int64_tPK7uint8_t"></span><span id="_CPPv2N5arrow17DictionaryBuilder13AppendIndicesEPK7int64_t7int64_tPK7uint8_t"></span><span id="arrow::DictionaryBuilder::AppendIndices__int64_tCP.int64_t.uint8_tCP"></span><span class="target" id="classarrow_1_1_dictionary_builder_1a4c6bcc592e1fdea503734e0c90ddd069"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4N5arrow6StatusE" title="arrow::Status"><span class="n"><span class="pre">Status</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">AppendIndices</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">values</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">length</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">valid_bytes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="n"><span class="pre">NULLPTR</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow17DictionaryBuilder13AppendIndicesEPK7int64_t7int64_tPK7uint8_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Append dictionary indices directly without modifying memo. </p> |
| <p>NOTE: Experimental API </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| </section> |
| <section id="record-batch-builder"> |
| <h2>Record Batch Builder<a class="headerlink" href="#record-batch-builder" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilderE"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilderE"></span><span id="_CPPv2N5arrow18RecordBatchBuilderE"></span><span id="arrow::RecordBatchBuilder"></span><span class="target" id="classarrow_1_1_record_batch_builder"></span><span class="k"><span class="pre">class</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RecordBatchBuilder</span></span></span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilderE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Helper class for creating record batches iteratively given a known schema. </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-functions">Public Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder8GetFieldEi"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder8GetFieldEi"></span><span id="_CPPv2N5arrow18RecordBatchBuilder8GetFieldEi"></span><span id="arrow::RecordBatchBuilder::GetField__i"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a5b4aa2b43436cfad70d2ed94e1e4f369"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow12ArrayBuilderE" title="arrow::ArrayBuilder"><span class="n"><span class="pre">ArrayBuilder</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetField</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder8GetFieldEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get base pointer to field builder. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>i</strong> – the field index </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>pointer to <a class="reference internal" href="#classarrow_1_1_array_builder"><span class="std std-ref">ArrayBuilder</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow18RecordBatchBuilder10GetFieldAsEP1Ti"> |
| <span id="_CPPv3I0EN5arrow18RecordBatchBuilder10GetFieldAsEi"></span><span id="_CPPv2I0EN5arrow18RecordBatchBuilder10GetFieldAsEi"></span><span class="k"><span class="pre">template</span></span><span class="p"><span class="pre"><</span></span><span class="k"><span class="pre">typename</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">T</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_record_batch_builder_1ac92bd46c4751373c3f07b3d2460c45cb"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0EN5arrow18RecordBatchBuilder10GetFieldAsEP1Ti" title="arrow::RecordBatchBuilder::GetFieldAs::T"><span class="n"><span class="pre">T</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">GetFieldAs</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">i</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I0EN5arrow18RecordBatchBuilder10GetFieldAsEP1Ti" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return field builder casted to indicated specific builder type. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>i</strong> – the field index </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>pointer to template type </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder5FlushEb"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder5FlushEb"></span><span id="_CPPv2N5arrow18RecordBatchBuilder5FlushEb"></span><span id="arrow::RecordBatchBuilder::Flush__b"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a1f08a530f5c7e696265786ad9621feb4"></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Flush</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">reset_builders</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder5FlushEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Finish current batch and optionally reset. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>reset_builders</strong> – <strong>[in]</strong> the resulting <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a></p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the resulting <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder5FlushEv"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder5FlushEv"></span><span id="_CPPv2N5arrow18RecordBatchBuilder5FlushEv"></span><span id="arrow::RecordBatchBuilder::Flush"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a838ed5ab98e9e8542f52f75cce3d9aed"></span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Flush</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder5FlushEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Finish current batch and reset. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>the resulting <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder18SetInitialCapacityE7int64_t"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder18SetInitialCapacityE7int64_t"></span><span id="_CPPv2N5arrow18RecordBatchBuilder18SetInitialCapacityE7int64_t"></span><span id="arrow::RecordBatchBuilder::SetInitialCapacity__int64_t"></span><span class="target" id="classarrow_1_1_record_batch_builder_1abf86e2fb93b8926ac7977f870b586b4c"></span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SetInitialCapacity</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">capacity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder18SetInitialCapacityE7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set the initial capacity for new builders. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18RecordBatchBuilder16initial_capacityEv"> |
| <span id="_CPPv3NK5arrow18RecordBatchBuilder16initial_capacityEv"></span><span id="_CPPv2NK5arrow18RecordBatchBuilder16initial_capacityEv"></span><span id="arrow::RecordBatchBuilder::initial_capacityC"></span><span class="target" id="classarrow_1_1_record_batch_builder_1aa2a83f82fe958b9046c0cac0bd95ff79"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">initial_capacity</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow18RecordBatchBuilder16initial_capacityEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The initial capacity for builders. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18RecordBatchBuilder10num_fieldsEv"> |
| <span id="_CPPv3NK5arrow18RecordBatchBuilder10num_fieldsEv"></span><span id="_CPPv2NK5arrow18RecordBatchBuilder10num_fieldsEv"></span><span id="arrow::RecordBatchBuilder::num_fieldsC"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a4f8fc3fbd339ba31ba9daf9968f0cbe1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">num_fields</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow18RecordBatchBuilder10num_fieldsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of fields in the schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow18RecordBatchBuilder6schemaEv"> |
| <span id="_CPPv3NK5arrow18RecordBatchBuilder6schemaEv"></span><span id="_CPPv2NK5arrow18RecordBatchBuilder6schemaEv"></span><span id="arrow::RecordBatchBuilder::schemaC"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a341f635ea52b00f2d49953f3c9534275"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">schema</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow18RecordBatchBuilder6schemaEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The number of fields in the schema. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-static-functions">Public Static Functions</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool"></span><span id="_CPPv2N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool"></span><span id="arrow::RecordBatchBuilder::Make__std::shared_ptr:Schema:CR.MemoryPoolP"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a77702b34231a117d50f47d74c5af5ea2"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow18RecordBatchBuilderE" title="arrow::RecordBatchBuilder"><span class="n"><span class="pre">RecordBatchBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Make</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span>, <a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create and initialize a <a class="reference internal" href="#classarrow_1_1_record_batch_builder"><span class="std std-ref">RecordBatchBuilder</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>schema</strong> – <strong>[in]</strong> The schema for the record batch </p></li> |
| <li><p><strong>pool</strong> – <strong>[in]</strong> A <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> to use for allocations </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the created builder instance </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool7int64_t"> |
| <span id="_CPPv3N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool7int64_t"></span><span id="_CPPv2N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool7int64_t"></span><span id="arrow::RecordBatchBuilder::Make__std::shared_ptr:Schema:CR.MemoryPoolP.int64_t"></span><span class="target" id="classarrow_1_1_record_batch_builder_1a17caa3d8e98478aa676069ee7cc5e409"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="support.html#_CPPv4I0EN5arrow6ResultE" title="arrow::Result"><span class="n"><span class="pre">Result</span></span></a><span class="p"><span class="pre"><</span></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">unique_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow18RecordBatchBuilderE" title="arrow::RecordBatchBuilder"><span class="n"><span class="pre">RecordBatchBuilder</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Make</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="datatype.html#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span>, <a class="reference internal" href="memory.html#_CPPv4N5arrow10MemoryPoolE" title="arrow::MemoryPool"><span class="n"><span class="pre">MemoryPool</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">pool</span></span>, <span class="n"><span class="pre">int64_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">initial_capacity</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow18RecordBatchBuilder4MakeERKNSt10shared_ptrI6SchemaEEP10MemoryPool7int64_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create and initialize a <a class="reference internal" href="#classarrow_1_1_record_batch_builder"><span class="std std-ref">RecordBatchBuilder</span></a>. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><ul class="simple"> |
| <li><p><strong>schema</strong> – <strong>[in]</strong> The schema for the record batch </p></li> |
| <li><p><strong>pool</strong> – <strong>[in]</strong> A <a class="reference internal" href="memory.html#classarrow_1_1_memory_pool"><span class="std std-ref">MemoryPool</span></a> to use for allocations </p></li> |
| <li><p><strong>initial_capacity</strong> – <strong>[in]</strong> The initial capacity for the builders </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>the created builder instance </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="scalar.html" |
| title="previous page"> |
| <i class="fa-solid fa-angle-left"></i> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">previous</p> |
| <p class="prev-next-title">Scalars</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="table.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Two-dimensional Datasets</p> |
| </div> |
| <i class="fa-solid fa-angle-right"></i> |
| </a> |
| </div> |
| </footer> |
| |
| </div> |
| |
| |
| |
| <div class="bd-sidebar-secondary bd-toc"><div class="sidebar-secondary-items sidebar-secondary__inner"> |
| |
| |
| <div class="sidebar-secondary-item"> |
| <div |
| id="pst-page-navigation-heading-2" |
| class="page-toc tocsection onthispage"> |
| <i class="fa-solid fa-list"></i> On this page |
| </div> |
| <nav class="bd-toc-nav page-toc" aria-labelledby="pst-page-navigation-heading-2"> |
| <ul class="visible nav section-nav flex-column"> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#concrete-builder-subclasses">Concrete builder subclasses</a><ul class="visible nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#primitive">Primitive</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#temporal">Temporal</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#binary-like">Binary-like</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#nested">Nested</a></li> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#dictionary-encoded">Dictionary-encoded</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#record-batch-builder">Record Batch Builder</a></li> |
| </ul> |
| </nav></div> |
| |
| <div class="sidebar-secondary-item"> |
| |
| |
| <div class="tocsection editthispage"> |
| <a href="https://github.com/apache/arrow/edit/main/docs/source/cpp/api/builder.rst"> |
| <i class="fa-solid fa-pencil"></i> |
| |
| |
| |
| Edit on GitHub |
| |
| |
| </a> |
| </div> |
| </div> |
| |
| </div></div> |
| |
| |
| </div> |
| <footer class="bd-footer-content"> |
| |
| </footer> |
| |
| </main> |
| </div> |
| </div> |
| |
| <!-- Scripts loaded after <body> so the DOM is not blocked --> |
| <script src="../../_static/scripts/bootstrap.js?digest=8d27b9dea8ad943066ae"></script> |
| <script src="../../_static/scripts/pydata-sphinx-theme.js?digest=8d27b9dea8ad943066ae"></script> |
| |
| <footer class="bd-footer"> |
| <div class="bd-footer__inner bd-page-width"> |
| |
| <div class="footer-items__start"> |
| |
| <div class="footer-item"> |
| |
| <p class="copyright"> |
| |
| © Copyright 2016-2024 Apache Software Foundation. |
| Apache Arrow, Arrow, Apache, the Apache feather logo, and the Apache Arrow project logo are either registered trademarks or trademarks of The Apache Software Foundation in the United States and other countries. |
| <br/> |
| |
| </p> |
| </div> |
| |
| <div class="footer-item"> |
| |
| <p class="sphinx-version"> |
| Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 6.2.0. |
| <br/> |
| </p> |
| </div> |
| |
| </div> |
| |
| |
| |
| <div class="footer-items__end"> |
| |
| <div class="footer-item"> |
| <p class="theme-version"> |
| Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.15.2. |
| </p></div> |
| |
| </div> |
| |
| </div> |
| |
| </footer> |
| </body> |
| </html> |
