| |
| |
| <!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>Data Types — 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/datatype';</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/datatype.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="Arrays" href="array.html" /> |
| <link rel="prev" title="Thread (management)" href="thread.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 current active"><a class="current reference internal" href="#">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"><a class="reference internal" href="builder.html">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">Data Types</li> |
| </ul> |
| </nav> |
| </div> |
| |
| </div> |
| |
| |
| </div> |
| </div> |
| |
| |
| |
| |
| <div id="searchbox"></div> |
| <article class="bd-article"> |
| |
| <section id="data-types"> |
| <h1>Data Types<a class="headerlink" href="#data-types" title="Permalink to this heading">#</a></h1> |
| <dl class="cpp enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4typeE"> |
| <span id="_CPPv3N5arrow4Type4typeE"></span><span id="_CPPv2N5arrow4Type4typeE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Main data type enumeration. </p> |
| <p>This enumeration provides a quick way to interrogate the category of a <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> instance. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type2NAE"> |
| <span id="_CPPv3N5arrow4Type4type2NAE"></span><span id="_CPPv2N5arrow4Type4type2NAE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af46d8600b17dd993097e0875a46e0b15"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NA</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type2NAE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A NULL type having no physical storage. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type4BOOLE"> |
| <span id="_CPPv3N5arrow4Type4type4BOOLE"></span><span id="_CPPv2N5arrow4Type4type4BOOLE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ae4bb4146eedf3fb5a517780000001b30"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BOOL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type4BOOLE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Boolean as 1 bit, LSB bit-packed ordering. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type5UINT8E"> |
| <span id="_CPPv3N5arrow4Type4type5UINT8E"></span><span id="_CPPv2N5arrow4Type4type5UINT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab8f52afb784526f800c91de101673b42"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UINT8</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type5UINT8E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unsigned 8-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type4INT8E"> |
| <span id="_CPPv3N5arrow4Type4type4INT8E"></span><span id="_CPPv2N5arrow4Type4type4INT8E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44adf9f694eb598f6f8cac8bed3da547d65"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INT8</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type4INT8E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Signed 8-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6UINT16E"> |
| <span id="_CPPv3N5arrow4Type4type6UINT16E"></span><span id="_CPPv2N5arrow4Type4type6UINT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a87c4272d67d3a84ed9ce6c6a9a4a6772"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UINT16</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6UINT16E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unsigned 16-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type5INT16E"> |
| <span id="_CPPv3N5arrow4Type4type5INT16E"></span><span id="_CPPv2N5arrow4Type4type5INT16E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a36b3753b92501b60b2740b29d6e17696"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INT16</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type5INT16E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Signed 16-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6UINT32E"> |
| <span id="_CPPv3N5arrow4Type4type6UINT32E"></span><span id="_CPPv2N5arrow4Type4type6UINT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a89620afd46abf8f99b057bd3587a78f0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UINT32</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6UINT32E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unsigned 32-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type5INT32E"> |
| <span id="_CPPv3N5arrow4Type4type5INT32E"></span><span id="_CPPv2N5arrow4Type4type5INT32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af8005f162bc422abcee7f1197bf04cf8"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INT32</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type5INT32E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Signed 32-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6UINT64E"> |
| <span id="_CPPv3N5arrow4Type4type6UINT64E"></span><span id="_CPPv2N5arrow4Type4type6UINT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af1096e3ebb2d7a678fc6ddac24bf7639"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">UINT64</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6UINT64E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unsigned 64-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type5INT64E"> |
| <span id="_CPPv3N5arrow4Type4type5INT64E"></span><span id="_CPPv2N5arrow4Type4type5INT64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af38ec7ec303572a87b11fd48876bc1d0"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INT64</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type5INT64E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Signed 64-bit little-endian integer. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type10HALF_FLOATE"> |
| <span id="_CPPv3N5arrow4Type4type10HALF_FLOATE"></span><span id="_CPPv2N5arrow4Type4type10HALF_FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af6ebd198668f2a6c2d79c549f599e896"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HALF_FLOAT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type10HALF_FLOATE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>2-byte floating point value </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type5FLOATE"> |
| <span id="_CPPv3N5arrow4Type4type5FLOATE"></span><span id="_CPPv2N5arrow4Type4type5FLOATE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a57c54c2b9d1630bc8c99b5fec4c93e58"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FLOAT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type5FLOATE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>4-byte floating point value </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6DOUBLEE"> |
| <span id="_CPPv3N5arrow4Type4type6DOUBLEE"></span><span id="_CPPv2N5arrow4Type4type6DOUBLEE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a75397800ad025678ff7803b543d4a183"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DOUBLE</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6DOUBLEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>8-byte floating point value </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6STRINGE"> |
| <span id="_CPPv3N5arrow4Type4type6STRINGE"></span><span id="_CPPv2N5arrow4Type4type6STRINGE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a864933bd7cdfa63ea75498c34db6545f"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">STRING</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6STRINGE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>UTF8 variable-length string as List<Char> </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6BINARYE"> |
| <span id="_CPPv3N5arrow4Type4type6BINARYE"></span><span id="_CPPv2N5arrow4Type4type6BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a442cc62761c7e5a83d26da4d3ed2fe01"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6BINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Variable-length bytes (no guarantee of UTF8-ness) </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type17FIXED_SIZE_BINARYE"> |
| <span id="_CPPv3N5arrow4Type4type17FIXED_SIZE_BINARYE"></span><span id="_CPPv2N5arrow4Type4type17FIXED_SIZE_BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1b3f48148c5ff94c039d09ff689da179"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FIXED_SIZE_BINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type17FIXED_SIZE_BINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Fixed-size binary. Each value occupies the same number of bytes. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6DATE32E"> |
| <span id="_CPPv3N5arrow4Type4type6DATE32E"></span><span id="_CPPv2N5arrow4Type4type6DATE32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a4351aedceb3d92f82cf7ae504476ef30"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DATE32</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6DATE32E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>int32_t days since the UNIX epoch </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6DATE64E"> |
| <span id="_CPPv3N5arrow4Type4type6DATE64E"></span><span id="_CPPv2N5arrow4Type4type6DATE64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a17325202e90c23cd194b1698eea87a38"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DATE64</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6DATE64E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>int64_t milliseconds since the UNIX epoch </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type9TIMESTAMPE"> |
| <span id="_CPPv3N5arrow4Type4type9TIMESTAMPE"></span><span id="_CPPv2N5arrow4Type4type9TIMESTAMPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1e41dddee4a6410c4d6fe164b36a230e"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIMESTAMP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type9TIMESTAMPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Exact timestamp encoded with int64 since UNIX epoch Default unit millisecond. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6TIME32E"> |
| <span id="_CPPv3N5arrow4Type4type6TIME32E"></span><span id="_CPPv2N5arrow4Type4type6TIME32E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a73fb0fcd2b5d9a4c6071574c73cdf3c5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIME32</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6TIME32E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Time as signed 32-bit integer, representing either seconds or milliseconds since midnight. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6TIME64E"> |
| <span id="_CPPv3N5arrow4Type4type6TIME64E"></span><span id="_CPPv2N5arrow4Type4type6TIME64E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab960cffd22f54b634d9f055f7568d321"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">TIME64</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6TIME64E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Time as signed 64-bit integer, representing either microseconds or nanoseconds since midnight. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type15INTERVAL_MONTHSE"> |
| <span id="_CPPv3N5arrow4Type4type15INTERVAL_MONTHSE"></span><span id="_CPPv2N5arrow4Type4type15INTERVAL_MONTHSE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aae2741592364e8c454bf0770df212113"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INTERVAL_MONTHS</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type15INTERVAL_MONTHSE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>YEAR_MONTH interval in SQL style. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type17INTERVAL_DAY_TIMEE"> |
| <span id="_CPPv3N5arrow4Type4type17INTERVAL_DAY_TIMEE"></span><span id="_CPPv2N5arrow4Type4type17INTERVAL_DAY_TIMEE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ae76b37d752f74c54dcab4fc304847870"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INTERVAL_DAY_TIME</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type17INTERVAL_DAY_TIMEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>DAY_TIME interval in SQL style. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type10DECIMAL128E"> |
| <span id="_CPPv3N5arrow4Type4type10DECIMAL128E"></span><span id="_CPPv2N5arrow4Type4type10DECIMAL128E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a27d26f5a116d8509834e450ea32be1e4"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DECIMAL128</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type10DECIMAL128E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Precision- and scale-based decimal type with 128 bits. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type7DECIMALE"> |
| <span id="_CPPv3N5arrow4Type4type7DECIMALE"></span><span id="_CPPv2N5arrow4Type4type7DECIMALE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a014fe7104b592dbd7c70e4e861774a63"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DECIMAL</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type7DECIMALE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Defined for backward-compatibility. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type10DECIMAL256E"> |
| <span id="_CPPv3N5arrow4Type4type10DECIMAL256E"></span><span id="_CPPv2N5arrow4Type4type10DECIMAL256E"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ac24176a80108fd406f53be052390a3d1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DECIMAL256</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type10DECIMAL256E" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Precision- and scale-based decimal type with 256 bits. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type4LISTE"> |
| <span id="_CPPv3N5arrow4Type4type4LISTE"></span><span id="_CPPv2N5arrow4Type4type4LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ad074f9c02567b5945293b9114f84f210"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LIST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type4LISTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of some logical data type. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6STRUCTE"> |
| <span id="_CPPv3N5arrow4Type4type6STRUCTE"></span><span id="_CPPv2N5arrow4Type4type6STRUCTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aaa028b35c4e6a047c0e510ef1b0389ef"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">STRUCT</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6STRUCTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Struct of logical types. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type12SPARSE_UNIONE"> |
| <span id="_CPPv3N5arrow4Type4type12SPARSE_UNIONE"></span><span id="_CPPv2N5arrow4Type4type12SPARSE_UNIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a258028cfc50a92e76e9e468966fe40a1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SPARSE_UNION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type12SPARSE_UNIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Sparse unions of logical types. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type11DENSE_UNIONE"> |
| <span id="_CPPv3N5arrow4Type4type11DENSE_UNIONE"></span><span id="_CPPv2N5arrow4Type4type11DENSE_UNIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aeefcb64511faefa500e1ee3e42188754"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DENSE_UNION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type11DENSE_UNIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Dense unions of logical types. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type10DICTIONARYE"> |
| <span id="_CPPv3N5arrow4Type4type10DICTIONARYE"></span><span id="_CPPv2N5arrow4Type4type10DICTIONARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a3c38b5820a3de12d71713473550c6280"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DICTIONARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type10DICTIONARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Dictionary-encoded type, also called “categorical” or “factor” in other programming languages. </p> |
| <p>Holds the dictionary value type but not the dictionary itself, which is part of the <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a> struct </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type3MAPE"> |
| <span id="_CPPv3N5arrow4Type4type3MAPE"></span><span id="_CPPv2N5arrow4Type4type3MAPE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a51838b04a2cdc2db91890e4c70f45e61"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MAP</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type3MAPE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Map, a repeated struct logical type. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type9EXTENSIONE"> |
| <span id="_CPPv3N5arrow4Type4type9EXTENSIONE"></span><span id="_CPPv2N5arrow4Type4type9EXTENSIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af62348e1483c0b1a1536853e35588dad"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">EXTENSION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type9EXTENSIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Custom data type, implemented by user. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type15FIXED_SIZE_LISTE"> |
| <span id="_CPPv3N5arrow4Type4type15FIXED_SIZE_LISTE"></span><span id="_CPPv2N5arrow4Type4type15FIXED_SIZE_LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a870656978bd9028566f88fe1c0afb127"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">FIXED_SIZE_LIST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type15FIXED_SIZE_LISTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Fixed size list of some logical type. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type8DURATIONE"> |
| <span id="_CPPv3N5arrow4Type4type8DURATIONE"></span><span id="_CPPv2N5arrow4Type4type8DURATIONE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a5322b7f2fd54030f65ac36e9637ff45b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DURATION</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type8DURATIONE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Measure of elapsed time in either seconds, milliseconds, microseconds or nanoseconds. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type12LARGE_STRINGE"> |
| <span id="_CPPv3N5arrow4Type4type12LARGE_STRINGE"></span><span id="_CPPv2N5arrow4Type4type12LARGE_STRINGE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a97279348163fabb0441e9ae939dc7ef5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LARGE_STRING</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type12LARGE_STRINGE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Like STRING, but with 64-bit offsets. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type12LARGE_BINARYE"> |
| <span id="_CPPv3N5arrow4Type4type12LARGE_BINARYE"></span><span id="_CPPv2N5arrow4Type4type12LARGE_BINARYE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ac15fc368bd8a9390a69d4e174635781d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LARGE_BINARY</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type12LARGE_BINARYE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Like BINARY, but with 64-bit offsets. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type10LARGE_LISTE"> |
| <span id="_CPPv3N5arrow4Type4type10LARGE_LISTE"></span><span id="_CPPv2N5arrow4Type4type10LARGE_LISTE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a573d9118191906864e808bf3d5c75049"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LARGE_LIST</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type10LARGE_LISTE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Like LIST, but with 64-bit offsets. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type23INTERVAL_MONTH_DAY_NANOE"> |
| <span id="_CPPv3N5arrow4Type4type23INTERVAL_MONTH_DAY_NANOE"></span><span id="_CPPv2N5arrow4Type4type23INTERVAL_MONTH_DAY_NANOE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44aff81b5f2c452bba20a714bef8c4c2d48"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">INTERVAL_MONTH_DAY_NANO</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type23INTERVAL_MONTH_DAY_NANOE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Calendar interval type with three fields. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type15RUN_END_ENCODEDE"> |
| <span id="_CPPv3N5arrow4Type4type15RUN_END_ENCODEDE"></span><span id="_CPPv2N5arrow4Type4type15RUN_END_ENCODEDE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44af3f86f1749c154f41aeb53178f7169be"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">RUN_END_ENCODED</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type15RUN_END_ENCODEDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Run-end encoded data. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type11STRING_VIEWE"> |
| <span id="_CPPv3N5arrow4Type4type11STRING_VIEWE"></span><span id="_CPPv2N5arrow4Type4type11STRING_VIEWE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a7581431349d4792a46ef3141377c9a3a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">STRING_VIEW</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type11STRING_VIEWE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>String (UTF8) view type with 4-byte prefix and inline small string optimization. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type11BINARY_VIEWE"> |
| <span id="_CPPv3N5arrow4Type4type11BINARY_VIEWE"></span><span id="_CPPv2N5arrow4Type4type11BINARY_VIEWE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a8a89b7b65d07edd9a042a32f6ff2994d"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">BINARY_VIEW</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type11BINARY_VIEWE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Bytes view type with 4-byte prefix and inline small string optimization. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type9LIST_VIEWE"> |
| <span id="_CPPv3N5arrow4Type4type9LIST_VIEWE"></span><span id="_CPPv2N5arrow4Type4type9LIST_VIEWE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44a1af30589edbf97bdddcf7222293ff8f7"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LIST_VIEW</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type9LIST_VIEWE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A list of some logical data type represented by offset and size. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type15LARGE_LIST_VIEWE"> |
| <span id="_CPPv3N5arrow4Type4type15LARGE_LIST_VIEWE"></span><span id="_CPPv2N5arrow4Type4type15LARGE_LIST_VIEWE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44afaa44f6b497857a80a51fe5be72cad1a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">LARGE_LIST_VIEW</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type15LARGE_LIST_VIEWE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Like LIST_VIEW, but with 64-bit offsets and sizes. </p> |
| </dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow4Type4type6MAX_IDE"> |
| <span id="_CPPv3N5arrow4Type4type6MAX_IDE"></span><span id="_CPPv2N5arrow4Type4type6MAX_IDE"></span><span class="target" id="structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44ab77bb5b73b4a8a11d395b7f712ee8923"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MAX_ID</span></span></span><a class="headerlink" href="#_CPPv4N5arrow4Type4type6MAX_IDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8DataTypeE"> |
| <span id="_CPPv3N5arrow8DataTypeE"></span><span id="_CPPv2N5arrow8DataTypeE"></span><span id="arrow::DataType"></span><span class="target" id="classarrow_1_1_data_type"></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">DataType</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">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">enable_shared_from_this</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</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="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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Fingerprintable</span></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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">EqualityComparable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow8DataTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Base class for all data types. </p> |
| <p>Data types in this library are all <em>logical</em>. They can be expressed as either a primitive physical type (bytes or bits of some fixed size), a nested type consisting of other data types, or another data type (e.g. a timestamp encoded as an int64).</p> |
| <p>Simple datatypes may be entirely described by their <a class="reference internal" href="#structarrow_1_1_type_1a00a041cb19a3be373da8eec7d4bf1f44"><span class="std std-ref">Type::type</span></a> id, but complex datatypes are usually parametric. </p> |
| <p>Subclassed by arrow::BaseBinaryType, <a class="reference internal" href="#classarrow_1_1_binary_view_type"><span class="std std-ref">arrow::BinaryViewType</span></a>, <a class="reference internal" href="#classarrow_1_1_extension_type"><span class="std std-ref">arrow::ExtensionType</span></a>, arrow::FixedWidthType, arrow::NestedType, <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">arrow::NullType</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="_CPPv4NK5arrow8DataType6EqualsERK8DataTypeb"> |
| <span id="_CPPv3NK5arrow8DataType6EqualsERK8DataTypeb"></span><span id="_CPPv2NK5arrow8DataType6EqualsERK8DataTypeb"></span><span id="arrow::DataType::Equals__DataTypeCR.bC"></span><span class="target" id="classarrow_1_1_data_type_1aaf003113bb8f4c51a03a16f4b27a52bb"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">check_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8DataType6EqualsERK8DataTypeb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return whether the types are equal. </p> |
| <p>Types that are logically convertible from one to another (e.g. List<UInt8> and Binary) are NOT equal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEEb"> |
| <span id="_CPPv3NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEEb"></span><span id="_CPPv2NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEEb"></span><span id="arrow::DataType::Equals__std::shared_ptr:DataType:CR.bC"></span><span class="target" id="classarrow_1_1_data_type_1a9c7d009a850b8ff402f407f6ff2b3400"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</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="#_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">other</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">check_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8DataType6EqualsERKNSt10shared_ptrI8DataTypeEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return whether the types are equal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType5fieldEi"> |
| <span id="_CPPv3NK5arrow8DataType5fieldEi"></span><span id="_CPPv2NK5arrow8DataType5fieldEi"></span><span id="arrow::DataType::field__iC"></span><span class="target" id="classarrow_1_1_data_type_1a43c6e137751492c85f28d78ecd060a9e"></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">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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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="sig-name descname"><span class="n"><span class="pre">field</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8DataType5fieldEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the child field at index i. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType6fieldsEv"> |
| <span id="_CPPv3NK5arrow8DataType6fieldsEv"></span><span id="_CPPv2NK5arrow8DataType6fieldsEv"></span><span id="arrow::DataType::fieldsC"></span><span class="target" id="classarrow_1_1_data_type_1a0ef5265d98d4da2ea869ced20f23f936"></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">FieldVector</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">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="#_CPPv4NK5arrow8DataType6fieldsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the children fields associated with this type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType10num_fieldsEv"> |
| <span id="_CPPv3NK5arrow8DataType10num_fieldsEv"></span><span id="_CPPv2NK5arrow8DataType10num_fieldsEv"></span><span id="arrow::DataType::num_fieldsC"></span><span class="target" id="classarrow_1_1_data_type_1abea430c8841b10b0f0537021623fb9cd"></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="#_CPPv4NK5arrow8DataType10num_fieldsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the number of children fields associated with this type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType6AcceptEP11TypeVisitor"> |
| <span id="_CPPv3NK5arrow8DataType6AcceptEP11TypeVisitor"></span><span id="_CPPv2NK5arrow8DataType6AcceptEP11TypeVisitor"></span><span id="arrow::DataType::Accept__TypeVisitorPC"></span><span class="target" id="classarrow_1_1_data_type_1a97571c4039e363f7ebcb09f7c789064a"></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">Accept</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow11TypeVisitorE" title="arrow::TypeVisitor"><span class="n"><span class="pre">TypeVisitor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n sig-param"><span class="pre">visitor</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8DataType6AcceptEP11TypeVisitor" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Apply the <a class="reference internal" href="#classarrow_1_1_type_visitor_1a7c55beece55f9c82a191a3667f2ca582"><span class="std std-ref">TypeVisitor::Visit()</span></a> method specialized to the data type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType8ToStringEb"> |
| <span id="_CPPv3NK5arrow8DataType8ToStringEb"></span><span id="_CPPv2NK5arrow8DataType8ToStringEb"></span><span id="arrow::DataType::ToString__bC"></span><span class="target" id="classarrow_1_1_data_type_1a882cacdceda69026bf4a863bf1a23ba5"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow8DataType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType4HashEv"> |
| <span id="_CPPv3NK5arrow8DataType4HashEv"></span><span id="_CPPv2NK5arrow8DataType4HashEv"></span><span id="arrow::DataType::HashC"></span><span class="target" id="classarrow_1_1_data_type_1a5cde8987d682385a73f6a0e3ec08fab8"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Hash</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="#_CPPv4NK5arrow8DataType4HashEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return hash value (excluding metadata in child fields) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType4nameEv"> |
| <span id="_CPPv3NK5arrow8DataType4nameEv"></span><span id="_CPPv2NK5arrow8DataType4nameEv"></span><span id="arrow::DataType::nameC"></span><span class="target" id="classarrow_1_1_data_type_1a94985d12273f5dd353d6142921299d4d"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow8DataType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType6layoutEv"> |
| <span id="_CPPv3NK5arrow8DataType6layoutEv"></span><span id="_CPPv2NK5arrow8DataType6layoutEv"></span><span id="arrow::DataType::layoutC"></span><span class="target" id="classarrow_1_1_data_type_1a4fe70f6a45eda029ea118c8470ff925e"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow8DataType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType2idEv"> |
| <span id="_CPPv3NK5arrow8DataType2idEv"></span><span id="_CPPv2NK5arrow8DataType2idEv"></span><span id="arrow::DataType::idC"></span><span class="target" id="classarrow_1_1_data_type_1a5ec6a1c93420c68e9c8065d4a56ad645"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4typeE" title="arrow::Type::type"><span class="n"><span class="pre">type</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">id</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="#_CPPv4NK5arrow8DataType2idEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type category. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType10storage_idEv"> |
| <span id="_CPPv3NK5arrow8DataType10storage_idEv"></span><span id="_CPPv2NK5arrow8DataType10storage_idEv"></span><span id="arrow::DataType::storage_idC"></span><span class="target" id="classarrow_1_1_data_type_1a0704d4c030f810ba9990db834f6046d5"></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">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4typeE" title="arrow::Type::type"><span class="n"><span class="pre">type</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">storage_id</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="#_CPPv4NK5arrow8DataType10storage_idEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type category of the storage type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType10byte_widthEv"> |
| <span id="_CPPv3NK5arrow8DataType10byte_widthEv"></span><span id="_CPPv2NK5arrow8DataType10byte_widthEv"></span><span id="arrow::DataType::byte_widthC"></span><span class="target" id="classarrow_1_1_data_type_1a60f304aeff9c9fc2abf59fbc9558b7d8"></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">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">byte_width</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="#_CPPv4NK5arrow8DataType10byte_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed byte width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8DataType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow8DataType9bit_widthEv"></span><span id="_CPPv2NK5arrow8DataType9bit_widthEv"></span><span id="arrow::DataType::bit_widthC"></span><span class="target" id="classarrow_1_1_data_type_1ab3147142697e1e274c4a7c98aac28ceb"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow8DataType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <section id="factory-functions"> |
| <span id="api-type-factories"></span><h2>Factory functions<a class="headerlink" href="#factory-functions" title="Permalink to this heading">#</a></h2> |
| <p>These functions are recommended for creating data types. They may return |
| new objects or existing singletons, depending on the type requested.</p> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44nullv"> |
| <span id="_CPPv34nullv"></span><span id="_CPPv24nullv"></span><span id="null"></span><span class="target" id="group__type-factories_1gaac5b094c3d5d8b58e062382469e31739"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">null</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44nullv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">NullType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47booleanv"> |
| <span id="_CPPv37booleanv"></span><span id="_CPPv27booleanv"></span><span id="boolean"></span><span class="target" id="group__type-factories_1ga9914f2da1aef13362104e3a5a97d4074"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">boolean</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47booleanv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_boolean_type"><span class="std std-ref">BooleanType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44int8v"> |
| <span id="_CPPv34int8v"></span><span id="_CPPv24int8v"></span><span id="int8"></span><span class="target" id="group__type-factories_1ga9ea23b10d17a371b4752556dc0e4d201"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">int8</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44int8v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int8_type"><span class="std std-ref">Int8Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45int16v"> |
| <span id="_CPPv35int16v"></span><span id="_CPPv25int16v"></span><span id="int16"></span><span class="target" id="group__type-factories_1gafa71411a08f05a5014853868981cd4dc"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">int16</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45int16v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int16_type"><span class="std std-ref">Int16Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45int32v"> |
| <span id="_CPPv35int32v"></span><span id="_CPPv25int32v"></span><span id="int32"></span><span class="target" id="group__type-factories_1ga1713caac102cfa4db4a39e5ce7f642d8"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">int32</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45int32v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int32_type"><span class="std std-ref">Int32Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45int64v"> |
| <span id="_CPPv35int64v"></span><span id="_CPPv25int64v"></span><span id="int64"></span><span class="target" id="group__type-factories_1gac4128918c3358a43763a13f5bb2446f4"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">int64</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45int64v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_int64_type"><span class="std std-ref">Int64Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45uint8v"> |
| <span id="_CPPv35uint8v"></span><span id="_CPPv25uint8v"></span><span id="uint8"></span><span class="target" id="group__type-factories_1gac35ca9b06704fb0f33d7f180b7e62f4f"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">uint8</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45uint8v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int8_type"><span class="std std-ref">UInt8Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46uint16v"> |
| <span id="_CPPv36uint16v"></span><span id="_CPPv26uint16v"></span><span id="uint16"></span><span class="target" id="group__type-factories_1ga1d1fa92942f6573040a163d4d351631e"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">uint16</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46uint16v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int16_type"><span class="std std-ref">UInt16Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46uint32v"> |
| <span id="_CPPv36uint32v"></span><span id="_CPPv26uint32v"></span><span id="uint32"></span><span class="target" id="group__type-factories_1gafb8b6a96d0a5ea29dca010d214577fcb"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">uint32</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46uint32v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int32_type"><span class="std std-ref">UInt32Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46uint64v"> |
| <span id="_CPPv36uint64v"></span><span id="_CPPv26uint64v"></span><span id="uint64"></span><span class="target" id="group__type-factories_1ga024d423c48977e29dbb3ffa7ebbbcb43"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">uint64</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46uint64v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_u_int64_type"><span class="std std-ref">UInt64Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47float16v"> |
| <span id="_CPPv37float16v"></span><span id="_CPPv27float16v"></span><span id="float16"></span><span class="target" id="group__type-factories_1ga88bdb8b3f2385d0dffce5d38d1e43f2d"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">float16</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47float16v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_half_float_type"><span class="std std-ref">HalfFloatType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47float32v"> |
| <span id="_CPPv37float32v"></span><span id="_CPPv27float32v"></span><span id="float32"></span><span class="target" id="group__type-factories_1ga8b5a6e733c4b6c08014203a42c1a9706"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">float32</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47float32v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_float_type"><span class="std std-ref">FloatType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47float64v"> |
| <span id="_CPPv37float64v"></span><span id="_CPPv27float64v"></span><span id="float64"></span><span class="target" id="group__type-factories_1gaf8281c031294a423f8161bdf200c050f"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">float64</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47float64v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_double_type"><span class="std std-ref">DoubleType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44utf8v"> |
| <span id="_CPPv34utf8v"></span><span id="_CPPv24utf8v"></span><span id="utf8"></span><span class="target" id="group__type-factories_1gaf9edf8ae2cb03d666b8653f1b4c1385f"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">utf8</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44utf8v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_string_type"><span class="std std-ref">StringType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49utf8_viewv"> |
| <span id="_CPPv39utf8_viewv"></span><span id="_CPPv29utf8_viewv"></span><span id="utf8_view"></span><span class="target" id="group__type-factories_1gadf03dbb6a7dc25bad236ccf41199b0ad"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">utf8_view</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49utf8_viewv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_string_view_type"><span class="std std-ref">StringViewType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410large_utf8v"> |
| <span id="_CPPv310large_utf8v"></span><span id="_CPPv210large_utf8v"></span><span id="large_utf8"></span><span class="target" id="group__type-factories_1ga35e864f715cb0a34c87dd13577dc8e56"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">large_utf8</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410large_utf8v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_large_string_type"><span class="std std-ref">LargeStringType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46binaryv"> |
| <span id="_CPPv36binaryv"></span><span id="_CPPv26binaryv"></span><span id="binary"></span><span class="target" id="group__type-factories_1ga83a489287dad68c5304d1cf9a5aee922"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">binary</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46binaryv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_binary_type"><span class="std std-ref">BinaryType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv411binary_viewv"> |
| <span id="_CPPv311binary_viewv"></span><span id="_CPPv211binary_viewv"></span><span id="binary_view"></span><span class="target" id="group__type-factories_1ga3502dee434f0ec89f7c24a727781724c"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">binary_view</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411binary_viewv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_binary_view_type"><span class="std std-ref">BinaryViewType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412large_binaryv"> |
| <span id="_CPPv312large_binaryv"></span><span id="_CPPv212large_binaryv"></span><span id="large_binary"></span><span class="target" id="group__type-factories_1ga7a153886a0c20891d9e665f65c03beee"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">large_binary</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412large_binaryv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_large_binary_type"><span class="std std-ref">LargeBinaryType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46date32v"> |
| <span id="_CPPv36date32v"></span><span id="_CPPv26date32v"></span><span id="date32"></span><span class="target" id="group__type-factories_1ga837079e96c25d8d5bcfdc0dad68bcd8f"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">date32</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46date32v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_date32_type"><span class="std std-ref">Date32Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46date64v"> |
| <span id="_CPPv36date64v"></span><span id="_CPPv26date64v"></span><span id="date64"></span><span class="target" id="group__type-factories_1ga768bca971591c029a4ca23ca4f77b8a1"></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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></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">date64</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46date64v" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_date64_type"><span class="std std-ref">Date64Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv417fixed_size_binary7int32_t"> |
| <span id="_CPPv317fixed_size_binary7int32_t"></span><span id="_CPPv217fixed_size_binary7int32_t"></span><span id="fixed_size_binary__int32_t"></span><span class="target" id="group__type-factories_1gacaf5c20d8caef81e01621a3cad7cc9c2"></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><span class="n"><span class="pre">DataType</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">fixed_size_binary</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">byte_width</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417fixed_size_binary7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_fixed_size_binary_type"><span class="std std-ref">FixedSizeBinaryType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47decimal7int32_t7int32_t"> |
| <span id="_CPPv37decimal7int32_t7int32_t"></span><span id="_CPPv27decimal7int32_t7int32_t"></span><span id="decimal__int32_t.int32_t"></span><span class="target" id="group__type-factories_1ga3390964f23814ab08c9604158f727883"></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><span class="n"><span class="pre">DataType</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">decimal</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47decimal7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_decimal_type"><span class="std std-ref">DecimalType</span></a> instance depending on the precision. </p> |
| <p>If the precision is greater than 38, a <a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</span></a> is returned, otherwise a <a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410decimal1287int32_t7int32_t"> |
| <span id="_CPPv310decimal1287int32_t7int32_t"></span><span id="_CPPv210decimal1287int32_t7int32_t"></span><span id="decimal128__int32_t.int32_t"></span><span class="target" id="group__type-factories_1gac15d3ae6ba68d2b50558232ef9b2197e"></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><span class="n"><span class="pre">DataType</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">decimal128</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410decimal1287int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410decimal2567int32_t7int32_t"> |
| <span id="_CPPv310decimal2567int32_t7int32_t"></span><span id="_CPPv210decimal2567int32_t7int32_t"></span><span id="decimal256__int32_t.int32_t"></span><span class="target" id="group__type-factories_1ga23507b3fb0387c6f579bb0527bec47b7"></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><span class="n"><span class="pre">DataType</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">decimal256</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410decimal2567int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44listRKNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv34listRKNSt10shared_ptrI5FieldEE"></span><span id="_CPPv24listRKNSt10shared_ptrI5FieldEE"></span><span id="list__std::shared_ptr:Field:CR"></span><span class="target" id="group__type-factories_1ga20e7157554937088556275ed4b6485d3"></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><span class="n"><span class="pre">DataType</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">list</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><span class="n"><span class="pre">Field</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">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44listRKNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">ListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv44listRKNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv34listRKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv24listRKNSt10shared_ptrI8DataTypeEE"></span><span id="list__std::shared_ptr:DataType:CR"></span><span class="target" id="group__type-factories_1ga1bf7acea41aa557cf249bc91b50c8044"></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><span class="n"><span class="pre">DataType</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">list</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><span class="n"><span class="pre">DataType</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">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv44listRKNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">ListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410large_listRKNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv310large_listRKNSt10shared_ptrI5FieldEE"></span><span id="_CPPv210large_listRKNSt10shared_ptrI5FieldEE"></span><span id="large_list__std::shared_ptr:Field:CR"></span><span class="target" id="group__type-factories_1ga14066c45deb0167842e3e7bd7c545ec0"></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><span class="n"><span class="pre">DataType</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">large_list</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><span class="n"><span class="pre">Field</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">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410large_listRKNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_large_list_type"><span class="std std-ref">LargeListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410large_listRKNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv310large_listRKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv210large_listRKNSt10shared_ptrI8DataTypeEE"></span><span id="large_list__std::shared_ptr:DataType:CR"></span><span class="target" id="group__type-factories_1ga37378b9cb539ee9284c44e2efaafff8f"></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><span class="n"><span class="pre">DataType</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">large_list</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><span class="n"><span class="pre">DataType</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">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv410large_listRKNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_large_list_type"><span class="std std-ref">LargeListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49list_viewNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv39list_viewNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv29list_viewNSt10shared_ptrI8DataTypeEE"></span><span id="list_view__std::shared_ptr:DataType:"></span><span class="target" id="group__type-factories_1ga959ee922d500299d19ad799de2070b07"></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><span class="n"><span class="pre">DataType</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">list_view</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49list_viewNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_view_type"><span class="std std-ref">ListViewType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49list_viewNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv39list_viewNSt10shared_ptrI5FieldEE"></span><span id="_CPPv29list_viewNSt10shared_ptrI5FieldEE"></span><span id="list_view__std::shared_ptr:Field:"></span><span class="target" id="group__type-factories_1ga90826e131d85541ed6603543aed805a7"></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><span class="n"><span class="pre">DataType</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">list_view</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><span class="n"><span class="pre">Field</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49list_viewNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_list_view_type"><span class="std std-ref">ListViewType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415large_list_viewNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv315large_list_viewNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv215large_list_viewNSt10shared_ptrI8DataTypeEE"></span><span id="large_list_view__std::shared_ptr:DataType:"></span><span class="target" id="group__type-factories_1ga4d8c705c06fc3d5deb26b2e43df747b7"></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><span class="n"><span class="pre">DataType</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">large_list_view</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415large_list_viewNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a LargetListViewType instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415large_list_viewNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv315large_list_viewNSt10shared_ptrI5FieldEE"></span><span id="_CPPv215large_list_viewNSt10shared_ptrI5FieldEE"></span><span id="large_list_view__std::shared_ptr:Field:"></span><span class="target" id="group__type-factories_1ga8c5b2b2aab7c627bbb646ed829e89cda"></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><span class="n"><span class="pre">DataType</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">large_list_view</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><span class="n"><span class="pre">Field</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415large_list_viewNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a LargetListViewType instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv43mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEEb"> |
| <span id="_CPPv33mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEEb"></span><span id="_CPPv23mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEEb"></span><span id="map__std::shared_ptr:DataType:.std::shared_ptr:DataType:.b"></span><span class="target" id="group__type-factories_1ga79fe33bb469b28aad1b19c5c06e2d192"></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><span class="n"><span class="pre">DataType</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">map</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">key_type</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">item_type</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="#_CPPv43mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_map_type"><span class="std std-ref">MapType</span></a> instance from its key and value DataTypes. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv43mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI5FieldEEb"> |
| <span id="_CPPv33mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI5FieldEEb"></span><span id="_CPPv23mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI5FieldEEb"></span><span id="map__std::shared_ptr:DataType:.std::shared_ptr:Field:.b"></span><span class="target" id="group__type-factories_1ga18615740a96bb242b5c4cee14ae2af15"></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><span class="n"><span class="pre">DataType</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">map</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">key_type</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><span class="n"><span class="pre">Field</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">item_field</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="#_CPPv43mapNSt10shared_ptrI8DataTypeEENSt10shared_ptrI5FieldEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_map_type"><span class="std std-ref">MapType</span></a> instance from its key <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> and value field. </p> |
| <p>The field override is provided to communicate nullability of the value. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415fixed_size_listRKNSt10shared_ptrI5FieldEE7int32_t"> |
| <span id="_CPPv315fixed_size_listRKNSt10shared_ptrI5FieldEE7int32_t"></span><span id="_CPPv215fixed_size_listRKNSt10shared_ptrI5FieldEE7int32_t"></span><span id="fixed_size_list__std::shared_ptr:Field:CR.int32_t"></span><span class="target" id="group__type-factories_1gad5bb35da3242368660a754a0d47e518b"></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><span class="n"><span class="pre">DataType</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">fixed_size_list</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><span class="n"><span class="pre">Field</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">value_type</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="#_CPPv415fixed_size_listRKNSt10shared_ptrI5FieldEE7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_fixed_size_list_type"><span class="std std-ref">FixedSizeListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415fixed_size_listRKNSt10shared_ptrI8DataTypeEE7int32_t"> |
| <span id="_CPPv315fixed_size_listRKNSt10shared_ptrI8DataTypeEE7int32_t"></span><span id="_CPPv215fixed_size_listRKNSt10shared_ptrI8DataTypeEE7int32_t"></span><span id="fixed_size_list__std::shared_ptr:DataType:CR.int32_t"></span><span class="target" id="group__type-factories_1ga09fb55b2d07e324f1560a8eeb142e2ed"></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><span class="n"><span class="pre">DataType</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">fixed_size_list</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><span class="n"><span class="pre">DataType</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">value_type</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="#_CPPv415fixed_size_listRKNSt10shared_ptrI8DataTypeEE7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_fixed_size_list_type"><span class="std std-ref">FixedSizeListType</span></a> instance from its child <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv48durationN8TimeUnit4typeE"> |
| <span id="_CPPv38durationN8TimeUnit4typeE"></span><span id="_CPPv28durationN8TimeUnit4typeE"></span><span id="duration__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga4a09df951503764895e56db3fe5d053c"></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><span class="n"><span class="pre">DataType</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">duration</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv48durationN8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a Duration instance (naming use _type to avoid namespace conflict with built in time classes). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv417day_time_intervalv"> |
| <span id="_CPPv317day_time_intervalv"></span><span id="_CPPv217day_time_intervalv"></span><span id="day_time_interval"></span><span class="target" id="group__type-factories_1ga81643b6c32e9c11375084c074567cba0"></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><span class="n"><span class="pre">DataType</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">day_time_interval</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv417day_time_intervalv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_day_time_interval_type"><span class="std std-ref">DayTimeIntervalType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv414month_intervalv"> |
| <span id="_CPPv314month_intervalv"></span><span id="_CPPv214month_intervalv"></span><span id="month_interval"></span><span class="target" id="group__type-factories_1gaf3c6cebcb8e66ada1ea7bbfe5d4c8978"></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><span class="n"><span class="pre">DataType</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">month_interval</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv414month_intervalv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_month_interval_type"><span class="std std-ref">MonthIntervalType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv423month_day_nano_intervalv"> |
| <span id="_CPPv323month_day_nano_intervalv"></span><span id="_CPPv223month_day_nano_intervalv"></span><span id="month_day_nano_interval"></span><span class="target" id="group__type-factories_1ga0aee9f1a2679cffe3d8e95f57db70c6b"></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><span class="n"><span class="pre">DataType</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">month_day_nano_interval</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv423month_day_nano_intervalv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a <a class="reference internal" href="#classarrow_1_1_month_day_nano_interval_type"><span class="std std-ref">MonthDayNanoIntervalType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49timestampN8TimeUnit4typeE"> |
| <span id="_CPPv39timestampN8TimeUnit4typeE"></span><span id="_CPPv29timestampN8TimeUnit4typeE"></span><span id="timestamp__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga862528838ca7d12e13c09edc02bb6151"></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><span class="n"><span class="pre">DataType</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">timestamp</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49timestampN8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a> instance from its unit. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv49timestampN8TimeUnit4typeERKNSt6stringE"> |
| <span id="_CPPv39timestampN8TimeUnit4typeERKNSt6stringE"></span><span id="_CPPv29timestampN8TimeUnit4typeERKNSt6stringE"></span><span id="timestamp__TimeUnit::type.ssCR"></span><span class="target" id="group__type-factories_1ga58fe6ad4ca179979515028f11d8abbca"></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><span class="n"><span class="pre">DataType</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">timestamp</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</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">timezone</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv49timestampN8TimeUnit4typeERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a> instance from its unit and timezone. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46time32N8TimeUnit4typeE"> |
| <span id="_CPPv36time32N8TimeUnit4typeE"></span><span id="_CPPv26time32N8TimeUnit4typeE"></span><span id="time32__TimeUnit::type"></span><span class="target" id="group__type-factories_1gae2e76c6504af1c30799b5b4d7e737305"></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><span class="n"><span class="pre">DataType</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">time32</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46time32N8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a 32-bit time type instance. </p> |
| <p>Unit can be either SECOND or MILLI </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46time64N8TimeUnit4typeE"> |
| <span id="_CPPv36time64N8TimeUnit4typeE"></span><span id="_CPPv26time64N8TimeUnit4typeE"></span><span id="time64__TimeUnit::type"></span><span class="target" id="group__type-factories_1ga7f6f30b7153111da33e446965b5531e3"></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><span class="n"><span class="pre">DataType</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">time64</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv46time64N8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a 64-bit time type instance. </p> |
| <p>Unit can be either MICRO or NANO </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47struct_RK11FieldVector"> |
| <span id="_CPPv37struct_RK11FieldVector"></span><span id="_CPPv27struct_RK11FieldVector"></span><span id="struct___FieldVectorCR"></span><span class="target" id="group__type-factories_1ga50080cb521ca54c0049aa7a9dadec2fe"></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><span class="n"><span class="pre">DataType</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">struct_</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">FieldVector</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">fields</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47struct_RK11FieldVector" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv47struct_NSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE"> |
| <span id="_CPPv37struct_NSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE"></span><span id="_CPPv27struct_NSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE"></span><span id="struct___std::initializer_list:std::pair:ss.std::shared_ptr:DataType:::"></span><span class="target" id="group__type-factories_1ga515d77843195e60494ac3208163b3c11"></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><span class="n"><span class="pre">DataType</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">struct_</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">initializer_list</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">pair</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="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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><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">fields</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv47struct_NSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> instance from (name, type) pairs. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv415run_end_encodedNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv315run_end_encodedNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv215run_end_encodedNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEE"></span><span id="run_end_encoded__std::shared_ptr:DataType:.std::shared_ptr:DataType:"></span><span class="target" id="group__type-factories_1ga4828255a744bc46274d52ba05f63521c"></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><span class="n"><span class="pre">DataType</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">run_end_encoded</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">run_end_type</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">value_type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv415run_end_encodedNSt10shared_ptrI8DataTypeEENSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_run_end_encoded_type"><span class="std std-ref">RunEndEncodedType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412sparse_union11FieldVectorNSt6vectorI6int8_tEE"> |
| <span id="_CPPv312sparse_union11FieldVectorNSt6vectorI6int8_tEE"></span><span id="_CPPv212sparse_union11FieldVectorNSt6vectorI6int8_tEE"></span><span id="sparse_union__FieldVector.std::vector:int8_t:"></span><span class="target" id="group__type-factories_1ga201052409362d66f453a58b881499bfc"></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><span class="n"><span class="pre">DataType</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">sparse_union</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">child_fields</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">int8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type_codes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412sparse_union11FieldVectorNSt6vectorI6int8_tEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_sparse_union_type"><span class="std std-ref">SparseUnionType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv412sparse_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"> |
| <span id="_CPPv312sparse_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"></span><span id="_CPPv212sparse_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"></span><span id="sparse_union__ArrayVectorCR.std::vector:ss:.std::vector:int8_t:"></span><span class="target" id="group__type-factories_1gac868eedb38a01a1e962ba7c328e21ea1"></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><span class="n"><span class="pre">DataType</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">sparse_union</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">ArrayVector</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="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="n sig-param"><span class="pre">field_names</span></span><span class="w"> </span><span class="p"><span class="pre">=</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"><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">int8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type_codes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv412sparse_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_sparse_union_type"><span class="std std-ref">SparseUnionType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv411dense_union11FieldVectorNSt6vectorI6int8_tEE"> |
| <span id="_CPPv311dense_union11FieldVectorNSt6vectorI6int8_tEE"></span><span id="_CPPv211dense_union11FieldVectorNSt6vectorI6int8_tEE"></span><span id="dense_union__FieldVector.std::vector:int8_t:"></span><span class="target" id="group__type-factories_1gad596f8d979459a042e0da6d66af3283e"></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><span class="n"><span class="pre">DataType</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">dense_union</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">child_fields</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">int8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type_codes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411dense_union11FieldVectorNSt6vectorI6int8_tEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_dense_union_type"><span class="std std-ref">DenseUnionType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv411dense_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"> |
| <span id="_CPPv311dense_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"></span><span id="_CPPv211dense_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE"></span><span id="dense_union__ArrayVectorCR.std::vector:ss:.std::vector:int8_t:"></span><span class="target" id="group__type-factories_1gaa74c0eac226a6da59bc5cc237efd65ea"></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><span class="n"><span class="pre">DataType</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">dense_union</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">ArrayVector</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="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="n sig-param"><span class="pre">field_names</span></span><span class="w"> </span><span class="p"><span class="pre">=</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"><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">int8_t</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type_codes</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="p"><span class="pre">{</span></span><span class="p"><span class="pre">}</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv411dense_unionRK11ArrayVectorNSt6vectorINSt6stringEEENSt6vectorI6int8_tEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_dense_union_type"><span class="std std-ref">DenseUnionType</span></a> instance. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv410dictionaryRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"> |
| <span id="_CPPv310dictionaryRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="_CPPv210dictionaryRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb"></span><span id="dictionary__std::shared_ptr:DataType:CR.std::shared_ptr:DataType:CR.b"></span><span class="target" id="group__type-factories_1ga36f61c68b2a04a9d179cb56ff1186c59"></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><span class="n"><span class="pre">DataType</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">dictionary</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><span class="n"><span class="pre">DataType</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">index_type</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><span class="n"><span class="pre">DataType</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">dict_type</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">ordered</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="#_CPPv410dictionaryRKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI8DataTypeEEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_dictionary_type"><span class="std std-ref">DictionaryType</span></a> instance. </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>index_type</strong> – <strong>[in]</strong> the type of the dictionary indices (must be a signed integer) </p></li> |
| <li><p><strong>dict_type</strong> – <strong>[in]</strong> the type of the values in the variable dictionary </p></li> |
| <li><p><strong>ordered</strong> – <strong>[in]</strong> true if the order of the dictionary values has semantic meaning and should be preserved where possible </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| </section> |
| <section id="concrete-type-subclasses"> |
| <h2>Concrete type subclasses<a class="headerlink" href="#concrete-type-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="_CPPv4N5arrow8NullTypeE"> |
| <span id="_CPPv3N5arrow8NullTypeE"></span><span id="_CPPv2N5arrow8NullTypeE"></span><span id="arrow::NullType"></span><span class="target" id="classarrow_1_1_null_type"></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">NullType</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow8NullTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Concrete type class for always-null data. </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="_CPPv4NK5arrow8NullType8ToStringEb"> |
| <span id="_CPPv3NK5arrow8NullType8ToStringEb"></span><span id="_CPPv2NK5arrow8NullType8ToStringEb"></span><span id="arrow::NullType::ToString__bC"></span><span class="target" id="classarrow_1_1_null_type_1a4238f0a1ba6ef1c93d1d2458f308784f"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow8NullType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8NullType6layoutEv"> |
| <span id="_CPPv3NK5arrow8NullType6layoutEv"></span><span id="_CPPv2NK5arrow8NullType6layoutEv"></span><span id="arrow::NullType::layoutC"></span><span class="target" id="classarrow_1_1_null_type_1a3354ed04f7b102360f93475b75d6aa0d"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow8NullType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8NullType4nameEv"> |
| <span id="_CPPv3NK5arrow8NullType4nameEv"></span><span id="_CPPv2NK5arrow8NullType4nameEv"></span><span id="arrow::NullType::nameC"></span><span class="target" id="classarrow_1_1_null_type_1a656232cfad677aebb79f3147b0acdfb2"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow8NullType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11BooleanTypeE"> |
| <span id="_CPPv3N5arrow11BooleanTypeE"></span><span id="_CPPv2N5arrow11BooleanTypeE"></span><span id="arrow::BooleanType"></span><span class="target" id="classarrow_1_1_boolean_type"></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">BooleanType</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">CTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow11BooleanTypeE" title="arrow::BooleanType"><span class="n"><span class="pre">BooleanType</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">PrimitiveCType</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type4BOOLE" title="arrow::Type::BOOL"><span class="n"><span class="pre">BOOL</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="#_CPPv4N5arrow11BooleanTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Concrete type class for boolean data. </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="_CPPv4NK5arrow11BooleanType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow11BooleanType9bit_widthEv"></span><span id="_CPPv2NK5arrow11BooleanType9bit_widthEv"></span><span id="arrow::BooleanType::bit_widthC"></span><span class="target" id="classarrow_1_1_boolean_type_1a8e6a928f4d6cf6cace04b8fca61910de"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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">final</span></span><a class="headerlink" href="#_CPPv4NK5arrow11BooleanType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow11BooleanType6layoutEv"> |
| <span id="_CPPv3NK5arrow11BooleanType6layoutEv"></span><span id="_CPPv2NK5arrow11BooleanType6layoutEv"></span><span id="arrow::BooleanType::layoutC"></span><span class="target" id="classarrow_1_1_boolean_type_1a682141096208fc1fd72a31cdcf668a8d"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow11BooleanType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9UInt8TypeE"> |
| <span id="_CPPv3N5arrow9UInt8TypeE"></span><span id="_CPPv2N5arrow9UInt8TypeE"></span><span id="arrow::UInt8Type"></span><span class="target" id="classarrow_1_1_u_int8_type"></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">UInt8Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9UInt8TypeE" title="arrow::UInt8Type"><span class="n"><span class="pre">UInt8Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type5UINT8E" title="arrow::Type::UINT8"><span class="n"><span class="pre">UINT8</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint8_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow9UInt8TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for unsigned 8-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8Int8TypeE"> |
| <span id="_CPPv3N5arrow8Int8TypeE"></span><span id="_CPPv2N5arrow8Int8TypeE"></span><span id="arrow::Int8Type"></span><span class="target" id="classarrow_1_1_int8_type"></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">Int8Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8Int8TypeE" title="arrow::Int8Type"><span class="n"><span class="pre">Int8Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type4INT8E" title="arrow::Type::INT8"><span class="n"><span class="pre">INT8</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int8_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow8Int8TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for signed 8-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10UInt16TypeE"> |
| <span id="_CPPv3N5arrow10UInt16TypeE"></span><span id="_CPPv2N5arrow10UInt16TypeE"></span><span id="arrow::UInt16Type"></span><span class="target" id="classarrow_1_1_u_int16_type"></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">UInt16Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow10UInt16TypeE" title="arrow::UInt16Type"><span class="n"><span class="pre">UInt16Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type6UINT16E" title="arrow::Type::UINT16"><span class="n"><span class="pre">UINT16</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint16_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow10UInt16TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for unsigned 16-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9Int16TypeE"> |
| <span id="_CPPv3N5arrow9Int16TypeE"></span><span id="_CPPv2N5arrow9Int16TypeE"></span><span id="arrow::Int16Type"></span><span class="target" id="classarrow_1_1_int16_type"></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">Int16Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9Int16TypeE" title="arrow::Int16Type"><span class="n"><span class="pre">Int16Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type5INT16E" title="arrow::Type::INT16"><span class="n"><span class="pre">INT16</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int16_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow9Int16TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for signed 16-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10UInt32TypeE"> |
| <span id="_CPPv3N5arrow10UInt32TypeE"></span><span id="_CPPv2N5arrow10UInt32TypeE"></span><span id="arrow::UInt32Type"></span><span class="target" id="classarrow_1_1_u_int32_type"></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">UInt32Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow10UInt32TypeE" title="arrow::UInt32Type"><span class="n"><span class="pre">UInt32Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type6UINT32E" title="arrow::Type::UINT32"><span class="n"><span class="pre">UINT32</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint32_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow10UInt32TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for unsigned 32-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9Int32TypeE"> |
| <span id="_CPPv3N5arrow9Int32TypeE"></span><span id="_CPPv2N5arrow9Int32TypeE"></span><span id="arrow::Int32Type"></span><span class="target" id="classarrow_1_1_int32_type"></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">Int32Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9Int32TypeE" title="arrow::Int32Type"><span class="n"><span class="pre">Int32Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type5INT32E" title="arrow::Type::INT32"><span class="n"><span class="pre">INT32</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int32_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow9Int32TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for signed 32-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10UInt64TypeE"> |
| <span id="_CPPv3N5arrow10UInt64TypeE"></span><span id="_CPPv2N5arrow10UInt64TypeE"></span><span id="arrow::UInt64Type"></span><span class="target" id="classarrow_1_1_u_int64_type"></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">UInt64Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow10UInt64TypeE" title="arrow::UInt64Type"><span class="n"><span class="pre">UInt64Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type6UINT64E" title="arrow::Type::UINT64"><span class="n"><span class="pre">UINT64</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint64_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow10UInt64TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for unsigned 64-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9Int64TypeE"> |
| <span id="_CPPv3N5arrow9Int64TypeE"></span><span id="_CPPv2N5arrow9Int64TypeE"></span><span id="arrow::Int64Type"></span><span class="target" id="classarrow_1_1_int64_type"></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">Int64Type</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">IntegerTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9Int64TypeE" title="arrow::Int64Type"><span class="n"><span class="pre">Int64Type</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type5INT64E" title="arrow::Type::INT64"><span class="n"><span class="pre">INT64</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">int64_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow9Int64TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for signed 64-bit integer data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13HalfFloatTypeE"> |
| <span id="_CPPv3N5arrow13HalfFloatTypeE"></span><span id="_CPPv2N5arrow13HalfFloatTypeE"></span><span id="arrow::HalfFloatType"></span><span class="target" id="classarrow_1_1_half_float_type"></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">HalfFloatType</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">CTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow13HalfFloatTypeE" title="arrow::HalfFloatType"><span class="n"><span class="pre">HalfFloatType</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">FloatingPointType</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type10HALF_FLOATE" title="arrow::Type::HALF_FLOAT"><span class="n"><span class="pre">HALF_FLOAT</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">uint16_t</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow13HalfFloatTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 16-bit floating-point data. </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9FloatTypeE"> |
| <span id="_CPPv3N5arrow9FloatTypeE"></span><span id="_CPPv2N5arrow9FloatTypeE"></span><span id="arrow::FloatType"></span><span class="target" id="classarrow_1_1_float_type"></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">FloatType</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">CTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9FloatTypeE" title="arrow::FloatType"><span class="n"><span class="pre">FloatType</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">FloatingPointType</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type5FLOATE" title="arrow::Type::FLOAT"><span class="n"><span class="pre">FLOAT</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">float</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow9FloatTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 32-bit floating-point data (C “float”) </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10DoubleTypeE"> |
| <span id="_CPPv3N5arrow10DoubleTypeE"></span><span id="_CPPv2N5arrow10DoubleTypeE"></span><span id="arrow::DoubleType"></span><span class="target" id="classarrow_1_1_double_type"></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">DoubleType</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">CTypeImpl</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow10DoubleTypeE" title="arrow::DoubleType"><span class="n"><span class="pre">DoubleType</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">FloatingPointType</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4type6DOUBLEE" title="arrow::Type::DOUBLE"><span class="n"><span class="pre">DOUBLE</span></span></a><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="kt"><span class="pre">double</span></span><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow10DoubleTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 64-bit floating-point data (C “double”) </p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11DecimalTypeE"> |
| <span id="_CPPv3N5arrow11DecimalTypeE"></span><span id="_CPPv2N5arrow11DecimalTypeE"></span><span id="arrow::DecimalType"></span><span class="target" id="classarrow_1_1_decimal_type"></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">DecimalType</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="#_CPPv4N5arrow19FixedSizeBinaryTypeE" title="arrow::FixedSizeBinaryType"><span class="n"><span class="pre">FixedSizeBinaryType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow11DecimalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base type class for (fixed-size) decimal data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">arrow::Decimal128Type</span></a>, <a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">arrow::Decimal256Type</span></a></p> |
| <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="_CPPv4N5arrow11DecimalType4MakeEN4Type4typeE7int32_t7int32_t"> |
| <span id="_CPPv3N5arrow11DecimalType4MakeEN4Type4typeE7int32_t7int32_t"></span><span id="_CPPv2N5arrow11DecimalType4MakeEN4Type4typeE7int32_t7int32_t"></span><span id="arrow::DecimalType::Make__Type::type.int32_t.int32_t"></span><span class="target" id="classarrow_1_1_decimal_type_1a8bb14f0aae163228bb9738b0d7c9dced"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</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="n"><span class="pre">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4typeE" title="arrow::Type::type"><span class="n"><span class="pre">type</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">type_id</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow11DecimalType4MakeEN4Type4typeE7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Constructs concrete decimal types. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11DecimalType11DecimalSizeE7int32_t"> |
| <span id="_CPPv3N5arrow11DecimalType11DecimalSizeE7int32_t"></span><span id="_CPPv2N5arrow11DecimalType11DecimalSizeE7int32_t"></span><span id="arrow::DecimalType::DecimalSize__int32_t"></span><span class="target" id="classarrow_1_1_decimal_type_1ad640d94bd76d4d3b50d56fb4262bf1b2"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DecimalSize</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow11DecimalType11DecimalSizeE7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the number of bytes needed for precision. </p> |
| <p>precision must be >= 1 </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14Decimal128TypeE"> |
| <span id="_CPPv3N5arrow14Decimal128TypeE"></span><span id="_CPPv2N5arrow14Decimal128TypeE"></span><span id="arrow::Decimal128Type"></span><span class="target" id="classarrow_1_1_decimal128_type"></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">Decimal128Type</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="#_CPPv4N5arrow11DecimalTypeE" title="arrow::DecimalType"><span class="n"><span class="pre">DecimalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow14Decimal128TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 128-bit decimal data. </p> |
| <p>Arrow decimals are fixed-point decimal numbers encoded as a scaled integer. The precision is the number of significant digits that the decimal type can represent; the scale is the number of digits after the decimal point (note the scale can be negative).</p> |
| <p>As an example, <code class="docutils literal notranslate"><span class="pre">Decimal128Type(7,</span> <span class="pre">3)</span></code> can exactly represent the numbers 1234.567 and -1234.567 (encoded internally as the 128-bit integers 1234567 and -1234567, respectively), but neither 12345.67 nor 123.4567.</p> |
| <p><a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> has a maximum precision of 38 significant digits (also available as Decimal128Type::kMaxPrecision). If higher precision is needed, consider using <a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</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="_CPPv4N5arrow14Decimal128Type14Decimal128TypeE7int32_t7int32_t"> |
| <span id="_CPPv3N5arrow14Decimal128Type14Decimal128TypeE7int32_t7int32_t"></span><span id="_CPPv2N5arrow14Decimal128Type14Decimal128TypeE7int32_t7int32_t"></span><span id="arrow::Decimal128Type::Decimal128Type__int32_t.int32_t"></span><span class="target" id="classarrow_1_1_decimal128_type_1a52777308aaa90097b6dff7aba27482c1"></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">Decimal128Type</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14Decimal128Type14Decimal128TypeE7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> constructor that aborts on invalid input. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14Decimal128Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow14Decimal128Type8ToStringEb"></span><span id="_CPPv2NK5arrow14Decimal128Type8ToStringEb"></span><span id="arrow::Decimal128Type::ToString__bC"></span><span class="target" id="classarrow_1_1_decimal128_type_1a78c31a757563e2f0b439bf8221a03195"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow14Decimal128Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14Decimal128Type4nameEv"> |
| <span id="_CPPv3NK5arrow14Decimal128Type4nameEv"></span><span id="_CPPv2NK5arrow14Decimal128Type4nameEv"></span><span id="arrow::Decimal128Type::nameC"></span><span class="target" id="classarrow_1_1_decimal128_type_1a369b5ae40c271133e15571f9c6198170"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14Decimal128Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </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="_CPPv4N5arrow14Decimal128Type4MakeE7int32_t7int32_t"> |
| <span id="_CPPv3N5arrow14Decimal128Type4MakeE7int32_t7int32_t"></span><span id="_CPPv2N5arrow14Decimal128Type4MakeE7int32_t7int32_t"></span><span id="arrow::Decimal128Type::Make__int32_t.int32_t"></span><span class="target" id="classarrow_1_1_decimal128_type_1a2b448df63022091188871a902e00b5e9"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</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="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14Decimal128Type4MakeE7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> constructor that returns an error on invalid input. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14Decimal256TypeE"> |
| <span id="_CPPv3N5arrow14Decimal256TypeE"></span><span id="_CPPv2N5arrow14Decimal256TypeE"></span><span id="arrow::Decimal256Type"></span><span class="target" id="classarrow_1_1_decimal256_type"></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">Decimal256Type</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="#_CPPv4N5arrow11DecimalTypeE" title="arrow::DecimalType"><span class="n"><span class="pre">DecimalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow14Decimal256TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 256-bit decimal data. </p> |
| <p>Arrow decimals are fixed-point decimal numbers encoded as a scaled integer. The precision is the number of significant digits that the decimal type can represent; the scale is the number of digits after the decimal point (note the scale can be negative).</p> |
| <p><a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</span></a> has a maximum precision of 76 significant digits. (also available as Decimal256Type::kMaxPrecision).</p> |
| <p>For most use cases, the maximum precision offered by <a class="reference internal" href="#classarrow_1_1_decimal128_type"><span class="std std-ref">Decimal128Type</span></a> is sufficient, and it will result in a more compact and more efficient encoding. </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="_CPPv4N5arrow14Decimal256Type14Decimal256TypeE7int32_t7int32_t"> |
| <span id="_CPPv3N5arrow14Decimal256Type14Decimal256TypeE7int32_t7int32_t"></span><span id="_CPPv2N5arrow14Decimal256Type14Decimal256TypeE7int32_t7int32_t"></span><span id="arrow::Decimal256Type::Decimal256Type__int32_t.int32_t"></span><span class="target" id="classarrow_1_1_decimal256_type_1a0e33e0523fb48606dc2eb19e166b3406"></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">Decimal256Type</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14Decimal256Type14Decimal256TypeE7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</span></a> constructor that aborts on invalid input. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14Decimal256Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow14Decimal256Type8ToStringEb"></span><span id="_CPPv2NK5arrow14Decimal256Type8ToStringEb"></span><span id="arrow::Decimal256Type::ToString__bC"></span><span class="target" id="classarrow_1_1_decimal256_type_1a6eaa4e57e6b3d337c8e4aa233ee65c00"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow14Decimal256Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14Decimal256Type4nameEv"> |
| <span id="_CPPv3NK5arrow14Decimal256Type4nameEv"></span><span id="_CPPv2NK5arrow14Decimal256Type4nameEv"></span><span id="arrow::Decimal256Type::nameC"></span><span class="target" id="classarrow_1_1_decimal256_type_1a83c3e0a228997604dfecc3c33cb1f8ef"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14Decimal256Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </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="_CPPv4N5arrow14Decimal256Type4MakeE7int32_t7int32_t"> |
| <span id="_CPPv3N5arrow14Decimal256Type4MakeE7int32_t7int32_t"></span><span id="_CPPv2N5arrow14Decimal256Type4MakeE7int32_t7int32_t"></span><span id="arrow::Decimal256Type::Make__int32_t.int32_t"></span><span class="target" id="classarrow_1_1_decimal256_type_1a12c56c0a5b2267c1dc482b3fb7481dfc"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</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="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">precision</span></span>, <span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">scale</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow14Decimal256Type4MakeE7int32_t7int32_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p><a class="reference internal" href="#classarrow_1_1_decimal256_type"><span class="std std-ref">Decimal256Type</span></a> constructor that returns an error on invalid input. </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 enum"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeUnit4typeE"> |
| <span id="_CPPv3N5arrow8TimeUnit4typeE"></span><span id="_CPPv2N5arrow8TimeUnit4typeE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ff"></span><span class="k"><span class="pre">enum</span></span><span class="w"> </span><span class="sig-prename descclassname"><span class="n"><span class="pre">arrow</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span></span><span class="sig-name descname"><span class="n"><span class="pre">type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The unit for a time or timestamp <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p> |
| <p><em>Values:</em></p> |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeUnit4type6SECONDE"> |
| <span id="_CPPv3N5arrow8TimeUnit4type6SECONDE"></span><span id="_CPPv2N5arrow8TimeUnit4type6SECONDE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa1c81ae790d85d35422c1757e0b20be7a"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">SECOND</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4type6SECONDE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeUnit4type5MILLIE"> |
| <span id="_CPPv3N5arrow8TimeUnit4type5MILLIE"></span><span id="_CPPv2N5arrow8TimeUnit4type5MILLIE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffadc3335445f7fa1b26f9c78754a1f217b"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MILLI</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4type5MILLIE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeUnit4type5MICROE"> |
| <span id="_CPPv3N5arrow8TimeUnit4type5MICROE"></span><span id="_CPPv2N5arrow8TimeUnit4type5MICROE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffaf8ce7e9dc4001c956488dd701d567cb1"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MICRO</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4type5MICROE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp enumerator"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeUnit4type4NANOE"> |
| <span id="_CPPv3N5arrow8TimeUnit4type4NANOE"></span><span id="_CPPv2N5arrow8TimeUnit4type4NANOE"></span><span class="target" id="structarrow_1_1_time_unit_1a561ef51c3755bd873f8f86f5bc4ec1ffa88a677627c74df18d59f1aa6cd1c88d5"></span><span class="k"><span class="pre">enumerator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">NANO</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeUnit4type4NANOE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4lsRNSt7ostreamEN8TimeUnit4typeE"> |
| <span id="_CPPv3lsRNSt7ostreamEN8TimeUnit4typeE"></span><span id="_CPPv2lsRNSt7ostreamEN8TimeUnit4typeE"></span><span id="lshift-operator__osR.TimeUnit::type"></span><span class="target" id="group__temporal-datatypes_1ga0877817f90cecf7a3b19a199b7195e2d"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre"><<</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">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">os</span></span>, <span class="n"><span class="pre">TimeUnit</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">type</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">unit</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4lsRNSt7ostreamEN8TimeUnit4typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4lsRNSt7ostreamEN19DayTimeIntervalType15DayMillisecondsE"> |
| <span id="_CPPv3lsRNSt7ostreamEN19DayTimeIntervalType15DayMillisecondsE"></span><span id="_CPPv2lsRNSt7ostreamEN19DayTimeIntervalType15DayMillisecondsE"></span><span id="lshift-operator__osR.DayTimeIntervalType::DayMilliseconds"></span><span class="target" id="group__temporal-datatypes_1gab781b4fa5cfe558a93fda6bb1e1f773b"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre"><<</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">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">os</span></span>, <span class="n"><span class="pre">DayTimeIntervalType</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">DayMilliseconds</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">interval</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4lsRNSt7ostreamEN19DayTimeIntervalType15DayMillisecondsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4lsRNSt7ostreamEN24MonthDayNanoIntervalType13MonthDayNanosE"> |
| <span id="_CPPv3lsRNSt7ostreamEN24MonthDayNanoIntervalType13MonthDayNanosE"></span><span id="_CPPv2lsRNSt7ostreamEN24MonthDayNanoIntervalType13MonthDayNanosE"></span><span id="lshift-operator__osR.MonthDayNanoIntervalType::MonthDayNanos"></span><span class="target" id="group__temporal-datatypes_1ga2e6623d39e596684e6471bc746abf47c"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre"><<</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">ostream</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">os</span></span>, <span class="n"><span class="pre">MonthDayNanoIntervalType</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">MonthDayNanos</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">interval</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4lsRNSt7ostreamEN24MonthDayNanoIntervalType13MonthDayNanosE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12TemporalTypeE"> |
| <span id="_CPPv3N5arrow12TemporalTypeE"></span><span id="_CPPv2N5arrow12TemporalTypeE"></span><span id="arrow::TemporalType"></span><span class="target" id="classarrow_1_1_temporal_type"></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">TemporalType</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">FixedWidthType</span></span><a class="headerlink" href="#_CPPv4N5arrow12TemporalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base type for all date and time types. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_date_type"><span class="std std-ref">arrow::DateType</span></a>, <a class="reference internal" href="#classarrow_1_1_duration_type"><span class="std std-ref">arrow::DurationType</span></a>, <a class="reference internal" href="#classarrow_1_1_interval_type"><span class="std std-ref">arrow::IntervalType</span></a>, <a class="reference internal" href="#classarrow_1_1_time_type"><span class="std std-ref">arrow::TimeType</span></a>, <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">arrow::TimestampType</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="_CPPv4NK5arrow12TemporalType6layoutEv"> |
| <span id="_CPPv3NK5arrow12TemporalType6layoutEv"></span><span id="_CPPv2NK5arrow12TemporalType6layoutEv"></span><span id="arrow::TemporalType::layoutC"></span><span class="target" id="classarrow_1_1_temporal_type_1a3765b88dae2be6093850dd40f785386b"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow12TemporalType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8DateTypeE"> |
| <span id="_CPPv3N5arrow8DateTypeE"></span><span id="_CPPv2N5arrow8DateTypeE"></span><span id="arrow::DateType"></span><span class="target" id="classarrow_1_1_date_type"></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">DateType</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="#_CPPv4N5arrow12TemporalTypeE" title="arrow::TemporalType"><span class="n"><span class="pre">TemporalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow8DateTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base type class for date data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_date32_type"><span class="std std-ref">arrow::Date32Type</span></a>, <a class="reference internal" href="#classarrow_1_1_date64_type"><span class="std std-ref">arrow::Date64Type</span></a></p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10Date32TypeE"> |
| <span id="_CPPv3N5arrow10Date32TypeE"></span><span id="_CPPv2N5arrow10Date32TypeE"></span><span id="arrow::Date32Type"></span><span class="target" id="classarrow_1_1_date32_type"></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">Date32Type</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="#_CPPv4N5arrow8DateTypeE" title="arrow::DateType"><span class="n"><span class="pre">DateType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10Date32TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 32-bit date data (as number of days since UNIX epoch) </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="_CPPv4NK5arrow10Date32Type9bit_widthEv"> |
| <span id="_CPPv3NK5arrow10Date32Type9bit_widthEv"></span><span id="_CPPv2NK5arrow10Date32Type9bit_widthEv"></span><span id="arrow::Date32Type::bit_widthC"></span><span class="target" id="classarrow_1_1_date32_type_1a136d1e9e6eb85aae9b1034790d7df087"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow10Date32Type9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Date32Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow10Date32Type8ToStringEb"></span><span id="_CPPv2NK5arrow10Date32Type8ToStringEb"></span><span id="arrow::Date32Type::ToString__bC"></span><span class="target" id="classarrow_1_1_date32_type_1a51900a96730b8e9341d6c793d240c124"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10Date32Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Date32Type4nameEv"> |
| <span id="_CPPv3NK5arrow10Date32Type4nameEv"></span><span id="_CPPv2NK5arrow10Date32Type4nameEv"></span><span id="arrow::Date32Type::nameC"></span><span class="target" id="classarrow_1_1_date32_type_1a67136dde9b0df81a730d9f8aaeea3d10"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10Date32Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10Date64TypeE"> |
| <span id="_CPPv3N5arrow10Date64TypeE"></span><span id="_CPPv2N5arrow10Date64TypeE"></span><span id="arrow::Date64Type"></span><span class="target" id="classarrow_1_1_date64_type"></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">Date64Type</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="#_CPPv4N5arrow8DateTypeE" title="arrow::DateType"><span class="n"><span class="pre">DateType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10Date64TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 64-bit date data (as number of milliseconds since UNIX epoch) </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="_CPPv4NK5arrow10Date64Type9bit_widthEv"> |
| <span id="_CPPv3NK5arrow10Date64Type9bit_widthEv"></span><span id="_CPPv2NK5arrow10Date64Type9bit_widthEv"></span><span id="arrow::Date64Type::bit_widthC"></span><span class="target" id="classarrow_1_1_date64_type_1a8ee39ed5007d48070a9889716e044b04"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow10Date64Type9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Date64Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow10Date64Type8ToStringEb"></span><span id="_CPPv2NK5arrow10Date64Type8ToStringEb"></span><span id="arrow::Date64Type::ToString__bC"></span><span class="target" id="classarrow_1_1_date64_type_1ae548859db2f1f6ccb364b7cdd5dda3a9"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10Date64Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Date64Type4nameEv"> |
| <span id="_CPPv3NK5arrow10Date64Type4nameEv"></span><span id="_CPPv2NK5arrow10Date64Type4nameEv"></span><span id="arrow::Date64Type::nameC"></span><span class="target" id="classarrow_1_1_date64_type_1a48afc838a3ac17c2ae579da3b6387f48"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10Date64Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8TimeTypeE"> |
| <span id="_CPPv3N5arrow8TimeTypeE"></span><span id="_CPPv2N5arrow8TimeTypeE"></span><span id="arrow::TimeType"></span><span class="target" id="classarrow_1_1_time_type"></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">TimeType</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="#_CPPv4N5arrow12TemporalTypeE" title="arrow::TemporalType"><span class="n"><span class="pre">TemporalType</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">ParametricType</span></span><a class="headerlink" href="#_CPPv4N5arrow8TimeTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base type class for time data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_time32_type"><span class="std std-ref">arrow::Time32Type</span></a>, <a class="reference internal" href="#classarrow_1_1_time64_type"><span class="std std-ref">arrow::Time64Type</span></a></p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10Time32TypeE"> |
| <span id="_CPPv3N5arrow10Time32TypeE"></span><span id="_CPPv2N5arrow10Time32TypeE"></span><span id="arrow::Time32Type"></span><span class="target" id="classarrow_1_1_time32_type"></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">Time32Type</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="#_CPPv4N5arrow8TimeTypeE" title="arrow::TimeType"><span class="n"><span class="pre">TimeType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10Time32TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 32-bit time data (as number of seconds or milliseconds since midnight) </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="_CPPv4NK5arrow10Time32Type9bit_widthEv"> |
| <span id="_CPPv3NK5arrow10Time32Type9bit_widthEv"></span><span id="_CPPv2NK5arrow10Time32Type9bit_widthEv"></span><span id="arrow::Time32Type::bit_widthC"></span><span class="target" id="classarrow_1_1_time32_type_1af89bb7619663d931abd938f63ffadb91"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow10Time32Type9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Time32Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow10Time32Type8ToStringEb"></span><span id="_CPPv2NK5arrow10Time32Type8ToStringEb"></span><span id="arrow::Time32Type::ToString__bC"></span><span class="target" id="classarrow_1_1_time32_type_1af6f3d3a959b4918b1f21e20835bf5192"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10Time32Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Time32Type4nameEv"> |
| <span id="_CPPv3NK5arrow10Time32Type4nameEv"></span><span id="_CPPv2NK5arrow10Time32Type4nameEv"></span><span id="arrow::Time32Type::nameC"></span><span class="target" id="classarrow_1_1_time32_type_1a7ad35f94f66f2e2f6c718328d0b1e928"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10Time32Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10Time64TypeE"> |
| <span id="_CPPv3N5arrow10Time64TypeE"></span><span id="_CPPv2N5arrow10Time64TypeE"></span><span id="arrow::Time64Type"></span><span class="target" id="classarrow_1_1_time64_type"></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">Time64Type</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="#_CPPv4N5arrow8TimeTypeE" title="arrow::TimeType"><span class="n"><span class="pre">TimeType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10Time64TypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for 64-bit time data (as number of microseconds or nanoseconds since midnight) </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="_CPPv4NK5arrow10Time64Type9bit_widthEv"> |
| <span id="_CPPv3NK5arrow10Time64Type9bit_widthEv"></span><span id="_CPPv2NK5arrow10Time64Type9bit_widthEv"></span><span id="arrow::Time64Type::bit_widthC"></span><span class="target" id="classarrow_1_1_time64_type_1a7122f298d1595a5f4555830ebd38d8bc"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow10Time64Type9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Time64Type8ToStringEb"> |
| <span id="_CPPv3NK5arrow10Time64Type8ToStringEb"></span><span id="_CPPv2NK5arrow10Time64Type8ToStringEb"></span><span id="arrow::Time64Type::ToString__bC"></span><span class="target" id="classarrow_1_1_time64_type_1aa8f643ce3a1a959b31b12285c85331e8"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10Time64Type8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10Time64Type4nameEv"> |
| <span id="_CPPv3NK5arrow10Time64Type4nameEv"></span><span id="_CPPv2NK5arrow10Time64Type4nameEv"></span><span id="arrow::Time64Type::nameC"></span><span class="target" id="classarrow_1_1_time64_type_1abba4ccc76c566ee3f61997f78660dd79"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10Time64Type4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13TimestampTypeE"> |
| <span id="_CPPv3N5arrow13TimestampTypeE"></span><span id="_CPPv2N5arrow13TimestampTypeE"></span><span id="arrow::TimestampType"></span><span class="target" id="classarrow_1_1_timestamp_type"></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">TimestampType</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="#_CPPv4N5arrow12TemporalTypeE" title="arrow::TemporalType"><span class="n"><span class="pre">TemporalType</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">ParametricType</span></span><a class="headerlink" href="#_CPPv4N5arrow13TimestampTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for datetime data (as number of seconds, milliseconds, microseconds or nanoseconds since UNIX epoch) </p> |
| <p>If supplied, the timezone string should take either the form (i) “Area/Location”, with values drawn from the names in the IANA Time Zone Database (such as “Europe/Zurich”); or (ii) “(+|-)HH:MM” indicating an absolute offset from GMT (such as “-08:00”). To indicate a native UTC timestamp, one of the strings “UTC”, “Etc/UTC” or “+00:00” should be used.</p> |
| <p>If any non-empty string is supplied as the timezone for a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a>, then the Arrow field containing that timestamp type (and by extension the column associated with such a field) is considered “timezone-aware”. The integer arrays that comprise a timezone-aware column must contain UTC normalized datetime values, regardless of the contents of their timezone string. More precisely, (i) the producer of a timezone-aware column must populate its constituent arrays with valid UTC values (performing offset conversions from non-UTC values if necessary); and (ii) the consumer of a timezone-aware column may assume that the column’s values are directly comparable (that is, with no offset adjustment required) to the values of any other timezone-aware column or to any other valid UTC datetime value (provided all values are expressed in the same units).</p> |
| <p>If a <a class="reference internal" href="#classarrow_1_1_timestamp_type"><span class="std std-ref">TimestampType</span></a> is constructed without a timezone (or, equivalently, if the timezone supplied is an empty string) then the resulting Arrow field (column) is considered “timezone-naive”. The producer of a timezone-naive column may populate its constituent integer arrays with datetime values from any timezone; the consumer of a timezone-naive column should make no assumptions about the interoperability or comparability of the values of such a column with those of any other timestamp column or datetime value.</p> |
| <p>If a timezone-aware field contains a recognized timezone, its values may be localized to that locale upon display; the values of timezone-naive fields must always be displayed “as is”, with no localization performed on them. </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="_CPPv4NK5arrow13TimestampType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow13TimestampType9bit_widthEv"></span><span id="_CPPv2NK5arrow13TimestampType9bit_widthEv"></span><span id="arrow::TimestampType::bit_widthC"></span><span class="target" id="classarrow_1_1_timestamp_type_1acc58878534b7582bd4b60ba575b18215"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow13TimestampType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13TimestampType8ToStringEb"> |
| <span id="_CPPv3NK5arrow13TimestampType8ToStringEb"></span><span id="_CPPv2NK5arrow13TimestampType8ToStringEb"></span><span id="arrow::TimestampType::ToString__bC"></span><span class="target" id="classarrow_1_1_timestamp_type_1ac9dfe6c84e46944b9f429b820fed4419"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow13TimestampType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13TimestampType4nameEv"> |
| <span id="_CPPv3NK5arrow13TimestampType4nameEv"></span><span id="_CPPv2NK5arrow13TimestampType4nameEv"></span><span id="arrow::TimestampType::nameC"></span><span class="target" id="classarrow_1_1_timestamp_type_1acdca1b7fb9a7d6532dcbbfb6dee2172b"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow13TimestampType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12IntervalTypeE"> |
| <span id="_CPPv3N5arrow12IntervalTypeE"></span><span id="_CPPv2N5arrow12IntervalTypeE"></span><span id="arrow::IntervalType"></span><span class="target" id="classarrow_1_1_interval_type"></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">IntervalType</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="#_CPPv4N5arrow12TemporalTypeE" title="arrow::TemporalType"><span class="n"><span class="pre">TemporalType</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">ParametricType</span></span><a class="headerlink" href="#_CPPv4N5arrow12IntervalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_day_time_interval_type"><span class="std std-ref">arrow::DayTimeIntervalType</span></a>, <a class="reference internal" href="#classarrow_1_1_month_day_nano_interval_type"><span class="std std-ref">arrow::MonthDayNanoIntervalType</span></a>, <a class="reference internal" href="#classarrow_1_1_month_interval_type"><span class="std std-ref">arrow::MonthIntervalType</span></a></p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17MonthIntervalTypeE"> |
| <span id="_CPPv3N5arrow17MonthIntervalTypeE"></span><span id="_CPPv2N5arrow17MonthIntervalTypeE"></span><span id="arrow::MonthIntervalType"></span><span class="target" id="classarrow_1_1_month_interval_type"></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">MonthIntervalType</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="#_CPPv4N5arrow12IntervalTypeE" title="arrow::IntervalType"><span class="n"><span class="pre">IntervalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17MonthIntervalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Represents a number of months. </p> |
| <p>Type representing a number of months. Corresponds to YearMonth type in Schema.fbs (years are defined as 12 months). </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="_CPPv4NK5arrow17MonthIntervalType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow17MonthIntervalType9bit_widthEv"></span><span id="_CPPv2NK5arrow17MonthIntervalType9bit_widthEv"></span><span id="arrow::MonthIntervalType::bit_widthC"></span><span class="target" id="classarrow_1_1_month_interval_type_1a643ee8ee770657cb42406d088215d095"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow17MonthIntervalType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17MonthIntervalType8ToStringEb"> |
| <span id="_CPPv3NK5arrow17MonthIntervalType8ToStringEb"></span><span id="_CPPv2NK5arrow17MonthIntervalType8ToStringEb"></span><span id="arrow::MonthIntervalType::ToString__bC"></span><span class="target" id="classarrow_1_1_month_interval_type_1aeffc16ca27074804c51c9be74ad54b57"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow17MonthIntervalType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17MonthIntervalType4nameEv"> |
| <span id="_CPPv3NK5arrow17MonthIntervalType4nameEv"></span><span id="_CPPv2NK5arrow17MonthIntervalType4nameEv"></span><span id="arrow::MonthIntervalType::nameC"></span><span class="target" id="classarrow_1_1_month_interval_type_1a49fe7c14ff4077443815fc88709711be"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow17MonthIntervalType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19DayTimeIntervalTypeE"> |
| <span id="_CPPv3N5arrow19DayTimeIntervalTypeE"></span><span id="_CPPv2N5arrow19DayTimeIntervalTypeE"></span><span id="arrow::DayTimeIntervalType"></span><span class="target" id="classarrow_1_1_day_time_interval_type"></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">DayTimeIntervalType</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="#_CPPv4N5arrow12IntervalTypeE" title="arrow::IntervalType"><span class="n"><span class="pre">IntervalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow19DayTimeIntervalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Represents a number of days and milliseconds (fraction of day). </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="_CPPv4NK5arrow19DayTimeIntervalType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow19DayTimeIntervalType9bit_widthEv"></span><span id="_CPPv2NK5arrow19DayTimeIntervalType9bit_widthEv"></span><span id="arrow::DayTimeIntervalType::bit_widthC"></span><span class="target" id="classarrow_1_1_day_time_interval_type_1a158fe8b263f6c2c70ab2c0f4062a5579"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow19DayTimeIntervalType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19DayTimeIntervalType8ToStringEb"> |
| <span id="_CPPv3NK5arrow19DayTimeIntervalType8ToStringEb"></span><span id="_CPPv2NK5arrow19DayTimeIntervalType8ToStringEb"></span><span id="arrow::DayTimeIntervalType::ToString__bC"></span><span class="target" id="classarrow_1_1_day_time_interval_type_1ad99544de1454dd7d43f92ec653885804"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow19DayTimeIntervalType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19DayTimeIntervalType4nameEv"> |
| <span id="_CPPv3NK5arrow19DayTimeIntervalType4nameEv"></span><span id="_CPPv2NK5arrow19DayTimeIntervalType4nameEv"></span><span id="arrow::DayTimeIntervalType::nameC"></span><span class="target" id="classarrow_1_1_day_time_interval_type_1ae49b7efa3b0a38d5d49f581e8688020c"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow19DayTimeIntervalType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19DayTimeIntervalType15DayMillisecondsE"> |
| <span id="_CPPv3N5arrow19DayTimeIntervalType15DayMillisecondsE"></span><span id="_CPPv2N5arrow19DayTimeIntervalType15DayMillisecondsE"></span><span id="arrow::DayTimeIntervalType::DayMilliseconds"></span><span class="target" id="structarrow_1_1_day_time_interval_type_1_1_day_milliseconds"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">DayMilliseconds</span></span></span><a class="headerlink" href="#_CPPv4N5arrow19DayTimeIntervalType15DayMillisecondsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24MonthDayNanoIntervalTypeE"> |
| <span id="_CPPv3N5arrow24MonthDayNanoIntervalTypeE"></span><span id="_CPPv2N5arrow24MonthDayNanoIntervalTypeE"></span><span id="arrow::MonthDayNanoIntervalType"></span><span class="target" id="classarrow_1_1_month_day_nano_interval_type"></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">MonthDayNanoIntervalType</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="#_CPPv4N5arrow12IntervalTypeE" title="arrow::IntervalType"><span class="n"><span class="pre">IntervalType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow24MonthDayNanoIntervalTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Represents a number of months, days and nanoseconds between two dates. </p> |
| <p>All fields are independent from one another. </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="_CPPv4NK5arrow24MonthDayNanoIntervalType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow24MonthDayNanoIntervalType9bit_widthEv"></span><span id="_CPPv2NK5arrow24MonthDayNanoIntervalType9bit_widthEv"></span><span id="arrow::MonthDayNanoIntervalType::bit_widthC"></span><span class="target" id="classarrow_1_1_month_day_nano_interval_type_1a2978f222bfc8f92bf71e1e038c81b3e9"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow24MonthDayNanoIntervalType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow24MonthDayNanoIntervalType8ToStringEb"> |
| <span id="_CPPv3NK5arrow24MonthDayNanoIntervalType8ToStringEb"></span><span id="_CPPv2NK5arrow24MonthDayNanoIntervalType8ToStringEb"></span><span id="arrow::MonthDayNanoIntervalType::ToString__bC"></span><span class="target" id="classarrow_1_1_month_day_nano_interval_type_1ad82958a2f5032b4da4edd6403a11a79b"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow24MonthDayNanoIntervalType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow24MonthDayNanoIntervalType4nameEv"> |
| <span id="_CPPv3NK5arrow24MonthDayNanoIntervalType4nameEv"></span><span id="_CPPv2NK5arrow24MonthDayNanoIntervalType4nameEv"></span><span id="arrow::MonthDayNanoIntervalType::nameC"></span><span class="target" id="classarrow_1_1_month_day_nano_interval_type_1a608c46a9a79ecdc1298a4147fc78e612"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow24MonthDayNanoIntervalType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow24MonthDayNanoIntervalType13MonthDayNanosE"> |
| <span id="_CPPv3N5arrow24MonthDayNanoIntervalType13MonthDayNanosE"></span><span id="_CPPv2N5arrow24MonthDayNanoIntervalType13MonthDayNanosE"></span><span id="arrow::MonthDayNanoIntervalType::MonthDayNanos"></span><span class="target" id="structarrow_1_1_month_day_nano_interval_type_1_1_month_day_nanos"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MonthDayNanos</span></span></span><a class="headerlink" href="#_CPPv4N5arrow24MonthDayNanoIntervalType13MonthDayNanosE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12DurationTypeE"> |
| <span id="_CPPv3N5arrow12DurationTypeE"></span><span id="_CPPv2N5arrow12DurationTypeE"></span><span id="arrow::DurationType"></span><span class="target" id="classarrow_1_1_duration_type"></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">DurationType</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="#_CPPv4N5arrow12TemporalTypeE" title="arrow::TemporalType"><span class="n"><span class="pre">TemporalType</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">ParametricType</span></span><a class="headerlink" href="#_CPPv4N5arrow12DurationTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Represents an elapsed time without any relation to a calendar artifact. </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="_CPPv4NK5arrow12DurationType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow12DurationType9bit_widthEv"></span><span id="_CPPv2NK5arrow12DurationType9bit_widthEv"></span><span id="arrow::DurationType::bit_widthC"></span><span class="target" id="classarrow_1_1_duration_type_1ae8567a04afb5c28693079819c72e905c"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow12DurationType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow12DurationType8ToStringEb"> |
| <span id="_CPPv3NK5arrow12DurationType8ToStringEb"></span><span id="_CPPv2NK5arrow12DurationType8ToStringEb"></span><span id="arrow::DurationType::ToString__bC"></span><span class="target" id="classarrow_1_1_duration_type_1a5c423204eec92c01c8ae0d5f916f3b59"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow12DurationType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow12DurationType4nameEv"> |
| <span id="_CPPv3NK5arrow12DurationType4nameEv"></span><span id="_CPPv2NK5arrow12DurationType4nameEv"></span><span id="arrow::DurationType::nameC"></span><span class="target" id="classarrow_1_1_duration_type_1adc9baa39b3f82f912aa9330ea25c1bd1"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow12DurationType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </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="_CPPv4N5arrow10BinaryTypeE"> |
| <span id="_CPPv3N5arrow10BinaryTypeE"></span><span id="_CPPv2N5arrow10BinaryTypeE"></span><span id="arrow::BinaryType"></span><span class="target" id="classarrow_1_1_binary_type"></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">BinaryType</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">BaseBinaryType</span></span><a class="headerlink" href="#_CPPv4N5arrow10BinaryTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for variable-size binary data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_type"><span class="std std-ref">arrow::StringType</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="_CPPv4NK5arrow10BinaryType6layoutEv"> |
| <span id="_CPPv3NK5arrow10BinaryType6layoutEv"></span><span id="_CPPv2NK5arrow10BinaryType6layoutEv"></span><span id="arrow::BinaryType::layoutC"></span><span class="target" id="classarrow_1_1_binary_type_1a0db59e35b5b3afa44fc15f53ff86235f"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow10BinaryType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10BinaryType8ToStringEb"> |
| <span id="_CPPv3NK5arrow10BinaryType8ToStringEb"></span><span id="_CPPv2NK5arrow10BinaryType8ToStringEb"></span><span id="arrow::BinaryType::ToString__bC"></span><span class="target" id="classarrow_1_1_binary_type_1a33b0eb63c9b042dba4c4260de7703dd4"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10BinaryType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10BinaryType4nameEv"> |
| <span id="_CPPv3NK5arrow10BinaryType4nameEv"></span><span id="_CPPv2NK5arrow10BinaryType4nameEv"></span><span id="arrow::BinaryType::nameC"></span><span class="target" id="classarrow_1_1_binary_type_1a4c345ca9ef34a6099b29c3e694bedae3"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10BinaryType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewTypeE"> |
| <span id="_CPPv3N5arrow14BinaryViewTypeE"></span><span id="_CPPv2N5arrow14BinaryViewTypeE"></span><span id="arrow::BinaryViewType"></span><span class="target" id="classarrow_1_1_binary_view_type"></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">BinaryViewType</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for variable-size binary view data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_string_view_type"><span class="std std-ref">arrow::StringViewType</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="_CPPv4NK5arrow14BinaryViewType6layoutEv"> |
| <span id="_CPPv3NK5arrow14BinaryViewType6layoutEv"></span><span id="_CPPv2NK5arrow14BinaryViewType6layoutEv"></span><span id="arrow::BinaryViewType::layoutC"></span><span class="target" id="classarrow_1_1_binary_view_type_1a3e918b3ccd246afda0ee6ddbf3db1a59"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow14BinaryViewType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14BinaryViewType8ToStringEb"> |
| <span id="_CPPv3NK5arrow14BinaryViewType8ToStringEb"></span><span id="_CPPv2NK5arrow14BinaryViewType8ToStringEb"></span><span id="arrow::BinaryViewType::ToString__bC"></span><span class="target" id="classarrow_1_1_binary_view_type_1a9a79f35d24bf3a5fb2c25e4d0bec3358"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow14BinaryViewType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14BinaryViewType4nameEv"> |
| <span id="_CPPv3NK5arrow14BinaryViewType4nameEv"></span><span id="_CPPv2NK5arrow14BinaryViewType4nameEv"></span><span id="arrow::BinaryViewType::nameC"></span><span class="target" id="classarrow_1_1_binary_view_type_1a3754e29e4a3b5fbf5b396e76672d71f2"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14BinaryViewType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp union"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_typeE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_typeE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_typeE"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type"></span><span class="k"><span class="pre">union</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">c_type</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_typeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Variable length string or binary with inline optimization for small values (12 bytes or fewer). </p> |
| <p>This is similar to std::string_view except limited in size to INT32_MAX and at least the first four bytes of the string are copied inline (accessible without pointer dereference). This inline prefix allows failing comparisons early. Furthermore when dealing with short strings the CPU cache working set is reduced since many can be inline.</p> |
| <p>This union supports two states:</p> |
| <p><ul class="simple"> |
| <li><p>Entirely inlined string data |-&#8212;|———–&#8212;| ^ ^ | | size in-line string data, zero padded</p></li> |
| <li><p>Reference into a buffer |-&#8212;|-&#8212;|-&#8212;|-&#8212;| ^ ^ ^ ^ | | | | size | | `—&#8212;. prefix | | buffer index | offset in buffer</p></li> |
| </ul> |
| </p> |
| <p>Adapted from TU Munich’s UmbraDB <a class="reference external" href="https://db.in.tum.de/~freitag/papers/p29-neumann-cidr20.pdf">1</a>, Velox, DuckDB.</p> |
| <p>Alignment to 64 bits enables an aligned load of the size and prefix into a single 64 bit integer, which is useful to the comparison fast path. </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="_CPPv4NK5arrow14BinaryViewType6c_type4sizeEv"> |
| <span id="_CPPv3NK5arrow14BinaryViewType6c_type4sizeEv"></span><span id="_CPPv2NK5arrow14BinaryViewType6c_type4sizeEv"></span><span id="arrow::BinaryViewType::c_type::sizeC"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a62089ce4aeb3aceddb71bf9fb63afa14"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">size</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><br /></dt> |
| <dd><p>The number of bytes viewed. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14BinaryViewType6c_type9is_inlineEv"> |
| <span id="_CPPv3NK5arrow14BinaryViewType6c_type9is_inlineEv"></span><span id="_CPPv2NK5arrow14BinaryViewType6c_type9is_inlineEv"></span><span id="arrow::BinaryViewType::c_type::is_inlineC"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a5a57b31916fd33b3a89ab7426b4a1f51"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_inline</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="#_CPPv4NK5arrow14BinaryViewType6c_type9is_inlineEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>True if the view’s data is entirely stored inline. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NKR5arrow14BinaryViewType6c_type11inline_dataEv"> |
| <span id="_CPPv3NKR5arrow14BinaryViewType6c_type11inline_dataEv"></span><span id="_CPPv2NKR5arrow14BinaryViewType6c_type11inline_dataEv"></span><span id="arrow::BinaryViewType::c_type::inline_dataCR"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a17de1915cc8d96965ae264069d504b87"></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">inline_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><span class="w"> </span><span class="p"><span class="pre">&</span></span><a class="headerlink" href="#_CPPv4NKR5arrow14BinaryViewType6c_type11inline_dataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a pointer to the inline data of a view. </p> |
| <p>For inline views, this points to the entire data of the view. For other views, this points to the 4 byte prefix. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NO5arrow14BinaryViewType6c_type11inline_dataEv"> |
| <span id="_CPPv3NO5arrow14BinaryViewType6c_type11inline_dataEv"></span><span id="_CPPv2NO5arrow14BinaryViewType6c_type11inline_dataEv"></span><span id="arrow::BinaryViewType::c_type::inline_dataO"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a5b6cbfb0c5b7cc892c31c3f246302a5e"></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">inline_data</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="p"><span class="pre">=</span></span><span class="w"> </span><span class="k"><span class="pre">delete</span></span><a class="headerlink" href="#_CPPv4NO5arrow14BinaryViewType6c_type11inline_dataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type4sizeE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type4sizeE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type4sizeE"></span><span id="arrow::BinaryViewType::c_type::size__int32_t"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a460fe77c60ebf5e371341d13fe1b8262"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">size</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type4sizeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type4dataE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type4dataE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type4dataE"></span><span id="arrow::BinaryViewType::c_type::data__std::array:uint8_t.kInlineSize:"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1ad7020393f7509d6cf936298d03553825"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">array</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="n"><span class="pre">kInlineSize</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">data</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type4dataE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type7inlinedE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type7inlinedE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type7inlinedE"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1ae85b0b2e93f343e8da8ae483943f2de6"></span><span class="k"><span class="pre">struct</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="#_CPPv4N5arrow14BinaryViewTypeE" title="arrow::BinaryViewType"><span class="n"><span class="pre">BinaryViewType</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow14BinaryViewType6c_typeE" title="arrow::BinaryViewType::c_type"><span class="n"><span class="pre">c_type</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">[anonymous]</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">inlined</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type7inlinedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type6prefixE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type6prefixE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type6prefixE"></span><span id="arrow::BinaryViewType::c_type::prefix__std::array:uint8_t.kPrefixSize:"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1ae1b5788dc78aaa67dfeab03874cea775"></span><span class="n"><span class="pre">std</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">array</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="n"><span class="pre">kPrefixSize</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">prefix</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type6prefixE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type12buffer_indexE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type12buffer_indexE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type12buffer_indexE"></span><span id="arrow::BinaryViewType::c_type::buffer_index__int32_t"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a4e5604d1920e631729c6b8b90dda8b6d"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">buffer_index</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type12buffer_indexE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type6offsetE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type6offsetE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type6offsetE"></span><span id="arrow::BinaryViewType::c_type::offset__int32_t"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1a1b6bd61a5209738bbca1b1170a70dc94"></span><span class="n"><span class="pre">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">offset</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type6offsetE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14BinaryViewType6c_type3refE"> |
| <span id="_CPPv3N5arrow14BinaryViewType6c_type3refE"></span><span id="_CPPv2N5arrow14BinaryViewType6c_type3refE"></span><span class="target" id="unionarrow_1_1_binary_view_type_1_1c__type_1ae1c45714cd2b640d38e5dc14b47ce946"></span><span class="k"><span class="pre">struct</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="#_CPPv4N5arrow14BinaryViewTypeE" title="arrow::BinaryViewType"><span class="n"><span class="pre">BinaryViewType</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow14BinaryViewType6c_typeE" title="arrow::BinaryViewType::c_type"><span class="n"><span class="pre">c_type</span></span></a><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">[anonymous]</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ref</span></span></span><a class="headerlink" href="#_CPPv4N5arrow14BinaryViewType6c_type3refE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15LargeBinaryTypeE"> |
| <span id="_CPPv3N5arrow15LargeBinaryTypeE"></span><span id="_CPPv2N5arrow15LargeBinaryTypeE"></span><span id="arrow::LargeBinaryType"></span><span class="target" id="classarrow_1_1_large_binary_type"></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">LargeBinaryType</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">BaseBinaryType</span></span><a class="headerlink" href="#_CPPv4N5arrow15LargeBinaryTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for large variable-size binary data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_large_string_type"><span class="std std-ref">arrow::LargeStringType</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="_CPPv4NK5arrow15LargeBinaryType6layoutEv"> |
| <span id="_CPPv3NK5arrow15LargeBinaryType6layoutEv"></span><span id="_CPPv2NK5arrow15LargeBinaryType6layoutEv"></span><span id="arrow::LargeBinaryType::layoutC"></span><span class="target" id="classarrow_1_1_large_binary_type_1a224295a081273aa84c2e5134f0321997"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow15LargeBinaryType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow15LargeBinaryType8ToStringEb"> |
| <span id="_CPPv3NK5arrow15LargeBinaryType8ToStringEb"></span><span id="_CPPv2NK5arrow15LargeBinaryType8ToStringEb"></span><span id="arrow::LargeBinaryType::ToString__bC"></span><span class="target" id="classarrow_1_1_large_binary_type_1a2f2e7d992504e3c9a441d8ea6906053d"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow15LargeBinaryType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow15LargeBinaryType4nameEv"> |
| <span id="_CPPv3NK5arrow15LargeBinaryType4nameEv"></span><span id="_CPPv2NK5arrow15LargeBinaryType4nameEv"></span><span id="arrow::LargeBinaryType::nameC"></span><span class="target" id="classarrow_1_1_large_binary_type_1a13b91514b5c18c6ad41d84cb92e0c31f"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow15LargeBinaryType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10StringTypeE"> |
| <span id="_CPPv3N5arrow10StringTypeE"></span><span id="_CPPv2N5arrow10StringTypeE"></span><span id="arrow::StringType"></span><span class="target" id="classarrow_1_1_string_type"></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">StringType</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="#_CPPv4N5arrow10BinaryTypeE" title="arrow::BinaryType"><span class="n"><span class="pre">BinaryType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow10StringTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for variable-size string data, utf8-encoded. </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="_CPPv4NK5arrow10StringType8ToStringEb"> |
| <span id="_CPPv3NK5arrow10StringType8ToStringEb"></span><span id="_CPPv2NK5arrow10StringType8ToStringEb"></span><span id="arrow::StringType::ToString__bC"></span><span class="target" id="classarrow_1_1_string_type_1a2244cdeedd34e3ebfdd19289a76021bc"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10StringType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StringType4nameEv"> |
| <span id="_CPPv3NK5arrow10StringType4nameEv"></span><span id="_CPPv2NK5arrow10StringType4nameEv"></span><span id="arrow::StringType::nameC"></span><span class="target" id="classarrow_1_1_string_type_1ac286b24f3c2b3eeaf1e7d897ecd7a8d1"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10StringType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14StringViewTypeE"> |
| <span id="_CPPv3N5arrow14StringViewTypeE"></span><span id="_CPPv2N5arrow14StringViewTypeE"></span><span id="arrow::StringViewType"></span><span class="target" id="classarrow_1_1_string_view_type"></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">StringViewType</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="#_CPPv4N5arrow14BinaryViewTypeE" title="arrow::BinaryViewType"><span class="n"><span class="pre">BinaryViewType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow14StringViewTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for variable-size string data, utf8-encoded. </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="_CPPv4NK5arrow14StringViewType8ToStringEb"> |
| <span id="_CPPv3NK5arrow14StringViewType8ToStringEb"></span><span id="_CPPv2NK5arrow14StringViewType8ToStringEb"></span><span id="arrow::StringViewType::ToString__bC"></span><span class="target" id="classarrow_1_1_string_view_type_1a250cc2c8adde2314c81f8dc5f5c14b12"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow14StringViewType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14StringViewType4nameEv"> |
| <span id="_CPPv3NK5arrow14StringViewType4nameEv"></span><span id="_CPPv2NK5arrow14StringViewType4nameEv"></span><span id="arrow::StringViewType::nameC"></span><span class="target" id="classarrow_1_1_string_view_type_1aafb75ea7f810be07502a9141d8047710"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14StringViewType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15LargeStringTypeE"> |
| <span id="_CPPv3N5arrow15LargeStringTypeE"></span><span id="_CPPv2N5arrow15LargeStringTypeE"></span><span id="arrow::LargeStringType"></span><span class="target" id="classarrow_1_1_large_string_type"></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">LargeStringType</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="#_CPPv4N5arrow15LargeBinaryTypeE" title="arrow::LargeBinaryType"><span class="n"><span class="pre">LargeBinaryType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow15LargeStringTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for large variable-size string data, utf8-encoded. </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="_CPPv4NK5arrow15LargeStringType8ToStringEb"> |
| <span id="_CPPv3NK5arrow15LargeStringType8ToStringEb"></span><span id="_CPPv2NK5arrow15LargeStringType8ToStringEb"></span><span id="arrow::LargeStringType::ToString__bC"></span><span class="target" id="classarrow_1_1_large_string_type_1a30bb3d988c2254b554dca5d3730a5d6b"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow15LargeStringType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow15LargeStringType4nameEv"> |
| <span id="_CPPv3NK5arrow15LargeStringType4nameEv"></span><span id="_CPPv2NK5arrow15LargeStringType4nameEv"></span><span id="arrow::LargeStringType::nameC"></span><span class="target" id="classarrow_1_1_large_string_type_1a07c2864eabf436e15ec944e488f17f6e"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow15LargeStringType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow19FixedSizeBinaryTypeE"> |
| <span id="_CPPv3N5arrow19FixedSizeBinaryTypeE"></span><span id="_CPPv2N5arrow19FixedSizeBinaryTypeE"></span><span id="arrow::FixedSizeBinaryType"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type"></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">FixedSizeBinaryType</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">FixedWidthType</span></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">ParametricType</span></span><a class="headerlink" href="#_CPPv4N5arrow19FixedSizeBinaryTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for fixed-size binary data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_decimal_type"><span class="std std-ref">arrow::DecimalType</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="_CPPv4NK5arrow19FixedSizeBinaryType8ToStringEb"> |
| <span id="_CPPv3NK5arrow19FixedSizeBinaryType8ToStringEb"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType8ToStringEb"></span><span id="arrow::FixedSizeBinaryType::ToString__bC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1ae018946ded02894fe0e5d376bb6fd208"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow19FixedSizeBinaryType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19FixedSizeBinaryType4nameEv"> |
| <span id="_CPPv3NK5arrow19FixedSizeBinaryType4nameEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType4nameEv"></span><span id="arrow::FixedSizeBinaryType::nameC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1af533276c83d45b5cefa826a169bef6c7"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow19FixedSizeBinaryType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19FixedSizeBinaryType6layoutEv"> |
| <span id="_CPPv3NK5arrow19FixedSizeBinaryType6layoutEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType6layoutEv"></span><span id="arrow::FixedSizeBinaryType::layoutC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1a272445981e412ccca95784e133f0a6cc"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow19FixedSizeBinaryType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19FixedSizeBinaryType10byte_widthEv"> |
| <span id="_CPPv3NK5arrow19FixedSizeBinaryType10byte_widthEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType10byte_widthEv"></span><span id="arrow::FixedSizeBinaryType::byte_widthC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1a6f452b6403a6829f7a63cc66d911d94b"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">byte_width</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="#_CPPv4NK5arrow19FixedSizeBinaryType10byte_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed byte width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow19FixedSizeBinaryType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow19FixedSizeBinaryType9bit_widthEv"></span><span id="_CPPv2NK5arrow19FixedSizeBinaryType9bit_widthEv"></span><span id="arrow::FixedSizeBinaryType::bit_widthC"></span><span class="target" id="classarrow_1_1_fixed_size_binary_type_1afc7baa826c87aec4d35172d75974b0e0"></span><span class="k"><span class="pre">virtual</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">bit_width</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="#_CPPv4NK5arrow19FixedSizeBinaryType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</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="_CPPv4N5arrow12BaseListTypeE"> |
| <span id="_CPPv3N5arrow12BaseListTypeE"></span><span id="_CPPv2N5arrow12BaseListTypeE"></span><span id="arrow::BaseListType"></span><span class="target" id="classarrow_1_1_base_list_type"></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">BaseListType</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">NestedType</span></span><a class="headerlink" href="#_CPPv4N5arrow12BaseListTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base class for all variable-size list data types. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_fixed_size_list_type"><span class="std std-ref">arrow::FixedSizeListType</span></a>, <a class="reference internal" href="#classarrow_1_1_large_list_type"><span class="std std-ref">arrow::LargeListType</span></a>, <a class="reference internal" href="#classarrow_1_1_large_list_view_type"><span class="std std-ref">arrow::LargeListViewType</span></a>, <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">arrow::ListType</span></a>, <a class="reference internal" href="#classarrow_1_1_list_view_type"><span class="std std-ref">arrow::ListViewType</span></a></p> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8ListTypeE"> |
| <span id="_CPPv3N5arrow8ListTypeE"></span><span id="_CPPv2N5arrow8ListTypeE"></span><span id="arrow::ListType"></span><span class="target" id="classarrow_1_1_list_type"></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">ListType</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="#_CPPv4N5arrow12BaseListTypeE" title="arrow::BaseListType"><span class="n"><span class="pre">BaseListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow8ListTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for list data. </p> |
| <p>List data is nested data where each value is a variable number of child items. Lists can be recursively nested, for example list(list(int32)). </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_map_type"><span class="std std-ref">arrow::MapType</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="_CPPv4NK5arrow8ListType6layoutEv"> |
| <span id="_CPPv3NK5arrow8ListType6layoutEv"></span><span id="_CPPv2NK5arrow8ListType6layoutEv"></span><span id="arrow::ListType::layoutC"></span><span class="target" id="classarrow_1_1_list_type_1a448fdb34f319e62fbd310997a8ba4c32"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow8ListType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8ListType8ToStringEb"> |
| <span id="_CPPv3NK5arrow8ListType8ToStringEb"></span><span id="_CPPv2NK5arrow8ListType8ToStringEb"></span><span id="arrow::ListType::ToString__bC"></span><span class="target" id="classarrow_1_1_list_type_1a8e7a5cbc4a6f7b597e983395aeb96203"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow8ListType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8ListType4nameEv"> |
| <span id="_CPPv3NK5arrow8ListType4nameEv"></span><span id="_CPPv2NK5arrow8ListType4nameEv"></span><span id="arrow::ListType::nameC"></span><span class="target" id="classarrow_1_1_list_type_1a6320a08c4881865abcac2fdeab4fb0a2"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow8ListType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13LargeListTypeE"> |
| <span id="_CPPv3N5arrow13LargeListTypeE"></span><span id="_CPPv2N5arrow13LargeListTypeE"></span><span id="arrow::LargeListType"></span><span class="target" id="classarrow_1_1_large_list_type"></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">LargeListType</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="#_CPPv4N5arrow12BaseListTypeE" title="arrow::BaseListType"><span class="n"><span class="pre">BaseListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow13LargeListTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for large list data. </p> |
| <p><a class="reference internal" href="#classarrow_1_1_large_list_type"><span class="std std-ref">LargeListType</span></a> is like <a class="reference internal" href="#classarrow_1_1_list_type"><span class="std std-ref">ListType</span></a> but with 64-bit rather than 32-bit offsets. </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="_CPPv4NK5arrow13LargeListType6layoutEv"> |
| <span id="_CPPv3NK5arrow13LargeListType6layoutEv"></span><span id="_CPPv2NK5arrow13LargeListType6layoutEv"></span><span id="arrow::LargeListType::layoutC"></span><span class="target" id="classarrow_1_1_large_list_type_1a56516c286c62a40e51f94281b024cdde"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow13LargeListType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13LargeListType8ToStringEb"> |
| <span id="_CPPv3NK5arrow13LargeListType8ToStringEb"></span><span id="_CPPv2NK5arrow13LargeListType8ToStringEb"></span><span id="arrow::LargeListType::ToString__bC"></span><span class="target" id="classarrow_1_1_large_list_type_1ae1c3bbcaacc41ee130ca1c4e35d6efa6"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow13LargeListType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13LargeListType4nameEv"> |
| <span id="_CPPv3NK5arrow13LargeListType4nameEv"></span><span id="_CPPv2NK5arrow13LargeListType4nameEv"></span><span id="arrow::LargeListType::nameC"></span><span class="target" id="classarrow_1_1_large_list_type_1ac639156265552e6b9372afa525a8af50"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow13LargeListType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow12ListViewTypeE"> |
| <span id="_CPPv3N5arrow12ListViewTypeE"></span><span id="_CPPv2N5arrow12ListViewTypeE"></span><span id="arrow::ListViewType"></span><span class="target" id="classarrow_1_1_list_view_type"></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">ListViewType</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="#_CPPv4N5arrow12BaseListTypeE" title="arrow::BaseListType"><span class="n"><span class="pre">BaseListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow12ListViewTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Type class for array of list views. </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="_CPPv4NK5arrow12ListViewType6layoutEv"> |
| <span id="_CPPv3NK5arrow12ListViewType6layoutEv"></span><span id="_CPPv2NK5arrow12ListViewType6layoutEv"></span><span id="arrow::ListViewType::layoutC"></span><span class="target" id="classarrow_1_1_list_view_type_1ab533449f0ebbfcf7b7ead0ea7cb30e13"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow12ListViewType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow12ListViewType8ToStringEb"> |
| <span id="_CPPv3NK5arrow12ListViewType8ToStringEb"></span><span id="_CPPv2NK5arrow12ListViewType8ToStringEb"></span><span id="arrow::ListViewType::ToString__bC"></span><span class="target" id="classarrow_1_1_list_view_type_1affca751f708f87bcbc3f67bf27686b5f"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow12ListViewType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow12ListViewType4nameEv"> |
| <span id="_CPPv3NK5arrow12ListViewType4nameEv"></span><span id="_CPPv2NK5arrow12ListViewType4nameEv"></span><span id="arrow::ListViewType::nameC"></span><span class="target" id="classarrow_1_1_list_view_type_1a2b91abd865617f600b58c3ed7763aa15"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow12ListViewType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17LargeListViewTypeE"> |
| <span id="_CPPv3N5arrow17LargeListViewTypeE"></span><span id="_CPPv2N5arrow17LargeListViewTypeE"></span><span id="arrow::LargeListViewType"></span><span class="target" id="classarrow_1_1_large_list_view_type"></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">LargeListViewType</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="#_CPPv4N5arrow12BaseListTypeE" title="arrow::BaseListType"><span class="n"><span class="pre">BaseListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17LargeListViewTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for large list-view data. </p> |
| <p><a class="reference internal" href="#classarrow_1_1_large_list_view_type"><span class="std std-ref">LargeListViewType</span></a> is like <a class="reference internal" href="#classarrow_1_1_list_view_type"><span class="std std-ref">ListViewType</span></a> but with 64-bit rather than 32-bit offsets and sizes. </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="_CPPv4NK5arrow17LargeListViewType6layoutEv"> |
| <span id="_CPPv3NK5arrow17LargeListViewType6layoutEv"></span><span id="_CPPv2NK5arrow17LargeListViewType6layoutEv"></span><span id="arrow::LargeListViewType::layoutC"></span><span class="target" id="classarrow_1_1_large_list_view_type_1af8616c7f2c436b027788bf3119540b22"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow17LargeListViewType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17LargeListViewType8ToStringEb"> |
| <span id="_CPPv3NK5arrow17LargeListViewType8ToStringEb"></span><span id="_CPPv2NK5arrow17LargeListViewType8ToStringEb"></span><span id="arrow::LargeListViewType::ToString__bC"></span><span class="target" id="classarrow_1_1_large_list_view_type_1ac476d4a84e22ff46b5fcc63612c5a0b7"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow17LargeListViewType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17LargeListViewType4nameEv"> |
| <span id="_CPPv3NK5arrow17LargeListViewType4nameEv"></span><span id="_CPPv2NK5arrow17LargeListViewType4nameEv"></span><span id="arrow::LargeListViewType::nameC"></span><span class="target" id="classarrow_1_1_large_list_view_type_1a7bdc61c1876fdc8d967f604d8acf977b"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow17LargeListViewType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow7MapTypeE"> |
| <span id="_CPPv3N5arrow7MapTypeE"></span><span id="_CPPv2N5arrow7MapTypeE"></span><span id="arrow::MapType"></span><span class="target" id="classarrow_1_1_map_type"></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">MapType</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="#_CPPv4N5arrow8ListTypeE" title="arrow::ListType"><span class="n"><span class="pre">ListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow7MapTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for map data. </p> |
| <p>Map data is nested data where each value is a variable number of key-item pairs. Its physical representation is the same as a list of <code class="docutils literal notranslate"><span class="pre">{key,</span> <span class="pre">item}</span></code> structs.</p> |
| <p>Maps can be recursively nested, for example map(utf8, map(utf8, int32)). </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="_CPPv4NK5arrow7MapType8ToStringEb"> |
| <span id="_CPPv3NK5arrow7MapType8ToStringEb"></span><span id="_CPPv2NK5arrow7MapType8ToStringEb"></span><span id="arrow::MapType::ToString__bC"></span><span class="target" id="classarrow_1_1_map_type_1ab32be9f24930bf23ea4004d21ea0f924"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow7MapType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow7MapType4nameEv"> |
| <span id="_CPPv3NK5arrow7MapType4nameEv"></span><span id="_CPPv2NK5arrow7MapType4nameEv"></span><span id="arrow::MapType::nameC"></span><span class="target" id="classarrow_1_1_map_type_1aaec81c349f7561f49253006f35735e5e"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow7MapType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17FixedSizeListTypeE"> |
| <span id="_CPPv3N5arrow17FixedSizeListTypeE"></span><span id="_CPPv2N5arrow17FixedSizeListTypeE"></span><span id="arrow::FixedSizeListType"></span><span class="target" id="classarrow_1_1_fixed_size_list_type"></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">FixedSizeListType</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="#_CPPv4N5arrow12BaseListTypeE" title="arrow::BaseListType"><span class="n"><span class="pre">BaseListType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow17FixedSizeListTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for fixed size list data. </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="_CPPv4NK5arrow17FixedSizeListType6layoutEv"> |
| <span id="_CPPv3NK5arrow17FixedSizeListType6layoutEv"></span><span id="_CPPv2NK5arrow17FixedSizeListType6layoutEv"></span><span id="arrow::FixedSizeListType::layoutC"></span><span class="target" id="classarrow_1_1_fixed_size_list_type_1a81e0399d0c9af775bdbc05cd72b4b9a6"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow17FixedSizeListType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17FixedSizeListType8ToStringEb"> |
| <span id="_CPPv3NK5arrow17FixedSizeListType8ToStringEb"></span><span id="_CPPv2NK5arrow17FixedSizeListType8ToStringEb"></span><span id="arrow::FixedSizeListType::ToString__bC"></span><span class="target" id="classarrow_1_1_fixed_size_list_type_1a905bc2b9cc0149fd4bf64726d8f439b7"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow17FixedSizeListType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17FixedSizeListType4nameEv"> |
| <span id="_CPPv3NK5arrow17FixedSizeListType4nameEv"></span><span id="_CPPv2NK5arrow17FixedSizeListType4nameEv"></span><span id="arrow::FixedSizeListType::nameC"></span><span class="target" id="classarrow_1_1_fixed_size_list_type_1aeff3a940628ad39fbf065c8fbb7c00f8"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow17FixedSizeListType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow10StructTypeE"> |
| <span id="_CPPv3N5arrow10StructTypeE"></span><span id="_CPPv2N5arrow10StructTypeE"></span><span id="arrow::StructType"></span><span class="target" id="classarrow_1_1_struct_type"></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">StructType</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">NestedType</span></span><a class="headerlink" href="#_CPPv4N5arrow10StructTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for struct data. </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="_CPPv4NK5arrow10StructType6layoutEv"> |
| <span id="_CPPv3NK5arrow10StructType6layoutEv"></span><span id="_CPPv2NK5arrow10StructType6layoutEv"></span><span id="arrow::StructType::layoutC"></span><span class="target" id="classarrow_1_1_struct_type_1a5c4c6bfa924d21316798b936ec37d18d"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow10StructType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType8ToStringEb"> |
| <span id="_CPPv3NK5arrow10StructType8ToStringEb"></span><span id="_CPPv2NK5arrow10StructType8ToStringEb"></span><span id="arrow::StructType::ToString__bC"></span><span class="target" id="classarrow_1_1_struct_type_1a94f992877392245fd5358637d39b247e"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow10StructType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType4nameEv"> |
| <span id="_CPPv3NK5arrow10StructType4nameEv"></span><span id="_CPPv2NK5arrow10StructType4nameEv"></span><span id="arrow::StructType::nameC"></span><span class="target" id="classarrow_1_1_struct_type_1a5a6f3d58e837712a49e507925e2b40ec"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow10StructType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType14GetFieldByNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow10StructType14GetFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType14GetFieldByNameERKNSt6stringE"></span><span id="arrow::StructType::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a949bf4c4d7333dbb148fa2af3541f066"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">GetFieldByName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType14GetFieldByNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns null if name not found. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE"></span><span id="arrow::StructType::GetAllFieldsByName__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1ab1a30aadb3025bc57424c51ee086ecd8"></span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetAllFieldsByName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType18GetAllFieldsByNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return all fields having this name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType13GetFieldIndexERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow10StructType13GetFieldIndexERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType13GetFieldIndexERKNSt6stringE"></span><span id="arrow::StructType::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a341d4fe0dfc1c693c781de79a178f0e5"></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">GetFieldIndex</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType13GetFieldIndexERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns -1 if name not found or if there are multiple fields having the same name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE"></span><span id="_CPPv2NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE"></span><span id="arrow::StructType::GetAllFieldIndices__ssCRC"></span><span class="target" id="classarrow_1_1_struct_type_1a81d2d1599aba5cd3f2c90e8aae1c9f46"></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">int</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">GetAllFieldIndices</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType18GetAllFieldIndicesERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the indices of all fields having this name in sorted order. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType8AddFieldEiRKNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv3NK5arrow10StructType8AddFieldEiRKNSt10shared_ptrI5FieldEE"></span><span id="_CPPv2NK5arrow10StructType8AddFieldEiRKNSt10shared_ptrI5FieldEE"></span><span id="arrow::StructType::AddField__i.std::shared_ptr:Field:CRC"></span><span class="target" id="classarrow_1_1_struct_type_1a4cac7eefd58f2eb99163ef41fe12e6cc"></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="#_CPPv4N5arrow10StructTypeE" title="arrow::StructType"><span class="n"><span class="pre">StructType</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">AddField</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="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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">field</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType8AddFieldEiRKNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> with field added at given index. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType11RemoveFieldEi"> |
| <span id="_CPPv3NK5arrow10StructType11RemoveFieldEi"></span><span id="_CPPv2NK5arrow10StructType11RemoveFieldEi"></span><span id="arrow::StructType::RemoveField__iC"></span><span class="target" id="classarrow_1_1_struct_type_1a418f2789e6154f10a767479588b99c42"></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="#_CPPv4N5arrow10StructTypeE" title="arrow::StructType"><span class="n"><span class="pre">StructType</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">RemoveField</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType11RemoveFieldEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> by removing the field at given index. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow10StructType8SetFieldEiRKNSt10shared_ptrI5FieldEE"> |
| <span id="_CPPv3NK5arrow10StructType8SetFieldEiRKNSt10shared_ptrI5FieldEE"></span><span id="_CPPv2NK5arrow10StructType8SetFieldEiRKNSt10shared_ptrI5FieldEE"></span><span id="arrow::StructType::SetField__i.std::shared_ptr:Field:CRC"></span><span class="target" id="classarrow_1_1_struct_type_1a6dcb6ea0ea186cef303a2fe20c710099"></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="#_CPPv4N5arrow10StructTypeE" title="arrow::StructType"><span class="n"><span class="pre">StructType</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">SetField</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="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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">field</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow10StructType8SetFieldEiRKNSt10shared_ptrI5FieldEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a new <a class="reference internal" href="#classarrow_1_1_struct_type"><span class="std std-ref">StructType</span></a> by changing the field at given index. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9UnionTypeE"> |
| <span id="_CPPv3N5arrow9UnionTypeE"></span><span id="_CPPv2N5arrow9UnionTypeE"></span><span id="arrow::UnionType"></span><span class="target" id="classarrow_1_1_union_type"></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">UnionType</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">NestedType</span></span><a class="headerlink" href="#_CPPv4N5arrow9UnionTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Base type class for union data. </p> |
| <p>Subclassed by <a class="reference internal" href="#classarrow_1_1_dense_union_type"><span class="std std-ref">arrow::DenseUnionType</span></a>, <a class="reference internal" href="#classarrow_1_1_sparse_union_type"><span class="std std-ref">arrow::SparseUnionType</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="_CPPv4NK5arrow9UnionType6layoutEv"> |
| <span id="_CPPv3NK5arrow9UnionType6layoutEv"></span><span id="_CPPv2NK5arrow9UnionType6layoutEv"></span><span id="arrow::UnionType::layoutC"></span><span class="target" id="classarrow_1_1_union_type_1a3945a3b84db5764ecb0788fbbf21f687"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow9UnionType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9UnionType8ToStringEb"> |
| <span id="_CPPv3NK5arrow9UnionType8ToStringEb"></span><span id="_CPPv2NK5arrow9UnionType8ToStringEb"></span><span id="arrow::UnionType::ToString__bC"></span><span class="target" id="classarrow_1_1_union_type_1af1af3018017d90dab3233608f35c9523"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow9UnionType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9UnionType10type_codesEv"> |
| <span id="_CPPv3NK5arrow9UnionType10type_codesEv"></span><span id="_CPPv2NK5arrow9UnionType10type_codesEv"></span><span id="arrow::UnionType::type_codesC"></span><span class="target" id="classarrow_1_1_union_type_1aa4e646e01306320a36650634e2a5001c"></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">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">int8_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="sig-name descname"><span class="n"><span class="pre">type_codes</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="#_CPPv4NK5arrow9UnionType10type_codesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The array of logical type ids. </p> |
| <p>For example, the first type in the union might be denoted by the id 5 (instead of 0). </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9UnionType9child_idsEv"> |
| <span id="_CPPv3NK5arrow9UnionType9child_idsEv"></span><span id="_CPPv2NK5arrow9UnionType9child_idsEv"></span><span id="arrow::UnionType::child_idsC"></span><span class="target" id="classarrow_1_1_union_type_1a625f4d3ce632e9bc79dd58999b5e4c5a"></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">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">int</span></span><span class="p"><span class="pre">></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">child_ids</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="#_CPPv4NK5arrow9UnionType9child_idsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>An array mapping logical type ids to physical child ids. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow15SparseUnionTypeE"> |
| <span id="_CPPv3N5arrow15SparseUnionTypeE"></span><span id="_CPPv2N5arrow15SparseUnionTypeE"></span><span id="arrow::SparseUnionType"></span><span class="target" id="classarrow_1_1_sparse_union_type"></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">SparseUnionType</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="#_CPPv4N5arrow9UnionTypeE" title="arrow::UnionType"><span class="n"><span class="pre">UnionType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow15SparseUnionTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for sparse union data. </p> |
| <p>A sparse union is a nested type where each logical value is taken from a single child. A buffer of 8-bit type ids indicates which child a given logical value is to be taken from.</p> |
| <p>In a sparse union, each child array should have the same length as the union array, regardless of the actual number of union values that refer to it.</p> |
| <p>Note that, unlike most other types, unions don’t have a top-level validity bitmap. </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="_CPPv4NK5arrow15SparseUnionType4nameEv"> |
| <span id="_CPPv3NK5arrow15SparseUnionType4nameEv"></span><span id="_CPPv2NK5arrow15SparseUnionType4nameEv"></span><span id="arrow::SparseUnionType::nameC"></span><span class="target" id="classarrow_1_1_sparse_union_type_1a99cd3c77ca89c2ec55991f724ac74173"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow15SparseUnionType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow14DenseUnionTypeE"> |
| <span id="_CPPv3N5arrow14DenseUnionTypeE"></span><span id="_CPPv2N5arrow14DenseUnionTypeE"></span><span id="arrow::DenseUnionType"></span><span class="target" id="classarrow_1_1_dense_union_type"></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">DenseUnionType</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="#_CPPv4N5arrow9UnionTypeE" title="arrow::UnionType"><span class="n"><span class="pre">UnionType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow14DenseUnionTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Concrete type class for dense union data. </p> |
| <p>A dense union is a nested type where each logical value is taken from a single child, at a specific offset. A buffer of 8-bit type ids indicates which child a given logical value is to be taken from, and a buffer of 32-bit offsets indicates at which physical position in the given child array the logical value is to be taken from.</p> |
| <p>Unlike a sparse union, a dense union allows encoding only the child array values which are actually referred to by the union array. This is counterbalanced by the additional footprint of the offsets buffer, and the additional indirection cost when looking up values.</p> |
| <p>Note that, unlike most other types, unions don’t have a top-level validity bitmap. </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="_CPPv4NK5arrow14DenseUnionType4nameEv"> |
| <span id="_CPPv3NK5arrow14DenseUnionType4nameEv"></span><span id="_CPPv2NK5arrow14DenseUnionType4nameEv"></span><span id="arrow::DenseUnionType::nameC"></span><span class="target" id="classarrow_1_1_dense_union_type_1a362e145691ce8db9fb5a7b4531f2e959"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14DenseUnionType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow17RunEndEncodedTypeE"> |
| <span id="_CPPv3N5arrow17RunEndEncodedTypeE"></span><span id="_CPPv2N5arrow17RunEndEncodedTypeE"></span><span id="arrow::RunEndEncodedType"></span><span class="target" id="classarrow_1_1_run_end_encoded_type"></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">RunEndEncodedType</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">NestedType</span></span><a class="headerlink" href="#_CPPv4N5arrow17RunEndEncodedTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><div class="docutils container"> |
| <em>#include <arrow/type.h></em></div> |
| <p>Type class for run-end encoded data. </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="_CPPv4NK5arrow17RunEndEncodedType6layoutEv"> |
| <span id="_CPPv3NK5arrow17RunEndEncodedType6layoutEv"></span><span id="_CPPv2NK5arrow17RunEndEncodedType6layoutEv"></span><span id="arrow::RunEndEncodedType::layoutC"></span><span class="target" id="classarrow_1_1_run_end_encoded_type_1aa3b60a4d8eac056d718f3567cfb22abd"></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">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow17RunEndEncodedType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17RunEndEncodedType8ToStringEb"> |
| <span id="_CPPv3NK5arrow17RunEndEncodedType8ToStringEb"></span><span id="_CPPv2NK5arrow17RunEndEncodedType8ToStringEb"></span><span id="arrow::RunEndEncodedType::ToString__bC"></span><span class="target" id="classarrow_1_1_run_end_encoded_type_1aefabf27a68462bce8866fa5067786840"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow17RunEndEncodedType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow17RunEndEncodedType4nameEv"> |
| <span id="_CPPv3NK5arrow17RunEndEncodedType4nameEv"></span><span id="_CPPv2NK5arrow17RunEndEncodedType4nameEv"></span><span id="arrow::RunEndEncodedType::nameC"></span><span class="target" id="classarrow_1_1_run_end_encoded_type_1aa6235fb3140335bf02fe20ba4ca01dc9"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow17RunEndEncodedType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </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="_CPPv4N5arrow14DictionaryTypeE"> |
| <span id="_CPPv3N5arrow14DictionaryTypeE"></span><span id="_CPPv2N5arrow14DictionaryTypeE"></span><span id="arrow::DictionaryType"></span><span class="target" id="classarrow_1_1_dictionary_type"></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">DictionaryType</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">FixedWidthType</span></span><a class="headerlink" href="#_CPPv4N5arrow14DictionaryTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Dictionary-encoded value type with data-dependent dictionary. </p> |
| <p>Indices are represented by any integer 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="_CPPv4NK5arrow14DictionaryType8ToStringEb"> |
| <span id="_CPPv3NK5arrow14DictionaryType8ToStringEb"></span><span id="_CPPv2NK5arrow14DictionaryType8ToStringEb"></span><span id="arrow::DictionaryType::ToString__bC"></span><span class="target" id="classarrow_1_1_dictionary_type_1a358dcb802b46260b3406fd29a0d2c935"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow14DictionaryType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14DictionaryType4nameEv"> |
| <span id="_CPPv3NK5arrow14DictionaryType4nameEv"></span><span id="_CPPv2NK5arrow14DictionaryType4nameEv"></span><span id="arrow::DictionaryType::nameC"></span><span class="target" id="classarrow_1_1_dictionary_type_1a1423be356f4e0c7d28f2c52881decbed"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow14DictionaryType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14DictionaryType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow14DictionaryType9bit_widthEv"></span><span id="_CPPv2NK5arrow14DictionaryType9bit_widthEv"></span><span id="arrow::DictionaryType::bit_widthC"></span><span class="target" id="classarrow_1_1_dictionary_type_1accb4af38ab64de7307a366fccd3808f8"></span><span class="k"><span class="pre">virtual</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">bit_width</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="#_CPPv4NK5arrow14DictionaryType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow14DictionaryType6layoutEv"> |
| <span id="_CPPv3NK5arrow14DictionaryType6layoutEv"></span><span id="_CPPv2NK5arrow14DictionaryType6layoutEv"></span><span id="arrow::DictionaryType::layoutC"></span><span class="target" id="classarrow_1_1_dictionary_type_1a28bbcdcb527d9c93e0cb842f4bf93bd1"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow14DictionaryType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| <section id="extension-types"> |
| <h3>Extension types<a class="headerlink" href="#extension-types" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13ExtensionTypeE"> |
| <span id="_CPPv3N5arrow13ExtensionTypeE"></span><span id="_CPPv2N5arrow13ExtensionTypeE"></span><span id="arrow::ExtensionType"></span><span class="target" id="classarrow_1_1_extension_type"></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">ExtensionType</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><a class="headerlink" href="#_CPPv4N5arrow13ExtensionTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The base class for custom / user-defined types. </p> |
| <p>Subclassed by arrow::extension::FixedShapeTensorType</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="_CPPv4NK5arrow13ExtensionType12storage_typeEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType12storage_typeEv"></span><span id="_CPPv2NK5arrow13ExtensionType12storage_typeEv"></span><span id="arrow::ExtensionType::storage_typeC"></span><span class="target" id="classarrow_1_1_extension_type_1a4add4cc488761c621087ce37bf916897"></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">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="#_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="sig-name descname"><span class="n"><span class="pre">storage_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><a class="headerlink" href="#_CPPv4NK5arrow13ExtensionType12storage_typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The type of array used to represent this extension type’s data. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType10storage_idEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType10storage_idEv"></span><span id="_CPPv2NK5arrow13ExtensionType10storage_idEv"></span><span id="arrow::ExtensionType::storage_idC"></span><span class="target" id="classarrow_1_1_extension_type_1aca9dc1d8e1425cc665d31d10690b2dfd"></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">Type</span></span><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow4Type4typeE" title="arrow::Type::type"><span class="n"><span class="pre">type</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">storage_id</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="#_CPPv4NK5arrow13ExtensionType10storage_idEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the type category of the storage type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType6layoutEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType6layoutEv"></span><span id="_CPPv2NK5arrow13ExtensionType6layoutEv"></span><span id="arrow::ExtensionType::layoutC"></span><span class="target" id="classarrow_1_1_extension_type_1a467c12cd7f9ee1bdbee822a311c7f2c6"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="n"><span class="pre">DataTypeLayout</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">layout</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="#_CPPv4NK5arrow13ExtensionType6layoutEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the data type layout. </p> |
| <p>Children are not included.</p> |
| <div class="admonition note"> |
| <p class="admonition-title">Note</p> |
| <p>Experimental API </p> |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType8ToStringEb"> |
| <span id="_CPPv3NK5arrow13ExtensionType8ToStringEb"></span><span id="_CPPv2NK5arrow13ExtensionType8ToStringEb"></span><span id="arrow::ExtensionType::ToString__bC"></span><span class="target" id="classarrow_1_1_extension_type_1aef7f5662756572b3998c1cba917c1463"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><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="#_CPPv4NK5arrow13ExtensionType8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string representation of the type, including any children. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType4nameEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType4nameEv"></span><span id="_CPPv2NK5arrow13ExtensionType4nameEv"></span><span id="arrow::ExtensionType::nameC"></span><span class="target" id="classarrow_1_1_extension_type_1a7db26a19117968f84d607a31b0f49322"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow13ExtensionType4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A string name of the type, omitting any child fields. </p> |
| <p><dl class="simple"> |
| <dt><strong>Since</strong></dt><dd><p>0.7.0 </p> |
| </dd> |
| </dl> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType10byte_widthEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType10byte_widthEv"></span><span id="_CPPv2NK5arrow13ExtensionType10byte_widthEv"></span><span id="arrow::ExtensionType::byte_widthC"></span><span class="target" id="classarrow_1_1_extension_type_1aa46a5251840a4aa3d1ff96d37de7dff6"></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">int32_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">byte_width</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="#_CPPv4NK5arrow13ExtensionType10byte_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed byte width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType9bit_widthEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType9bit_widthEv"></span><span id="_CPPv2NK5arrow13ExtensionType9bit_widthEv"></span><span id="arrow::ExtensionType::bit_widthC"></span><span class="target" id="classarrow_1_1_extension_type_1aff61ee16098ef246323557a6cac6032e"></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">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">bit_width</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="#_CPPv4NK5arrow13ExtensionType9bit_widthEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns the type’s fixed bit width, if any. </p> |
| <p>Returns -1 for non-fixed-width types, and should only be used for subclasses of FixedWidthType</p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType14extension_nameEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType14extension_nameEv"></span><span id="_CPPv2NK5arrow13ExtensionType14extension_nameEv"></span><span id="arrow::ExtensionType::extension_nameC"></span><span class="target" id="classarrow_1_1_extension_type_1ad9916ec6eff760b2e7ea27a0447280b2"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">extension_name</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="#_CPPv4NK5arrow13ExtensionType14extension_nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unique name of extension type used to identify type for serialization. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>the string name of the extension </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType15ExtensionEqualsERK13ExtensionType"> |
| <span id="_CPPv3NK5arrow13ExtensionType15ExtensionEqualsERK13ExtensionType"></span><span id="_CPPv2NK5arrow13ExtensionType15ExtensionEqualsERK13ExtensionType"></span><span id="arrow::ExtensionType::ExtensionEquals__ExtensionTypeCRC"></span><span class="target" id="classarrow_1_1_extension_type_1a69e984708e321511b6ead98555926a54"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">ExtensionEquals</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="#_CPPv4N5arrow13ExtensionTypeE" title="arrow::ExtensionType"><span class="n"><span class="pre">ExtensionType</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></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="#_CPPv4NK5arrow13ExtensionType15ExtensionEqualsERK13ExtensionType" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Determine if two instances of the same extension types are equal. </p> |
| <p>Invoked from <a class="reference internal" href="#classarrow_1_1_data_type_1aaf003113bb8f4c51a03a16f4b27a52bb"><span class="std std-ref">ExtensionType::Equals</span></a> </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>other</strong> – <strong>[in]</strong> the type to compare this type with </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>bool true if type instances are equal </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType9MakeArrayENSt10shared_ptrI9ArrayDataEE"> |
| <span id="_CPPv3NK5arrow13ExtensionType9MakeArrayENSt10shared_ptrI9ArrayDataEE"></span><span id="_CPPv2NK5arrow13ExtensionType9MakeArrayENSt10shared_ptrI9ArrayDataEE"></span><span id="arrow::ExtensionType::MakeArray__std::shared_ptr:ArrayData:C"></span><span class="target" id="classarrow_1_1_extension_type_1a57dda0a9013da282fad40e8480fbbd05"></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="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="sig-name descname"><span class="n"><span class="pre">MakeArray</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="n sig-param"><span class="pre">data</span></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="#_CPPv4NK5arrow13ExtensionType9MakeArrayENSt10shared_ptrI9ArrayDataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Wrap built-in <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> type in a user-defined <a class="reference internal" href="array.html#classarrow_1_1_extension_array"><span class="std std-ref">ExtensionArray</span></a> instance. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>data</strong> – <strong>[in]</strong> the physical storage for the extension type </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType11DeserializeENSt10shared_ptrI8DataTypeEERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow13ExtensionType11DeserializeENSt10shared_ptrI8DataTypeEERKNSt6stringE"></span><span id="_CPPv2NK5arrow13ExtensionType11DeserializeENSt10shared_ptrI8DataTypeEERKNSt6stringE"></span><span id="arrow::ExtensionType::Deserialize__std::shared_ptr:DataType:.ssCRC"></span><span class="target" id="classarrow_1_1_extension_type_1ab30f3ba683a121093598f67581eda893"></span><span class="k"><span class="pre">virtual</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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</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">Deserialize</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="#_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="n sig-param"><span class="pre">storage_type</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">serialized_data</span></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="#_CPPv4NK5arrow13ExtensionType11DeserializeENSt10shared_ptrI8DataTypeEERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create an instance of the <a class="reference internal" href="#classarrow_1_1_extension_type"><span class="std std-ref">ExtensionType</span></a> given the actual storage type and the serialized representation. </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>storage_type</strong> – <strong>[in]</strong> the physical storage type of the extension </p></li> |
| <li><p><strong>serialized_data</strong> – <strong>[in]</strong> the serialized representation produced by Serialize </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow13ExtensionType9SerializeEv"> |
| <span id="_CPPv3NK5arrow13ExtensionType9SerializeEv"></span><span id="_CPPv2NK5arrow13ExtensionType9SerializeEv"></span><span id="arrow::ExtensionType::SerializeC"></span><span class="target" id="classarrow_1_1_extension_type_1ad8d5ca0bb4338a8c5bd54cbb1e5b9041"></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">string</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Serialize</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="#_CPPv4NK5arrow13ExtensionType9SerializeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a serialized representation of the extension type’s metadata. </p> |
| <p>The storage type will be handled automatically in IPC code paths </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>the serialized representation </p> |
| </dd> |
| </dl> |
| </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="_CPPv4N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEE"> |
| <span id="_CPPv3N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEE"></span><span id="_CPPv2N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEE"></span><span id="arrow::ExtensionType::WrapArray__std::shared_ptr:DataType:CR.std::shared_ptr:Array:CR"></span><span class="target" id="classarrow_1_1_extension_type_1aa2b1e308af77b71ba693f3b812a79c48"></span><span class="k"><span class="pre">static</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="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="sig-name descname"><span class="n"><span class="pre">WrapArray</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="#_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">ext_type</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="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">storage</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI5ArrayEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Wrap the given storage array as an extension array. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI12ChunkedArrayEE"> |
| <span id="_CPPv3N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI12ChunkedArrayEE"></span><span id="_CPPv2N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI12ChunkedArrayEE"></span><span id="arrow::ExtensionType::WrapArray__std::shared_ptr:DataType:CR.std::shared_ptr:ChunkedArray:CR"></span><span class="target" id="classarrow_1_1_extension_type_1a802157f854118b412d638f93e229cc36"></span><span class="k"><span class="pre">static</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="array.html#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">WrapArray</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="#_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">ext_type</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="array.html#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">storage</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow13ExtensionType9WrapArrayERKNSt10shared_ptrI8DataTypeEERKNSt10shared_ptrI12ChunkedArrayEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Wrap the given chunked storage array as a chunked extension array. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| </section> |
| <section id="fields-and-schemas"> |
| <h2>Fields and Schemas<a class="headerlink" href="#fields-and-schemas" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45fieldNSt6stringENSt10shared_ptrI8DataTypeEEbNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv35fieldNSt6stringENSt10shared_ptrI8DataTypeEEbNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv25fieldNSt6stringENSt10shared_ptrI8DataTypeEEbNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="field__ss.std::shared_ptr:DataType:.b.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1gaf9f57798b5abe44d560a52887f28894c"></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><span class="n"><span class="pre">Field</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">field</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">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">name</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">nullable</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="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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</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="#_CPPv45fieldNSt6stringENSt10shared_ptrI8DataTypeEEbNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> instance. </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>name</strong> – the field name </p></li> |
| <li><p><strong>type</strong> – the field value type </p></li> |
| <li><p><strong>nullable</strong> – whether the values are nullable, default true </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata, default null </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv45fieldNSt6stringENSt10shared_ptrI8DataTypeEENSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv35fieldNSt6stringENSt10shared_ptrI8DataTypeEENSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv25fieldNSt6stringENSt10shared_ptrI8DataTypeEENSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="field__ss.std::shared_ptr:DataType:.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1ga55d537d79ff8445ca6ffc76a7b20c3ad"></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><span class="n"><span class="pre">Field</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">field</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">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">name</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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">type</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv45fieldNSt6stringENSt10shared_ptrI8DataTypeEENSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> instance with metadata. </p> |
| <p>The field will be assumed to be nullable.</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>name</strong> – the field name </p></li> |
| <li><p><strong>type</strong> – the field value type </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata </p></li> |
| </ul> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46schema11FieldVectorNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv36schema11FieldVectorNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv26schema11FieldVectorNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="schema__FieldVector.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1ga7d564227b5d236a6070e1e3c6575fcbe"></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><span class="n"><span class="pre">Schema</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">schema</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">fields</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</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="#_CPPv46schema11FieldVectorNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance. </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>fields</strong> – the schema’s fields </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata, default null </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>schema shared_ptr to <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEENSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv36schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEENSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv26schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEENSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="schema__std::initializer_list:std::pair:ss.std::shared_ptr:DataType:::.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1ga0c49659b1646bc32cfcb4d2a37ad1516"></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><span class="n"><span class="pre">Schema</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">schema</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">initializer_list</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">pair</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="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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><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">fields</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</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="#_CPPv46schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEENSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance from (name, type) pairs. </p> |
| <p>The schema’s fields will all be nullable with no associated metadata.</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>fields</strong> – (name, type) pairs of the schema’s fields </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata, default null </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>schema shared_ptr to <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46schema11FieldVector10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv36schema11FieldVector10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv26schema11FieldVector10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="schema__FieldVector.Endianness.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1ga5986456450799cdff66d84bd30f0a146"></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><span class="n"><span class="pre">Schema</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">schema</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">fields</span></span>, <span class="n"><span class="pre">Endianness</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">endianness</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</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="#_CPPv46schema11FieldVector10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance. </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>fields</strong> – the schema’s fields </p></li> |
| <li><p><strong>endianness</strong> – the endianness of the data </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata, default null </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>schema shared_ptr to <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv46schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv36schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv26schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="schema__std::initializer_list:std::pair:ss.std::shared_ptr:DataType:::.Endianness.std::shared_ptr:KeyValueMetadataC:"></span><span class="target" id="group__schema-factories_1ga573a01e8066cb6e846339f34aaab3f1a"></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><span class="n"><span class="pre">Schema</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">schema</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">initializer_list</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">pair</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="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><span class="n"><span class="pre">DataType</span></span><span class="p"><span class="pre">></span></span><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">fields</span></span>, <span class="n"><span class="pre">Endianness</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">endianness</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="n"><span class="pre">KeyValueMetadata</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">metadata</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="#_CPPv46schemaNSt16initializer_listINSt4pairINSt6stringENSt10shared_ptrI8DataTypeEEEEEE10EndiannessNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Create a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> instance. </p> |
| <p>The schema’s fields will all be nullable with no associated metadata.</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>fields</strong> – (name, type) pairs of the schema’s fields </p></li> |
| <li><p><strong>endianness</strong> – the endianness of the data </p></li> |
| <li><p><strong>metadata</strong> – any custom key-value metadata, default null </p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>schema shared_ptr to <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5FieldE"> |
| <span id="_CPPv3N5arrow5FieldE"></span><span id="_CPPv2N5arrow5FieldE"></span><span id="arrow::Field"></span><span class="target" id="classarrow_1_1_field"></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">Field</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Fingerprintable</span></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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">EqualityComparable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow5FieldE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The combination of a field name and data type, with optional metadata. </p> |
| <p>Fields are used to describe the individual constituents of a nested <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> or a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a>.</p> |
| <p>A field’s metadata is represented by a <a class="reference internal" href="#classarrow_1_1_key_value_metadata"><span class="std std-ref">KeyValueMetadata</span></a> instance, which holds arbitrary key-value pairs. </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="_CPPv4NK5arrow5Field8metadataEv"> |
| <span id="_CPPv3NK5arrow5Field8metadataEv"></span><span id="_CPPv2NK5arrow5Field8metadataEv"></span><span id="arrow::Field::metadataC"></span><span class="target" id="classarrow_1_1_field_1a899a4cef4c13946c9996095ca53e8004"></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><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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">metadata</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="#_CPPv4NK5arrow5Field8metadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the field’s attached metadata. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field11HasMetadataEv"> |
| <span id="_CPPv3NK5arrow5Field11HasMetadataEv"></span><span id="_CPPv2NK5arrow5Field11HasMetadataEv"></span><span id="arrow::Field::HasMetadataC"></span><span class="target" id="classarrow_1_1_field_1ade70dc0d9c4965246815e481a7c2fd42"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasMetadata</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="#_CPPv4NK5arrow5Field11HasMetadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return whether the field has non-empty metadata. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv3NK5arrow5Field12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2NK5arrow5Field12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Field::WithMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_field_1ab7fc8e454854a5c64072b5ea1ae86605"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">WithMetadata</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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">metadata</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a copy of this field with the given metadata attached to it. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field18WithMergedMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv3NK5arrow5Field18WithMergedMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2NK5arrow5Field18WithMergedMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Field::WithMergedMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_field_1ae72d1b6ea8287013695dabb51fdcf8bd"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">WithMergedMetadata</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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">metadata</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field18WithMergedMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>EXPERIMENTAL: Return a copy of this field with the given metadata merged with existing metadata (any colliding keys will be overridden by the passed metadata) </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field14RemoveMetadataEv"> |
| <span id="_CPPv3NK5arrow5Field14RemoveMetadataEv"></span><span id="_CPPv2NK5arrow5Field14RemoveMetadataEv"></span><span id="arrow::Field::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_field_1ac253b45e669f8b756fb9c15fd26e9dbe"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">RemoveMetadata</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="#_CPPv4NK5arrow5Field14RemoveMetadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a copy of this field without any metadata attached to it. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE"> |
| <span id="_CPPv3NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE"></span><span id="_CPPv2NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE"></span><span id="arrow::Field::WithType__std::shared_ptr:DataType:CRC"></span><span class="target" id="classarrow_1_1_field_1af0578d97e24865ac8f4e318b26f7803f"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">WithType</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="#_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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field8WithTypeERKNSt10shared_ptrI8DataTypeEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a copy of this field with the replaced type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field8WithNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow5Field8WithNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow5Field8WithNameERKNSt6stringE"></span><span id="arrow::Field::WithName__ssCRC"></span><span class="target" id="classarrow_1_1_field_1a9633a02bfd6785ca0f37b5218b11e781"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">WithName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field8WithNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a copy of this field with the replaced name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field12WithNullableEb"> |
| <span id="_CPPv3NK5arrow5Field12WithNullableEb"></span><span id="_CPPv2NK5arrow5Field12WithNullableEb"></span><span id="arrow::Field::WithNullable__bC"></span><span class="target" id="classarrow_1_1_field_1a471b6b5607da4084a778c53751cb5022"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">WithNullable</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">nullable</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field12WithNullableEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a copy of this field with the replaced nullability. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field9MergeWithERK5Field12MergeOptions"> |
| <span id="_CPPv3NK5arrow5Field9MergeWithERK5Field12MergeOptions"></span><span id="_CPPv2NK5arrow5Field9MergeWithERK5Field12MergeOptions"></span><span id="arrow::Field::MergeWith__FieldCR.MergeOptionsC"></span><span class="target" id="classarrow_1_1_field_1a26145ec8fdd30efa57d319592c55a17f"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">MergeWith</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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span>, <a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="arrow::Field::MergeOptions"><span class="n"><span class="pre">MergeOptions</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">options</span></span><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="arrow::Field::MergeOptions"><span class="n"><span class="pre">MergeOptions</span></span></a><span class="p"><span class="pre">::</span></span><a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptions8DefaultsEv" title="arrow::Field::MergeOptions::Defaults"><span class="n"><span class="pre">Defaults</span></span></a><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field9MergeWithERK5Field12MergeOptions" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Merge the current field with a field of the same name. </p> |
| <p>The two fields must be compatible, i.e:<ul class="simple"> |
| <li><p>have the same name</p></li> |
| <li><p>have the same type, or of compatible types according to <code class="docutils literal notranslate"><span class="pre">options</span></code>.</p></li> |
| </ul> |
| </p> |
| <p>The metadata of the current field is preserved; the metadata of the other field is discarded. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field6EqualsERK5Fieldb"> |
| <span id="_CPPv3NK5arrow5Field6EqualsERK5Fieldb"></span><span id="_CPPv2NK5arrow5Field6EqualsERK5Fieldb"></span><span id="arrow::Field::Equals__FieldCR.bC"></span><span class="target" id="classarrow_1_1_field_1a99743c7ebd2683c48b487a3eec75baca"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">check_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field6EqualsERK5Fieldb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate if fields are equals. </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>other</strong> – <strong>[in]</strong> field to check equality with. </p></li> |
| <li><p><strong>check_metadata</strong> – <strong>[in]</strong> controls if it should check for metadata equality.</p></li> |
| </ul> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>true if fields are equal, false otherwise. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field16IsCompatibleWithERK5Field"> |
| <span id="_CPPv3NK5arrow5Field16IsCompatibleWithERK5Field"></span><span id="_CPPv2NK5arrow5Field16IsCompatibleWithERK5Field"></span><span id="arrow::Field::IsCompatibleWith__FieldCRC"></span><span class="target" id="classarrow_1_1_field_1aadb65ca72abc38a8ced47604d36409b2"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsCompatibleWith</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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field16IsCompatibleWithERK5Field" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate if fields are compatibles. </p> |
| <p>See the criteria of MergeWith.</p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>true if fields are compatible, false otherwise. </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field8ToStringEb"> |
| <span id="_CPPv3NK5arrow5Field8ToStringEb"></span><span id="_CPPv2NK5arrow5Field8ToStringEb"></span><span id="arrow::Field::ToString__bC"></span><span class="target" id="classarrow_1_1_field_1aea6fda3e5e4566631a17e4dd30c5270a"></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="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow5Field8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return a string representation ot the field. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>show_metadata</strong> – <strong>[in]</strong> when true, if <a class="reference internal" href="#classarrow_1_1_key_value_metadata"><span class="std std-ref">KeyValueMetadata</span></a> is non-empty, print keys and values in the output </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field4nameEv"> |
| <span id="_CPPv3NK5arrow5Field4nameEv"></span><span id="_CPPv2NK5arrow5Field4nameEv"></span><span id="arrow::Field::nameC"></span><span class="target" id="classarrow_1_1_field_1ab023b8e5c6d7deff0af5fc757ecaca89"></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">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="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow5Field4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the field name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field4typeEv"> |
| <span id="_CPPv3NK5arrow5Field4typeEv"></span><span id="_CPPv2NK5arrow5Field4typeEv"></span><span id="arrow::Field::typeC"></span><span class="target" id="classarrow_1_1_field_1a26a4dfeb0bf5daaeefabfaba4c9084c5"></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">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="#_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="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><a class="headerlink" href="#_CPPv4NK5arrow5Field4typeEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the field data type. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow5Field8nullableEv"> |
| <span id="_CPPv3NK5arrow5Field8nullableEv"></span><span id="_CPPv2NK5arrow5Field8nullableEv"></span><span id="arrow::Field::nullableC"></span><span class="target" id="classarrow_1_1_field_1aba2045f76a42fe34fd785190af139c25"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">nullable</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="#_CPPv4NK5arrow5Field8nullableEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return whether the field is nullable. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptionsE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptionsE"></span><span id="_CPPv2N5arrow5Field12MergeOptionsE"></span><span id="arrow::Field::MergeOptions"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">MergeOptions</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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ToStringOstreamable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="arrow::Field::MergeOptions"><span class="n"><span class="pre">MergeOptions</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Options that control the behavior of <code class="docutils literal notranslate"><span class="pre">MergeWith</span></code>. </p> |
| <p>Options are to be added to allow type conversions, including integer widening, promotion from integer to float, or conversion to or from boolean. </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="_CPPv4NK5arrow5Field12MergeOptions8ToStringEv"> |
| <span id="_CPPv3NK5arrow5Field12MergeOptions8ToStringEv"></span><span id="_CPPv2NK5arrow5Field12MergeOptions8ToStringEv"></span><span id="arrow::Field::MergeOptions::ToStringC"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a6b1b378aecbdc17c9cd8a29257b19c17"></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="sig-name descname"><span class="n"><span class="pre">ToString</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="#_CPPv4NK5arrow5Field12MergeOptions8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get a human-readable representation of the options. </p> |
| </dd></dl> |
| |
| </div> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-members">Public Members</p> |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions19promote_nullabilityE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions19promote_nullabilityE"></span><span id="_CPPv2N5arrow5Field12MergeOptions19promote_nullabilityE"></span><span id="arrow::Field::MergeOptions::promote_nullability__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a1c451493980992af6a9b0990ad1d7ef6"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_nullability</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">true</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions19promote_nullabilityE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>If true, a <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> of <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">NullType</span></a> can be unified with a <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> of another type. </p> |
| <p>The unified field will be of the other type and become nullable. Nullability will be promoted to the looser option (nullable if one is not nullable). </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions15promote_decimalE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions15promote_decimalE"></span><span id="_CPPv2N5arrow5Field12MergeOptions15promote_decimalE"></span><span id="arrow::Field::MergeOptions::promote_decimal__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a9f9804368f647b1d1cf53ae2b641622e"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_decimal</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions15promote_decimalE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow a decimal to be unified with another decimal of the same width, adjusting scale and precision as appropriate. </p> |
| <p>May fail if the adjustment is not possible. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions24promote_decimal_to_floatE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions24promote_decimal_to_floatE"></span><span id="_CPPv2N5arrow5Field12MergeOptions24promote_decimal_to_floatE"></span><span id="arrow::Field::MergeOptions::promote_decimal_to_float__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a3f197609ccc5069fc407f2090c6b0afe"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_decimal_to_float</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions24promote_decimal_to_floatE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow a decimal to be promoted to a float. </p> |
| <p>The float type will not itself be promoted (e.g. <a class="reference internal" href="utilities.html#classarrow_1_1_decimal128"><span class="std std-ref">Decimal128</span></a> + Float32 = Float32). </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions26promote_integer_to_decimalE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions26promote_integer_to_decimalE"></span><span id="_CPPv2N5arrow5Field12MergeOptions26promote_integer_to_decimalE"></span><span id="arrow::Field::MergeOptions::promote_integer_to_decimal__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1ac896682b130bb019f19e367769eb7e2f"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_integer_to_decimal</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions26promote_integer_to_decimalE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow an integer to be promoted to a decimal. </p> |
| <p>May fail if the decimal has insufficient precision to accommodate the integer (see promote_numeric_width). </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions24promote_integer_to_floatE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions24promote_integer_to_floatE"></span><span id="_CPPv2N5arrow5Field12MergeOptions24promote_integer_to_floatE"></span><span id="arrow::Field::MergeOptions::promote_integer_to_float__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a451d1761523c488799d18364c27b0b94"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_integer_to_float</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions24promote_integer_to_floatE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow an integer of a given bit width to be promoted to a float; the result will be a float of an equal or greater bit width to both of the inputs. </p> |
| <p>Examples:<ul class="simple"> |
| <li><p>int8 + float32 = float32</p></li> |
| <li><p>int32 + float32 = float64</p></li> |
| <li><p>int32 + float64 = float64 Because an int32 cannot always be represented exactly in the 24 bits of a float32 mantissa. </p></li> |
| </ul> |
| </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions20promote_integer_signE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions20promote_integer_signE"></span><span id="_CPPv2N5arrow5Field12MergeOptions20promote_integer_signE"></span><span id="arrow::Field::MergeOptions::promote_integer_sign__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a9860a3b82307ebe726f52744f3d1029e"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_integer_sign</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions20promote_integer_signE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow an unsigned integer of a given bit width to be promoted to a signed integer that fits into the signed type: uint + int16 = int16 When widening is needed, set promote_numeric_width to true: uint16 + int16 = int32. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions21promote_numeric_widthE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions21promote_numeric_widthE"></span><span id="_CPPv2N5arrow5Field12MergeOptions21promote_numeric_widthE"></span><span id="arrow::Field::MergeOptions::promote_numeric_width__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1ad9a73e748b1a6c12461e00d0078c2f2b"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_numeric_width</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions21promote_numeric_widthE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow an integer, float, or decimal of a given bit width to be promoted to an equivalent type of a greater bit width. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions14promote_binaryE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions14promote_binaryE"></span><span id="_CPPv2N5arrow5Field12MergeOptions14promote_binaryE"></span><span id="arrow::Field::MergeOptions::promote_binary__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a5de448369ad56cc09395b8e0052cceed"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_binary</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions14promote_binaryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow strings to be promoted to binary types. </p> |
| <p>Promotion of fixed size binary types to variable sized formats, and binary to large binary, and string to large string. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions21promote_temporal_unitE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions21promote_temporal_unitE"></span><span id="_CPPv2N5arrow5Field12MergeOptions21promote_temporal_unitE"></span><span id="arrow::Field::MergeOptions::promote_temporal_unit__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a95df21ca1c5f2c01c09528ca16f8abb5"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_temporal_unit</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions21promote_temporal_unitE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Second to millisecond, Time32 to Time64, Time32(SECOND) to Time32(MILLI), etc. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions12promote_listE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions12promote_listE"></span><span id="_CPPv2N5arrow5Field12MergeOptions12promote_listE"></span><span id="arrow::Field::MergeOptions::promote_list__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1aa0f71153266f0729052d02fd2b534ef3"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_list</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions12promote_listE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow promotion from a list to a large-list and from a fixed-size list to a variable sized list. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions18promote_dictionaryE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions18promote_dictionaryE"></span><span id="_CPPv2N5arrow5Field12MergeOptions18promote_dictionaryE"></span><span id="arrow::Field::MergeOptions::promote_dictionary__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a5ef090bd76a6a8eeb2b50b7b00e60c29"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_dictionary</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions18promote_dictionaryE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Unify dictionary index types and dictionary value types. </p> |
| </dd></dl> |
| |
| <dl class="cpp var"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions26promote_dictionary_orderedE"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions26promote_dictionary_orderedE"></span><span id="_CPPv2N5arrow5Field12MergeOptions26promote_dictionary_orderedE"></span><span id="arrow::Field::MergeOptions::promote_dictionary_ordered__b"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1a177cdffb5c223c4ea7cb12fc01f767ea"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">promote_dictionary_ordered</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">false</span></span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions26promote_dictionary_orderedE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Allow merging ordered and non-ordered dictionaries. </p> |
| <p>The result will be ordered if and only if both inputs are ordered. </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="_CPPv4N5arrow5Field12MergeOptions8DefaultsEv"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions8DefaultsEv"></span><span id="_CPPv2N5arrow5Field12MergeOptions8DefaultsEv"></span><span id="arrow::Field::MergeOptions::Defaults"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1aad6ec10fe86793101bf688bbf9c9ad96"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="arrow::Field::MergeOptions"><span class="n"><span class="pre">MergeOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Defaults</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions8DefaultsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get default options. Only <a class="reference internal" href="#classarrow_1_1_null_type"><span class="std std-ref">NullType</span></a> will be merged with other types. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow5Field12MergeOptions10PermissiveEv"> |
| <span id="_CPPv3N5arrow5Field12MergeOptions10PermissiveEv"></span><span id="_CPPv2N5arrow5Field12MergeOptions10PermissiveEv"></span><span id="arrow::Field::MergeOptions::Permissive"></span><span class="target" id="structarrow_1_1_field_1_1_merge_options_1aebf2561745b106acadcc61fbf88c28c8"></span><span class="k"><span class="pre">static</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow5Field12MergeOptionsE" title="arrow::Field::MergeOptions"><span class="n"><span class="pre">MergeOptions</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Permissive</span></span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow5Field12MergeOptions10PermissiveEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get permissive options. </p> |
| <p>All options are enabled, except promote_dictionary_ordered. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow6SchemaE"> |
| <span id="_CPPv3N5arrow6SchemaE"></span><span id="_CPPv2N5arrow6SchemaE"></span><span id="arrow::Schema"></span><span class="target" id="classarrow_1_1_schema"></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">Schema</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">detail</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">Fingerprintable</span></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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">EqualityComparable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</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="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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">ToStringOstreamable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow6SchemaE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Sequence of <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">arrow::Field</span></a> objects describing the columns of a record batch or table data structure. </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="_CPPv4NK5arrow6Schema6EqualsERK6Schemab"> |
| <span id="_CPPv3NK5arrow6Schema6EqualsERK6Schemab"></span><span id="_CPPv2NK5arrow6Schema6EqualsERK6Schemab"></span><span id="arrow::Schema::Equals__SchemaCR.bC"></span><span class="target" id="classarrow_1_1_schema_1a9784fd6804971756f1c3ccde47d9ce2a"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</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="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span>, <span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">check_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema6EqualsERK6Schemab" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns true if all of the schema fields are equal. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema14WithEndiannessE10Endianness"> |
| <span id="_CPPv3NK5arrow6Schema14WithEndiannessE10Endianness"></span><span id="_CPPv2NK5arrow6Schema14WithEndiannessE10Endianness"></span><span id="arrow::Schema::WithEndianness__EndiannessC"></span><span class="target" id="classarrow_1_1_schema_1a96c2740b3bbc868ed63ad4caf10abc8a"></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="#_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">WithEndianness</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">Endianness</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">endianness</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema14WithEndiannessE10Endianness" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Set endianness in the schema. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>new <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema10endiannessEv"> |
| <span id="_CPPv3NK5arrow6Schema10endiannessEv"></span><span id="_CPPv2NK5arrow6Schema10endiannessEv"></span><span id="arrow::Schema::endiannessC"></span><span class="target" id="classarrow_1_1_schema_1a11415cc5dea552f0794a7c514464e5b9"></span><span class="n"><span class="pre">Endianness</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">endianness</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="#_CPPv4NK5arrow6Schema10endiannessEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return endianness in the schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema16is_native_endianEv"> |
| <span id="_CPPv3NK5arrow6Schema16is_native_endianEv"></span><span id="_CPPv2NK5arrow6Schema16is_native_endianEv"></span><span id="arrow::Schema::is_native_endianC"></span><span class="target" id="classarrow_1_1_schema_1ac0f28220d8b49933e53088475c23f4f4"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">is_native_endian</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="#_CPPv4NK5arrow6Schema16is_native_endianEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate if endianness is equal to platform-native endianness. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema10num_fieldsEv"> |
| <span id="_CPPv3NK5arrow6Schema10num_fieldsEv"></span><span id="_CPPv2NK5arrow6Schema10num_fieldsEv"></span><span id="arrow::Schema::num_fieldsC"></span><span class="target" id="classarrow_1_1_schema_1a3c7796ff608d03d1c004c6604bb09e5c"></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="#_CPPv4NK5arrow6Schema10num_fieldsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the number of fields (columns) in the schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema5fieldEi"> |
| <span id="_CPPv3NK5arrow6Schema5fieldEi"></span><span id="_CPPv2NK5arrow6Schema5fieldEi"></span><span id="arrow::Schema::field__iC"></span><span class="target" id="classarrow_1_1_schema_1a046664d33b4a891506df2c680964e03b"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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="sig-name descname"><span class="n"><span class="pre">field</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema5fieldEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the ith schema element. Does not boundscheck. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema14GetFieldByNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6Schema14GetFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema14GetFieldByNameERKNSt6stringE"></span><span id="arrow::Schema::GetFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a73c450d1aa2b373e42e742dd8fcb6ec3"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">GetFieldByName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema14GetFieldByNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns null if name not found. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE"></span><span id="arrow::Schema::GetAllFieldsByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1ac379010d38d2a564d77c9a4ee3e421c0"></span><span class="n"><span class="pre">FieldVector</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetAllFieldsByName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema18GetAllFieldsByNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the indices of all fields having this name in sorted order. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema13GetFieldIndexERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6Schema13GetFieldIndexERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema13GetFieldIndexERKNSt6stringE"></span><span id="arrow::Schema::GetFieldIndex__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a471b18cb74814f4476ec72c72e068e35"></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">GetFieldIndex</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema13GetFieldIndexERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Returns -1 if name not found. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE"></span><span id="arrow::Schema::GetAllFieldIndices__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a0a8c63898500ebfac582a7a6dacc3b4e"></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">int</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">GetAllFieldIndices</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema18GetAllFieldIndicesERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return the indices of all fields having this name. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema23CanReferenceFieldByNameERKNSt6stringE"> |
| <span id="_CPPv3NK5arrow6Schema23CanReferenceFieldByNameERKNSt6stringE"></span><span id="_CPPv2NK5arrow6Schema23CanReferenceFieldByNameERKNSt6stringE"></span><span id="arrow::Schema::CanReferenceFieldByName__ssCRC"></span><span class="target" id="classarrow_1_1_schema_1a5117630eaceca33860b31331497fe9a1"></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">CanReferenceFieldByName</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema23CanReferenceFieldByNameERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate if field named <code class="docutils literal notranslate"><span class="pre">name</span></code> can be found unambiguously in the schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema25CanReferenceFieldsByNamesERKNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3NK5arrow6Schema25CanReferenceFieldsByNamesERKNSt6vectorINSt6stringEEE"></span><span id="_CPPv2NK5arrow6Schema25CanReferenceFieldsByNamesERKNSt6vectorINSt6stringEEE"></span><span id="arrow::Schema::CanReferenceFieldsByNames__std::vector:ss:CRC"></span><span class="target" id="classarrow_1_1_schema_1aee68fd8e0d21670192d7455b584471bd"></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">CanReferenceFieldsByNames</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">names</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema25CanReferenceFieldsByNamesERKNSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate if fields named <code class="docutils literal notranslate"><span class="pre">names</span></code> can be found unambiguously in the schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema8metadataEv"> |
| <span id="_CPPv3NK5arrow6Schema8metadataEv"></span><span id="_CPPv2NK5arrow6Schema8metadataEv"></span><span id="arrow::Schema::metadataC"></span><span class="target" id="classarrow_1_1_schema_1af1e6c66f8d0246c213bf17ffa6d96978"></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><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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="sig-name descname"><span class="n"><span class="pre">metadata</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="#_CPPv4NK5arrow6Schema8metadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>The custom key-value metadata, if any. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Returns<span class="colon">:</span></dt> |
| <dd class="field-odd"><p>metadata may be null </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema8ToStringEb"> |
| <span id="_CPPv3NK5arrow6Schema8ToStringEb"></span><span id="_CPPv2NK5arrow6Schema8ToStringEb"></span><span id="arrow::Schema::ToString__bC"></span><span class="target" id="classarrow_1_1_schema_1ac2080c5e2790d537acd00881a18815a5"></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="sig-name descname"><span class="n"><span class="pre">ToString</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">show_metadata</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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema8ToStringEb" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Render a string representation of the schema suitable for debugging. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>show_metadata</strong> – <strong>[in]</strong> when true, if <a class="reference internal" href="#classarrow_1_1_key_value_metadata"><span class="std std-ref">KeyValueMetadata</span></a> is non-empty, print keys and values in the output </p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema9WithNamesERKNSt6vectorINSt6stringEEE"> |
| <span id="_CPPv3NK5arrow6Schema9WithNamesERKNSt6vectorINSt6stringEEE"></span><span id="_CPPv2NK5arrow6Schema9WithNamesERKNSt6vectorINSt6stringEEE"></span><span id="arrow::Schema::WithNames__std::vector:ss:CRC"></span><span class="target" id="classarrow_1_1_schema_1adce2b705d44717bcebda024467cec9a7"></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="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</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">WithNames</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">names</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema9WithNamesERKNSt6vectorINSt6stringEEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Replace field names with new names. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>names</strong> – <strong>[in]</strong> new names </p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>new <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"> |
| <span id="_CPPv3NK5arrow6Schema12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="_CPPv2NK5arrow6Schema12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE"></span><span id="arrow::Schema::WithMetadata__std::shared_ptr:KeyValueMetadataC:CRC"></span><span class="target" id="classarrow_1_1_schema_1ad6b03f404e8095ca43a3b212bdf4d4ed"></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="#_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">WithMetadata</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><span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4N5arrow16KeyValueMetadataE" title="arrow::KeyValueMetadata"><span class="n"><span class="pre">KeyValueMetadata</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">metadata</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow6Schema12WithMetadataERKNSt10shared_ptrIK16KeyValueMetadataEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Replace key-value metadata with new metadata. </p> |
| <dl class="field-list simple"> |
| <dt class="field-odd">Parameters<span class="colon">:</span></dt> |
| <dd class="field-odd"><p><strong>metadata</strong> – <strong>[in]</strong> new <a class="reference internal" href="#classarrow_1_1_key_value_metadata"><span class="std std-ref">KeyValueMetadata</span></a></p> |
| </dd> |
| <dt class="field-even">Returns<span class="colon">:</span></dt> |
| <dd class="field-even"><p>new <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a></p> |
| </dd> |
| </dl> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema14RemoveMetadataEv"> |
| <span id="_CPPv3NK5arrow6Schema14RemoveMetadataEv"></span><span id="_CPPv2NK5arrow6Schema14RemoveMetadataEv"></span><span id="arrow::Schema::RemoveMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a212da457d85a1f6b021ad05638649451"></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="#_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">RemoveMetadata</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="#_CPPv4NK5arrow6Schema14RemoveMetadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return copy of <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> without the <a class="reference internal" href="#classarrow_1_1_key_value_metadata"><span class="std std-ref">KeyValueMetadata</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema11HasMetadataEv"> |
| <span id="_CPPv3NK5arrow6Schema11HasMetadataEv"></span><span id="_CPPv2NK5arrow6Schema11HasMetadataEv"></span><span id="arrow::Schema::HasMetadataC"></span><span class="target" id="classarrow_1_1_schema_1a5be51a6538db0881ef8334c0e7770adf"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasMetadata</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="#_CPPv4NK5arrow6Schema11HasMetadataEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate that the <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> has non-empty KevValueMetadata. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow6Schema21HasDistinctFieldNamesEv"> |
| <span id="_CPPv3NK5arrow6Schema21HasDistinctFieldNamesEv"></span><span id="_CPPv2NK5arrow6Schema21HasDistinctFieldNamesEv"></span><span id="arrow::Schema::HasDistinctFieldNamesC"></span><span class="target" id="classarrow_1_1_schema_1a17b2edd990265dbb866d17c4b820fbde"></span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">HasDistinctFieldNames</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="#_CPPv4NK5arrow6Schema21HasDistinctFieldNamesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Indicate that the <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> has distinct field names. </p> |
| </dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow16KeyValueMetadataE"> |
| <span id="_CPPv3N5arrow16KeyValueMetadataE"></span><span id="_CPPv2N5arrow16KeyValueMetadataE"></span><span id="arrow::KeyValueMetadata"></span><span class="target" id="classarrow_1_1_key_value_metadata"></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">KeyValueMetadata</span></span></span><a class="headerlink" href="#_CPPv4N5arrow16KeyValueMetadataE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>A container for key-value pair type metadata. Not thread-safe. </p> |
| </dd></dl> |
| |
| <section id="helpers-for-looking-up-fields"> |
| <h3>Helpers for looking up fields<a class="headerlink" href="#helpers-for-looking-up-fields" title="Permalink to this heading">#</a></h3> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9FieldPathE"> |
| <span id="_CPPv3N5arrow9FieldPathE"></span><span id="_CPPv2N5arrow9FieldPathE"></span><span id="arrow::FieldPath"></span><span class="target" id="classarrow_1_1_field_path"></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">FieldPath</span></span></span><a class="headerlink" href="#_CPPv4N5arrow9FieldPathE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Represents a path to a nested field using indices of child fields. </p> |
| <p>For example, given indices {5, 9, 3} the field would be retrieved with schema->field(5)->type()->field(9)->type()->field(3)</p> |
| <p>Attempting to retrieve a child field using a <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> which is not valid for a given schema will raise an error. Invalid FieldPaths include:<ul class="simple"> |
| <li><p>an index is out of range</p></li> |
| <li><p>the path is empty (note: a default constructed <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> will be empty)</p></li> |
| </ul> |
| </p> |
| <p>FieldPaths provide a number of accessors for drilling down to potentially nested children. They are overloaded for convenience to support <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> (returns a field), <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a> (returns a child field), <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> (returns a child field of this field’s type) <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> (returns a child array), <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> (returns a column). </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="_CPPv4N5arrow9FieldPath9FieldPathEv"> |
| <span id="_CPPv3N5arrow9FieldPath9FieldPathEv"></span><span id="_CPPv2N5arrow9FieldPath9FieldPathEv"></span><span id="arrow::FieldPath::FieldPath"></span><span class="target" id="classarrow_1_1_field_path_1adee4227a5d0d5454fd91a8456c63ece9"></span><span class="sig-name descname"><span class="n"><span class="pre">FieldPath</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="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N5arrow9FieldPath9FieldPathEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9FieldPath9FieldPathENSt6vectorIiEE"> |
| <span id="_CPPv3N5arrow9FieldPath9FieldPathENSt6vectorIiEE"></span><span id="_CPPv2N5arrow9FieldPath9FieldPathENSt6vectorIiEE"></span><span id="arrow::FieldPath::FieldPath__std::vector:i:"></span><span class="target" id="classarrow_1_1_field_path_1a76caea76a2f6f3f240b2f27b8cd2d740"></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">FieldPath</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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">indices</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow9FieldPath9FieldPathENSt6vectorIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9FieldPath9FieldPathENSt16initializer_listIiEE"> |
| <span id="_CPPv3N5arrow9FieldPath9FieldPathENSt16initializer_listIiEE"></span><span id="_CPPv2N5arrow9FieldPath9FieldPathENSt16initializer_listIiEE"></span><span id="arrow::FieldPath::FieldPath__std::initializer_list:i:"></span><span class="target" id="classarrow_1_1_field_path_1a29881fadb83e45f1f66840e0fd05453c"></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">FieldPath</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">initializer_list</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">indices</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow9FieldPath9FieldPathENSt16initializer_listIiEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath8ToStringEv"> |
| <span id="_CPPv3NK5arrow9FieldPath8ToStringEv"></span><span id="_CPPv2NK5arrow9FieldPath8ToStringEv"></span><span id="arrow::FieldPath::ToStringC"></span><span class="target" id="classarrow_1_1_field_path_1a02af52dc4fc4dbdf6d51126e201089f5"></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="sig-name descname"><span class="n"><span class="pre">ToString</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="#_CPPv4NK5arrow9FieldPath8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath4hashEv"> |
| <span id="_CPPv3NK5arrow9FieldPath4hashEv"></span><span id="_CPPv2NK5arrow9FieldPath4hashEv"></span><span id="arrow::FieldPath::hashC"></span><span class="target" id="classarrow_1_1_field_path_1a2e6c084ee6e72b1d1eb662070dba6bf1"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">hash</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="#_CPPv4NK5arrow9FieldPath4hashEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath5emptyEv"> |
| <span id="_CPPv3NK5arrow9FieldPath5emptyEv"></span><span id="_CPPv2NK5arrow9FieldPath5emptyEv"></span><span id="arrow::FieldPath::emptyC"></span><span class="target" id="classarrow_1_1_field_path_1ab31f44382a7811874d6c870b9f3437e1"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">empty</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="#_CPPv4NK5arrow9FieldPath5emptyEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPatheqERK9FieldPath"> |
| <span id="_CPPv3NK5arrow9FieldPatheqERK9FieldPath"></span><span id="_CPPv2NK5arrow9FieldPatheqERK9FieldPath"></span><span id="arrow::FieldPath::eq-operator__FieldPathCRC"></span><span class="target" id="classarrow_1_1_field_path_1ab35a0d0ffa5692d1a529d21ba624a8e3"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">==</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="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPatheqERK9FieldPath" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPathneERK9FieldPath"> |
| <span id="_CPPv3NK5arrow9FieldPathneERK9FieldPath"></span><span id="_CPPv2NK5arrow9FieldPathneERK9FieldPath"></span><span id="arrow::FieldPath::neq-operator__FieldPathCRC"></span><span class="target" id="classarrow_1_1_field_path_1a405519d45e08fa4687a2492e2fdc3f95"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">!=</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="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPathneERK9FieldPath" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath7indicesEv"> |
| <span id="_CPPv3NK5arrow9FieldPath7indicesEv"></span><span id="_CPPv2NK5arrow9FieldPath7indicesEv"></span><span id="arrow::FieldPath::indicesC"></span><span class="target" id="classarrow_1_1_field_path_1ab438098b298a3f14e615cc389f399c26"></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">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">int</span></span><span class="p"><span class="pre">></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">indices</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="#_CPPv4NK5arrow9FieldPath7indicesEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPathixE6size_t"> |
| <span id="_CPPv3NK5arrow9FieldPathixE6size_t"></span><span id="_CPPv2NK5arrow9FieldPathixE6size_t"></span><span id="arrow::FieldPath::subscript-operator__sC"></span><span class="target" id="classarrow_1_1_field_path_1a8967e8c5bf424840cec7d21c4c5f4e10"></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="k"><span class="pre">operator</span></span><span class="o"><span class="pre">[]</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_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="#_CPPv4NK5arrow9FieldPathixE6size_t" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath5beginEv"> |
| <span id="_CPPv3NK5arrow9FieldPath5beginEv"></span><span id="_CPPv2NK5arrow9FieldPath5beginEv"></span><span id="arrow::FieldPath::beginC"></span><span class="target" id="classarrow_1_1_field_path_1a1a10f28622e100dc481d4298e25d70a8"></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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">const_iterator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">begin</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="#_CPPv4NK5arrow9FieldPath5beginEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3endEv"> |
| <span id="_CPPv3NK5arrow9FieldPath3endEv"></span><span id="_CPPv2NK5arrow9FieldPath3endEv"></span><span id="arrow::FieldPath::endC"></span><span class="target" id="classarrow_1_1_field_path_1a2f727e406f54b30bf12e4482671d4b0b"></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">vector</span></span><span class="p"><span class="pre"><</span></span><span class="kt"><span class="pre">int</span></span><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">const_iterator</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">end</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="#_CPPv4NK5arrow9FieldPath3endEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK6Schema"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK6Schema"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK6Schema"></span><span id="arrow::FieldPath::Get__SchemaCRC"></span><span class="target" id="classarrow_1_1_field_path_1a165fd942d59b8b8a6f45f1f939cb7a1b"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">Get</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="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK6Schema" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the referenced child <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a> from a <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a>, <a class="reference internal" href="#classarrow_1_1_field"><span class="std std-ref">Field</span></a>, or <a class="reference internal" href="#classarrow_1_1_data_type"><span class="std std-ref">DataType</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK5Field"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK5Field"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK5Field"></span><span id="arrow::FieldPath::Get__FieldCRC"></span><span class="target" id="classarrow_1_1_field_path_1a8eb76ec5e982a39b5831622ff08f2aa0"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">Get</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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">field</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK5Field" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK8DataType"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK8DataType"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK8DataType"></span><span id="arrow::FieldPath::Get__DataTypeCRC"></span><span class="target" id="classarrow_1_1_field_path_1a0ff1da4cfdafcd7c32a888eec1de58b4"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">Get</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK8DataType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK11FieldVector"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK11FieldVector"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK11FieldVector"></span><span id="arrow::FieldPath::Get__FieldVectorCRC"></span><span class="target" id="classarrow_1_1_field_path_1a25cacfa6df2a2356d45af641c0b2ac6d"></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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</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">Get</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">FieldVector</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">fields</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK11FieldVector" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK11RecordBatch"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK11RecordBatch"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK11RecordBatch"></span><span id="arrow::FieldPath::Get__RecordBatchCRC"></span><span class="target" id="classarrow_1_1_field_path_1a247c5e002683bcbf70bc221d6bea18c6"></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">Get</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="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">batch</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK11RecordBatch" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the referenced column from a <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a> or <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK5Table"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK5Table"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK5Table"></span><span id="arrow::FieldPath::Get__TableCRC"></span><span class="target" id="classarrow_1_1_field_path_1a8b8a3028ac7d8eaa5b33eb37f557b0fc"></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#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">Get</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="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK5Table" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK5Array"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK5Array"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK5Array"></span><span id="arrow::FieldPath::Get__ArrayCRC"></span><span class="target" id="classarrow_1_1_field_path_1a4bacca80b67ee959f5e838ad1de31485"></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">Get</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="array.html#_CPPv4N5arrow5ArrayE" title="arrow::Array"><span class="n"><span class="pre">Array</span></span></a><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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK5Array" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the referenced child from an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a> or <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK9ArrayData"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK9ArrayData"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK9ArrayData"></span><span id="arrow::FieldPath::Get__ArrayDataCRC"></span><span class="target" id="classarrow_1_1_field_path_1a7007a7e7a40f672b391b6e9ca6fdb2c9"></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#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</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">Get</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="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">data</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK9ArrayData" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath3GetERK12ChunkedArray"> |
| <span id="_CPPv3NK5arrow9FieldPath3GetERK12ChunkedArray"></span><span id="_CPPv2NK5arrow9FieldPath3GetERK12ChunkedArray"></span><span id="arrow::FieldPath::Get__ChunkedArrayCRC"></span><span class="target" id="classarrow_1_1_field_path_1a0fad80f576864788e7d75386a969c7a5"></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#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">Get</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="array.html#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">chunked_array</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath3GetERK12ChunkedArray" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the referenced child from a <a class="reference internal" href="array.html#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath12GetFlattenedERK5ArrayP10MemoryPool"> |
| <span id="_CPPv3NK5arrow9FieldPath12GetFlattenedERK5ArrayP10MemoryPool"></span><span id="_CPPv2NK5arrow9FieldPath12GetFlattenedERK5ArrayP10MemoryPool"></span><span id="arrow::FieldPath::GetFlattened__ArrayCR.MemoryPoolPC"></span><span class="target" id="classarrow_1_1_field_path_1aa93588333c7fad30e6309f640f22019d"></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">GetFlattened</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="array.html#_CPPv4N5arrow5ArrayE" title="arrow::Array"><span class="n"><span class="pre">Array</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">array</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath12GetFlattenedERK5ArrayP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve the referenced child/column from an <a class="reference internal" href="array.html#classarrow_1_1_array"><span class="std std-ref">Array</span></a>, <a class="reference internal" href="array.html#structarrow_1_1_array_data"><span class="std std-ref">ArrayData</span></a>, <a class="reference internal" href="array.html#classarrow_1_1_chunked_array"><span class="std std-ref">ChunkedArray</span></a>, <a class="reference internal" href="table.html#classarrow_1_1_record_batch"><span class="std std-ref">RecordBatch</span></a>, or <a class="reference internal" href="table.html#classarrow_1_1_table"><span class="std std-ref">Table</span></a>. </p> |
| <p>Unlike <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_field_path_1a165fd942d59b8b8a6f45f1f939cb7a1b"><span class="std std-ref"><span class="pre">FieldPath::Get</span></span></a></code>, these variants are not zero-copy and the retrieved child’s null bitmap is ANDed with its ancestors’ </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath12GetFlattenedERK9ArrayDataP10MemoryPool"> |
| <span id="_CPPv3NK5arrow9FieldPath12GetFlattenedERK9ArrayDataP10MemoryPool"></span><span id="_CPPv2NK5arrow9FieldPath12GetFlattenedERK9ArrayDataP10MemoryPool"></span><span id="arrow::FieldPath::GetFlattened__ArrayDataCR.MemoryPoolPC"></span><span class="target" id="classarrow_1_1_field_path_1a92f61ad74254f7283f200b6b399474bf"></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#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</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">GetFlattened</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="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">data</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath12GetFlattenedERK9ArrayDataP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath12GetFlattenedERK12ChunkedArrayP10MemoryPool"> |
| <span id="_CPPv3NK5arrow9FieldPath12GetFlattenedERK12ChunkedArrayP10MemoryPool"></span><span id="_CPPv2NK5arrow9FieldPath12GetFlattenedERK12ChunkedArrayP10MemoryPool"></span><span id="arrow::FieldPath::GetFlattened__ChunkedArrayCR.MemoryPoolPC"></span><span class="target" id="classarrow_1_1_field_path_1aa85d9f1e8cb9fd836895851c60ce1af0"></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#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">GetFlattened</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="array.html#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">chunked_array</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath12GetFlattenedERK12ChunkedArrayP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath12GetFlattenedERK11RecordBatchP10MemoryPool"> |
| <span id="_CPPv3NK5arrow9FieldPath12GetFlattenedERK11RecordBatchP10MemoryPool"></span><span id="_CPPv2NK5arrow9FieldPath12GetFlattenedERK11RecordBatchP10MemoryPool"></span><span id="arrow::FieldPath::GetFlattened__RecordBatchCR.MemoryPoolPC"></span><span class="target" id="classarrow_1_1_field_path_1a813f8cfc71775155869a3d8683264e7e"></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">GetFlattened</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="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">batch</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath12GetFlattenedERK11RecordBatchP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow9FieldPath12GetFlattenedERK5TableP10MemoryPool"> |
| <span id="_CPPv3NK5arrow9FieldPath12GetFlattenedERK5TableP10MemoryPool"></span><span id="_CPPv2NK5arrow9FieldPath12GetFlattenedERK5TableP10MemoryPool"></span><span id="arrow::FieldPath::GetFlattened__TableCR.MemoryPoolPC"></span><span class="target" id="classarrow_1_1_field_path_1a713e10188b22523a05d89bd3c4775a0b"></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#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</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">GetFlattened</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="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath12GetFlattenedERK5TableP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd></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="_CPPv4N5arrow9FieldPath6GetAllERK6SchemaRKNSt6vectorI9FieldPathEE"> |
| <span id="_CPPv3N5arrow9FieldPath6GetAllERK6SchemaRKNSt6vectorI9FieldPathEE"></span><span id="_CPPv2N5arrow9FieldPath6GetAllERK6SchemaRKNSt6vectorI9FieldPathEE"></span><span id="arrow::FieldPath::GetAll__SchemaCR.std::vector:FieldPath:CR"></span><span class="target" id="classarrow_1_1_field_path_1a4dda3b1d689edf741090a74dbf5673b9"></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">shared_ptr</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</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">GetAll</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="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">paths</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow9FieldPath6GetAllERK6SchemaRKNSt6vectorI9FieldPathEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow9FieldPath4HashE"> |
| <span id="_CPPv3N5arrow9FieldPath4HashE"></span><span id="_CPPv2N5arrow9FieldPath4HashE"></span><span id="arrow::FieldPath::Hash"></span><span class="target" id="structarrow_1_1_field_path_1_1_hash"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Hash</span></span></span><a class="headerlink" href="#_CPPv4N5arrow9FieldPath4HashE" 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="_CPPv4NK5arrow9FieldPath4HashclERK9FieldPath"> |
| <span id="_CPPv3NK5arrow9FieldPath4HashclERK9FieldPath"></span><span id="_CPPv2NK5arrow9FieldPath4HashclERK9FieldPath"></span><span id="arrow::FieldPath::Hash::call-operator__FieldPathCRC"></span><span class="target" id="structarrow_1_1_field_path_1_1_hash_1ac50e11268645ae3be890b66b5c7c0a7b"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">()</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="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">path</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow9FieldPath4HashclERK9FieldPath" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRefE"> |
| <span id="_CPPv3N5arrow8FieldRefE"></span><span id="_CPPv2N5arrow8FieldRefE"></span><span id="arrow::FieldRef"></span><span class="target" id="classarrow_1_1_field_ref"></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">FieldRef</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">util</span></span><span class="p"><span class="pre">::</span></span><span class="n"><span class="pre">EqualityComparable</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="p"><span class="pre">></span></span><a class="headerlink" href="#_CPPv4N5arrow8FieldRefE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Descriptor of a (potentially nested) field within a schema. </p> |
| <p>Unlike <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> (which exclusively uses indices of child fields), <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> may reference a field by name. It is intended to replace parameters like <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">field_index</span></code> and <code class="docutils literal notranslate"><span class="pre">const</span> <span class="pre">std::string&</span> <span class="pre">field_name</span></code>; it can be implicitly constructed from either a field index or a name.</p> |
| <p>Nested fields can be referenced as well. Given schema({field(“a”, struct_({field(“n”, <a class="reference internal" href="#group__type-factories_1gaac5b094c3d5d8b58e062382469e31739"><span class="std std-ref">null()</span></a>)})), field(“b”, <a class="reference internal" href="#group__type-factories_1ga1713caac102cfa4db4a39e5ce7f642d8"><span class="std std-ref">int32()</span></a>)})</p> |
| <p>the following all indicate the nested field named “n”: <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> ref1(0, 0); <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> ref2(“a”, 0); <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> ref3(“a”, “n”); <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> ref4(0, “n”); ARROW_ASSIGN_OR_RAISE(<a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> ref5, <a class="reference internal" href="#classarrow_1_1_field_ref_1abea828b46abe54db47c3af1b5faa49b2"><span class="std std-ref">FieldRef::FromDotPath</span></a>(“.a[0]”));</p> |
| <p>FieldPaths matching a <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> are retrieved using the member function FindAll. Multiple matches are possible because field names may be duplicated within a schema. For example: <a class="reference internal" href="#classarrow_1_1_schema"><span class="std std-ref">Schema</span></a> a_is_ambiguous({field(“a”, <a class="reference internal" href="#group__type-factories_1ga1713caac102cfa4db4a39e5ce7f642d8"><span class="std std-ref">int32()</span></a>), field(“a”, <a class="reference internal" href="#group__type-factories_1ga8b5a6e733c4b6c08014203a42c1a9706"><span class="std std-ref">float32()</span></a>)}); auto matches = <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“a”).FindAll(a_is_ambiguous); assert(matches.size() == 2); assert(matches[0].Get(a_is_ambiguous)->Equals(a_is_ambiguous.field(0))); assert(matches[1].Get(a_is_ambiguous)->Equals(a_is_ambiguous.field(1)));</p> |
| <p>Convenience accessors are available which raise a helpful error if the field is not found or ambiguous, and for immediately calling <a class="reference internal" href="#classarrow_1_1_field_path_1a165fd942d59b8b8a6f45f1f939cb7a1b"><span class="std std-ref">FieldPath::Get</span></a> to retrieve any matching children: auto maybe_match = <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“struct”, “field_i32”).FindOneOrNone(schema); auto maybe_column = <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“struct”, “field_i32”).GetOne(some_table); </p> |
| <div class="breathe-sectiondef docutils container"> |
| <p class="breathe-sectiondef-title rubric" id="breathe-section-title-public-types">Public Types</p> |
| <dl class="cpp type"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0EN5arrow8FieldRef7GetTypeE"> |
| <span id="_CPPv3I0EN5arrow8FieldRef7GetTypeE"></span><span id="_CPPv2I0EN5arrow8FieldRef7GetTypeE"></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_field_ref_1a45ff0400d878f4a4b928860973bf7c89"></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">GetType</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">decltype</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">declval</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</span></span></a><span class="p"><span class="pre">></span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">.</span></span><span class="n"><span class="pre">Get</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">declval</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType::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="p"><span class="pre">)</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">.</span></span><span class="n"><span class="pre">ValueOrDie</span></span><span class="p"><span class="pre">(</span></span><span class="p"><span class="pre">)</span></span><span class="p"><span class="pre">)</span></span><a class="headerlink" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </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="_CPPv4N5arrow8FieldRef8FieldRefEv"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefEv"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefEv"></span><span id="arrow::FieldRef::FieldRef"></span><span class="target" id="classarrow_1_1_field_ref_1a13e0b853fc6b3dcf9bd6179bf9664efe"></span><span class="sig-name descname"><span class="n"><span class="pre">FieldRef</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="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef8FieldRefE9FieldPath"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefE9FieldPath"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefE9FieldPath"></span><span id="arrow::FieldRef::FieldRef__FieldPath"></span><span class="target" id="classarrow_1_1_field_ref_1ac4eb88bec1e2e92c0904014630a703da"></span><span class="sig-name descname"><span class="n"><span class="pre">FieldRef</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</span></span></a><span class="w"> </span><span class="n sig-param"><span class="pre">indices</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefE9FieldPath" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct a <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a> using a string of indices. </p> |
| <p>The reference will be retrieved as: schema.fields[self.indices[0]].type.fields[self.indices[1]] …</p> |
| <p>Empty indices are not valid. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef8FieldRefENSt6stringE"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefENSt6stringE"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefENSt6stringE"></span><span id="arrow::FieldRef::FieldRef__ss"></span><span class="target" id="classarrow_1_1_field_ref_1a184489f63e9ea5656c1978b135bcfb33"></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">FieldRef</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">string</span></span><span class="w"> </span><span class="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefENSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct a by-name <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Multiple fields may match a by-name <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>: [f for f in schema.fields where f.name == self.name] </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef8FieldRefEPKc"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefEPKc"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefEPKc"></span><span id="arrow::FieldRef::FieldRef__cCP"></span><span class="target" id="classarrow_1_1_field_ref_1a0954c24d556e8e84f6fed69cb481886b"></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">FieldRef</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="n sig-param"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefEPKc" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef8FieldRefEi"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefEi"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefEi"></span><span id="arrow::FieldRef::FieldRef__i"></span><span class="target" id="classarrow_1_1_field_ref_1ada3081176aebf294d36e69761c395fd0"></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">FieldRef</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">index</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefEi" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Equivalent to a single index string of indices. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef8FieldRefENSt6vectorI8FieldRefEE"> |
| <span id="_CPPv3N5arrow8FieldRef8FieldRefENSt6vectorI8FieldRefEE"></span><span id="_CPPv2N5arrow8FieldRef8FieldRefENSt6vectorI8FieldRefEE"></span><span id="arrow::FieldRef::FieldRef__std::vector:FieldRef:"></span><span class="target" id="classarrow_1_1_field_ref_1ac1097a3ab07c2d0b1b6b5f3e5ce4d77a"></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">FieldRef</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">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4N5arrow8FieldRef8FieldRefENSt6vectorI8FieldRefEE" title="arrow::FieldRef::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="p"><span class="pre">></span></span><span class="w"> </span><span class="n sig-param"><span class="pre">refs</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef8FieldRefENSt6vectorI8FieldRefEE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Construct a nested <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A"> |
| <span id="_CPPv3I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A"></span><span id="_CPPv2I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A"></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">A0</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">A1</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="p"><span class="pre">...</span></span><span class="sig-name descname"><span class="n"><span class="pre">A</span></span></span><span class="p"><span class="pre">></span></span><br /><span class="target" id="classarrow_1_1_field_ref_1a34007097362d31fba751b9b7a4516b63"></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">FieldRef</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="#_CPPv4I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A" title="arrow::FieldRef::FieldRef::A0"><span class="n"><span class="pre">A0</span></span></a><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">a0</span></span>, <a class="reference internal" href="#_CPPv4I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A" title="arrow::FieldRef::FieldRef::A1"><span class="n"><span class="pre">A1</span></span></a><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">a1</span></span>, <a class="reference internal" href="#_CPPv4I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A" title="arrow::FieldRef::FieldRef::A"><span class="n"><span class="pre">A</span></span></a><span class="p"><span class="pre">&</span></span><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">a</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4I00DpEN5arrow8FieldRef8FieldRefERR2A0RR2A1DpRR1A" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience constructor for nested FieldRefs: each argument will be used to construct a <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef9ToDotPathEv"> |
| <span id="_CPPv3NK5arrow8FieldRef9ToDotPathEv"></span><span id="_CPPv2NK5arrow8FieldRef9ToDotPathEv"></span><span id="arrow::FieldRef::ToDotPathC"></span><span class="target" id="classarrow_1_1_field_ref_1a2514b1f048037f924abec28c593c8cb8"></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="sig-name descname"><span class="n"><span class="pre">ToDotPath</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="#_CPPv4NK5arrow8FieldRef9ToDotPathEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef6EqualsERK8FieldRef"> |
| <span id="_CPPv3NK5arrow8FieldRef6EqualsERK8FieldRef"></span><span id="_CPPv2NK5arrow8FieldRef6EqualsERK8FieldRef"></span><span id="arrow::FieldRef::Equals__FieldRefCRC"></span><span class="target" id="classarrow_1_1_field_ref_1ad1d196aa0da401d87faebc252b725150"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Equals</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="#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">other</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef6EqualsERK8FieldRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef8ToStringEv"> |
| <span id="_CPPv3NK5arrow8FieldRef8ToStringEv"></span><span id="_CPPv2NK5arrow8FieldRef8ToStringEv"></span><span id="arrow::FieldRef::ToStringC"></span><span class="target" id="classarrow_1_1_field_ref_1a89794f5ce7772774c3b1829f42bc1c47"></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="sig-name descname"><span class="n"><span class="pre">ToString</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="#_CPPv4NK5arrow8FieldRef8ToStringEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef4hashEv"> |
| <span id="_CPPv3NK5arrow8FieldRef4hashEv"></span><span id="_CPPv2NK5arrow8FieldRef4hashEv"></span><span id="arrow::FieldRef::hashC"></span><span class="target" id="classarrow_1_1_field_ref_1acad550fcf1de6ce2828f9b9f10941540"></span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">hash</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="#_CPPv4NK5arrow8FieldRef4hashEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRefcvbEv"> |
| <span id="_CPPv3NK5arrow8FieldRefcvbEv"></span><span id="_CPPv2NK5arrow8FieldRefcvbEv"></span><span id="arrow::FieldRef::castto-b-operatorC"></span><span class="target" id="classarrow_1_1_field_ref_1a1598688403cd215b88b96b839c5bb193"></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="k"><span class="pre">operator</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</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="#_CPPv4NK5arrow8FieldRefcvbEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRefntEv"> |
| <span id="_CPPv3NK5arrow8FieldRefntEv"></span><span id="_CPPv2NK5arrow8FieldRefntEv"></span><span id="arrow::FieldRef::not-operatorC"></span><span class="target" id="classarrow_1_1_field_ref_1a0608b4f8282765815c2f166bf9637b4d"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">!</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="#_CPPv4NK5arrow8FieldRefntEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef11IsFieldPathEv"> |
| <span id="_CPPv3NK5arrow8FieldRef11IsFieldPathEv"></span><span id="_CPPv2NK5arrow8FieldRef11IsFieldPathEv"></span><span id="arrow::FieldRef::IsFieldPathC"></span><span class="target" id="classarrow_1_1_field_ref_1ae33cf0296994a6fb6284c4e11027d95a"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsFieldPath</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="#_CPPv4NK5arrow8FieldRef11IsFieldPathEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef6IsNameEv"> |
| <span id="_CPPv3NK5arrow8FieldRef6IsNameEv"></span><span id="_CPPv2NK5arrow8FieldRef6IsNameEv"></span><span id="arrow::FieldRef::IsNameC"></span><span class="target" id="classarrow_1_1_field_ref_1a56d1b8aeab2722bca9800b27be338b52"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsName</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="#_CPPv4NK5arrow8FieldRef6IsNameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef8IsNestedEv"> |
| <span id="_CPPv3NK5arrow8FieldRef8IsNestedEv"></span><span id="_CPPv2NK5arrow8FieldRef8IsNestedEv"></span><span id="arrow::FieldRef::IsNestedC"></span><span class="target" id="classarrow_1_1_field_ref_1aad7e05c92cb4a2a520335b477f1af51e"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsNested</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="#_CPPv4NK5arrow8FieldRef8IsNestedEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef14IsNameSequenceEv"> |
| <span id="_CPPv3NK5arrow8FieldRef14IsNameSequenceEv"></span><span id="_CPPv2NK5arrow8FieldRef14IsNameSequenceEv"></span><span id="arrow::FieldRef::IsNameSequenceC"></span><span class="target" id="classarrow_1_1_field_ref_1a37344fcd233a9f765b85aab12bd61d89"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="kt"><span class="pre">bool</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">IsNameSequence</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="#_CPPv4NK5arrow8FieldRef14IsNameSequenceEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Return true if this ref is a name or a nested sequence of only names. </p> |
| <p>Useful for determining if iteration is possible without recursion or inner loops </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef10field_pathEv"> |
| <span id="_CPPv3NK5arrow8FieldRef10field_pathEv"></span><span id="_CPPv2NK5arrow8FieldRef10field_pathEv"></span><span id="arrow::FieldRef::field_pathC"></span><span class="target" id="classarrow_1_1_field_ref_1ac8d707955b1e86d6e498d52ad449af02"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">field_path</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="#_CPPv4NK5arrow8FieldRef10field_pathEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef4nameEv"> |
| <span id="_CPPv3NK5arrow8FieldRef4nameEv"></span><span id="_CPPv2NK5arrow8FieldRef4nameEv"></span><span id="arrow::FieldRef::nameC"></span><span class="target" id="classarrow_1_1_field_ref_1a5257c2050b6c2cf1022282cd7c5d3e87"></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">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="sig-name descname"><span class="n"><span class="pre">name</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="#_CPPv4NK5arrow8FieldRef4nameEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef11nested_refsEv"> |
| <span id="_CPPv3NK5arrow8FieldRef11nested_refsEv"></span><span id="_CPPv2NK5arrow8FieldRef11nested_refsEv"></span><span id="arrow::FieldRef::nested_refsC"></span><span class="target" id="classarrow_1_1_field_ref_1a2b47e7c827cee5486dd44bddcb6f938f"></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">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><a class="reference internal" href="#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</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="sig-name descname"><span class="n"><span class="pre">nested_refs</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="#_CPPv4NK5arrow8FieldRef11nested_refsEv" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK6Schema"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK6Schema"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK6Schema"></span><span id="arrow::FieldRef::FindAll__SchemaCRC"></span><span class="target" id="classarrow_1_1_field_ref_1aaff5736dd030e307d798190eedd76b70"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="#_CPPv4N5arrow6SchemaE" title="arrow::Schema"><span class="n"><span class="pre">Schema</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">schema</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK6Schema" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> of every child field which matches this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK5Field"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK5Field"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK5Field"></span><span id="arrow::FieldRef::FindAll__FieldCRC"></span><span class="target" id="classarrow_1_1_field_ref_1ae2b81ca3a38027267fb657f3fb14d8b8"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="#_CPPv4N5arrow5FieldE" title="arrow::Field"><span class="n"><span class="pre">Field</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">field</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK5Field" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK8DataType"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK8DataType"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK8DataType"></span><span id="arrow::FieldRef::FindAll__DataTypeCRC"></span><span class="target" id="classarrow_1_1_field_ref_1acebfd1f84e99cf29ba26953b0f70b17a"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="#_CPPv4N5arrow8DataTypeE" title="arrow::DataType"><span class="n"><span class="pre">DataType</span></span></a><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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK8DataType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK11FieldVector"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK11FieldVector"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK11FieldVector"></span><span id="arrow::FieldRef::FindAll__FieldVectorCRC"></span><span class="target" id="classarrow_1_1_field_ref_1aa6cfe0e3d06bf54b8b72cd5658e84a3b"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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">FieldVector</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">fields</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK11FieldVector" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK9ArrayData"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK9ArrayData"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK9ArrayData"></span><span id="arrow::FieldRef::FindAll__ArrayDataCRC"></span><span class="target" id="classarrow_1_1_field_ref_1a8d5ffb7a033d2a3997afee3cd134f12e"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="array.html#_CPPv4N5arrow9ArrayDataE" title="arrow::ArrayData"><span class="n"><span class="pre">ArrayData</span></span></a><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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK9ArrayData" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience function which applies FindAll to arg’s type or schema. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK5Array"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK5Array"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK5Array"></span><span id="arrow::FieldRef::FindAll__ArrayCRC"></span><span class="target" id="classarrow_1_1_field_ref_1aa2bafa37eac73d20b103250426df30ae"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="array.html#_CPPv4N5arrow5ArrayE" title="arrow::Array"><span class="n"><span class="pre">Array</span></span></a><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="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK5Array" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK12ChunkedArray"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK12ChunkedArray"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK12ChunkedArray"></span><span id="arrow::FieldRef::FindAll__ChunkedArrayCRC"></span><span class="target" id="classarrow_1_1_field_ref_1a93bb85f0271a854f3f27d8499ece7e40"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="array.html#_CPPv4N5arrow12ChunkedArrayE" title="arrow::ChunkedArray"><span class="n"><span class="pre">ChunkedArray</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">chunked_array</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK12ChunkedArray" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK11RecordBatch"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK11RecordBatch"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK11RecordBatch"></span><span id="arrow::FieldRef::FindAll__RecordBatchCRC"></span><span class="target" id="classarrow_1_1_field_ref_1ab36b38e1fda08b2508db6277455b20b5"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="table.html#_CPPv4N5arrow11RecordBatchE" title="arrow::RecordBatch"><span class="n"><span class="pre">RecordBatch</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">batch</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK11RecordBatch" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4NK5arrow8FieldRef7FindAllERK5Table"> |
| <span id="_CPPv3NK5arrow8FieldRef7FindAllERK5Table"></span><span id="_CPPv2NK5arrow8FieldRef7FindAllERK5Table"></span><span id="arrow::FieldRef::FindAll__TableCRC"></span><span class="target" id="classarrow_1_1_field_ref_1abb04914c6c4b628c39176d3da1a5e089"></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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindAll</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="table.html#_CPPv4N5arrow5TableE" title="arrow::Table"><span class="n"><span class="pre">Table</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">table</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef7FindAllERK5Table" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef13CheckNonEmptyE6StatusRKNSt6vectorI9FieldPathEERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef13CheckNonEmptyERKNSt6vectorI9FieldPathEERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef13CheckNonEmptyERKNSt6vectorI9FieldPathEERK1T"></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_field_ref_1a1905a993f22a735911a7903e746f05e9"></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">CheckNonEmpty</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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">matches</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef13CheckNonEmptyE6StatusRKNSt6vectorI9FieldPathEERK1T" title="arrow::FieldRef::CheckNonEmpty::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef13CheckNonEmptyE6StatusRKNSt6vectorI9FieldPathEERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience function: raise an error if matches is empty. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef16CheckNonMultipleE6StatusRKNSt6vectorI9FieldPathEERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef16CheckNonMultipleERKNSt6vectorI9FieldPathEERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef16CheckNonMultipleERKNSt6vectorI9FieldPathEERK1T"></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_field_ref_1a993d0872b2c308ed541d943fc785129d"></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">CheckNonMultiple</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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">matches</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef16CheckNonMultipleE6StatusRKNSt6vectorI9FieldPathEERK1T" title="arrow::FieldRef::CheckNonMultiple::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef16CheckNonMultipleE6StatusRKNSt6vectorI9FieldPathEERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Convenience function: raise an error if matches contains multiple FieldPaths. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef7FindOneE6ResultI9FieldPathERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef7FindOneERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef7FindOneERK1T"></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_field_ref_1a3a46e4e8f9041e4ffa5bb34e50ad93b4"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindOne</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="#_CPPv4I0ENK5arrow8FieldRef7FindOneE6ResultI9FieldPathERK1T" title="arrow::FieldRef::FindOne::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef7FindOneE6ResultI9FieldPathERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> of a single child field which matches this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Emit an error if none or multiple match. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef13FindOneOrNoneE6ResultI9FieldPathERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef13FindOneOrNoneERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef13FindOneOrNoneERK1T"></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_field_ref_1a7663e6dcd2b692877ca071f126ac22c1"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4N5arrow9FieldPathE" title="arrow::FieldPath"><span class="n"><span class="pre">FieldPath</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">FindOneOrNone</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="#_CPPv4I0ENK5arrow8FieldRef13FindOneOrNoneE6ResultI9FieldPathERK1T" title="arrow::FieldRef::FindOneOrNone::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef13FindOneOrNoneE6ResultI9FieldPathERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Retrieve <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> of a single child field which matches this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Emit an error if multiple match. An empty (invalid) <a class="reference internal" href="#classarrow_1_1_field_path"><span class="std std-ref">FieldPath</span></a> will be returned if none match. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef6GetAllENSt6vectorI7GetTypeI1TEEERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef6GetAllERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef6GetAllERK1T"></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_field_ref_1a658301f688f2cbeb9fad49c7560ad618"></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">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef6GetAllENSt6vectorI7GetTypeI1TEEERK1T" title="arrow::FieldRef::GetAll::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><span class="sig-name descname"><span class="n"><span class="pre">GetAll</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="#_CPPv4I0ENK5arrow8FieldRef6GetAllENSt6vectorI7GetTypeI1TEEERK1T" title="arrow::FieldRef::GetAll::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef6GetAllENSt6vectorI7GetTypeI1TEEERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get all children matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef15GetAllFlattenedE6ResultINSt6vectorI7GetTypeI1TEEEERK1TP10MemoryPool"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef15GetAllFlattenedERK1TP10MemoryPool"></span><span id="_CPPv2I0ENK5arrow8FieldRef15GetAllFlattenedERK1TP10MemoryPool"></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_field_ref_1a856e97dd80c720362693b229ff67d76e"></span><span class="k"><span class="pre">inline</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">vector</span></span><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef15GetAllFlattenedE6ResultINSt6vectorI7GetTypeI1TEEEERK1TP10MemoryPool" title="arrow::FieldRef::GetAllFlattened::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="p"><span class="pre">></span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">GetAllFlattened</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="#_CPPv4I0ENK5arrow8FieldRef15GetAllFlattenedE6ResultINSt6vectorI7GetTypeI1TEEEERK1TP10MemoryPool" title="arrow::FieldRef::GetAllFlattened::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="n sig-param"><span class="pre">root</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef15GetAllFlattenedE6ResultINSt6vectorI7GetTypeI1TEEEERK1TP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get all children matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Unlike <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_field_ref_1a658301f688f2cbeb9fad49c7560ad618"><span class="std std-ref"><span class="pre">FieldRef::GetAll</span></span></a></code>, this variant is not zero-copy and the retrieved children’s null bitmaps are ANDed with their ancestors’ </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef6GetOneE6ResultI7GetTypeI1TEERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef6GetOneERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef6GetOneERK1T"></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_field_ref_1a59b98c599b14aca11a32e2cb3082f583"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef6GetOneE6ResultI7GetTypeI1TEERK1T" title="arrow::FieldRef::GetOne::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><span class="sig-name descname"><span class="n"><span class="pre">GetOne</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="#_CPPv4I0ENK5arrow8FieldRef6GetOneE6ResultI7GetTypeI1TEERK1T" title="arrow::FieldRef::GetOne::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef6GetOneE6ResultI7GetTypeI1TEERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the single child matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Emit an error if none or multiple match. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef15GetOneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef15GetOneFlattenedERK1TP10MemoryPool"></span><span id="_CPPv2I0ENK5arrow8FieldRef15GetOneFlattenedERK1TP10MemoryPool"></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_field_ref_1a619e88ad310cc59b1497275dfcbcae44"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef15GetOneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="arrow::FieldRef::GetOneFlattened::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><span class="sig-name descname"><span class="n"><span class="pre">GetOneFlattened</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="#_CPPv4I0ENK5arrow8FieldRef15GetOneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="arrow::FieldRef::GetOneFlattened::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="n sig-param"><span class="pre">root</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef15GetOneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the single child matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Unlike <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_field_ref_1a59b98c599b14aca11a32e2cb3082f583"><span class="std std-ref"><span class="pre">FieldRef::GetOne</span></span></a></code>, this variant is not zero-copy and the retrieved child’s null bitmap is ANDed with its ancestors’ </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef12GetOneOrNoneE6ResultI7GetTypeI1TEERK1T"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef12GetOneOrNoneERK1T"></span><span id="_CPPv2I0ENK5arrow8FieldRef12GetOneOrNoneERK1T"></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_field_ref_1a6687be25f7b918d83439f33f2969fdc3"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef12GetOneOrNoneE6ResultI7GetTypeI1TEERK1T" title="arrow::FieldRef::GetOneOrNone::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><span class="sig-name descname"><span class="n"><span class="pre">GetOneOrNone</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="#_CPPv4I0ENK5arrow8FieldRef12GetOneOrNoneE6ResultI7GetTypeI1TEERK1T" title="arrow::FieldRef::GetOneOrNone::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="n sig-param"><span class="pre">root</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef12GetOneOrNoneE6ResultI7GetTypeI1TEERK1T" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the single child matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Return nullptr if none match, emit an error if multiple match. </p> |
| </dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool"> |
| <span id="_CPPv3I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedERK1TP10MemoryPool"></span><span id="_CPPv2I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedERK1TP10MemoryPool"></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_field_ref_1acd65f7f14aff07dd80eeab519666a8e4"></span><span class="k"><span class="pre">inline</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><a class="reference internal" href="#_CPPv4I0EN5arrow8FieldRef7GetTypeE" title="arrow::FieldRef::GetType"><span class="n"><span class="pre">GetType</span></span></a><span class="p"><span class="pre"><</span></span><a class="reference internal" href="#_CPPv4I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="arrow::FieldRef::GetOneOrNoneFlattened::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><span class="sig-name descname"><span class="n"><span class="pre">GetOneOrNoneFlattened</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="#_CPPv4I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="arrow::FieldRef::GetOneOrNoneFlattened::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="n sig-param"><span class="pre">root</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="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><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4I0ENK5arrow8FieldRef21GetOneOrNoneFlattenedE6ResultI7GetTypeI1TEERK1TP10MemoryPool" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Get the single child matching this <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>Return nullptr if none match, emit an error if multiple match. Unlike <code class="docutils literal notranslate"><a class="reference internal" href="#classarrow_1_1_field_ref_1a6687be25f7b918d83439f33f2969fdc3"><span class="std std-ref"><span class="pre">FieldRef::GetOneOrNone</span></span></a></code>, this variant is not zero-copy and the retrieved child’s null bitmap is ANDed with its ancestors’ </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="_CPPv4N5arrow8FieldRef11FromDotPathERKNSt6stringE"> |
| <span id="_CPPv3N5arrow8FieldRef11FromDotPathERKNSt6stringE"></span><span id="_CPPv2N5arrow8FieldRef11FromDotPathERKNSt6stringE"></span><span id="arrow::FieldRef::FromDotPath__ssCR"></span><span class="target" id="classarrow_1_1_field_ref_1abea828b46abe54db47c3af1b5faa49b2"></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><a class="reference internal" href="#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</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">FromDotPath</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">string</span></span><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">dot_path</span></span><span class="sig-paren">)</span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef11FromDotPathERKNSt6stringE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Parse a dot path into a <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>. </p> |
| <p>dot_path = ‘.’ name | ‘[’ digit+ ‘]’ | dot_path+</p> |
| <p>Examples: “.alpha” => <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“alpha”) “[2]” => FieldRef(2) “.beta[3]” => <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“beta”, 3) “[5].gamma.delta[7]” => <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(5, “gamma”, “delta”, 7) “.hello world” => <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(“hello world”) R”(.\[y\]\tho.\)” => <a class="reference internal" href="#classarrow_1_1_field_ref"><span class="std std-ref">FieldRef</span></a>(R”([y]\tho.\)”)</p> |
| <p>Note: When parsing a name, a ‘' preceding any other character will be dropped from the resulting name. Therefore if a name must contain the characters ‘.’, ‘', or ‘[’ those must be escaped with a preceding ‘'. </p> |
| </dd></dl> |
| |
| </div> |
| <dl class="cpp struct"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow8FieldRef4HashE"> |
| <span id="_CPPv3N5arrow8FieldRef4HashE"></span><span id="_CPPv2N5arrow8FieldRef4HashE"></span><span id="arrow::FieldRef::Hash"></span><span class="target" id="structarrow_1_1_field_ref_1_1_hash"></span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">Hash</span></span></span><a class="headerlink" href="#_CPPv4N5arrow8FieldRef4HashE" 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="_CPPv4NK5arrow8FieldRef4HashclERK8FieldRef"> |
| <span id="_CPPv3NK5arrow8FieldRef4HashclERK8FieldRef"></span><span id="_CPPv2NK5arrow8FieldRef4HashclERK8FieldRef"></span><span id="arrow::FieldRef::Hash::call-operator__FieldRefCRC"></span><span class="target" id="structarrow_1_1_field_ref_1_1_hash_1adef88055ae9482dbb2858a71aa771c07"></span><span class="k"><span class="pre">inline</span></span><span class="w"> </span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="k"><span class="pre">operator</span></span><span class="o"><span class="pre">()</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="#_CPPv4N5arrow8FieldRefE" title="arrow::FieldRef"><span class="n"><span class="pre">FieldRef</span></span></a><span class="w"> </span><span class="p"><span class="pre">&</span></span><span class="n sig-param"><span class="pre">ref</span></span><span class="sig-paren">)</span><span class="w"> </span><span class="k"><span class="pre">const</span></span><a class="headerlink" href="#_CPPv4NK5arrow8FieldRef4HashclERK8FieldRef" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </dd></dl> |
| |
| </section> |
| </section> |
| <section id="utilities"> |
| <h2>Utilities<a class="headerlink" href="#utilities" title="Permalink to this heading">#</a></h2> |
| <dl class="cpp class"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitorE"> |
| <span id="_CPPv3N5arrow11TypeVisitorE"></span><span id="_CPPv2N5arrow11TypeVisitorE"></span><span id="arrow::TypeVisitor"></span><span class="target" id="classarrow_1_1_type_visitor"></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">TypeVisitor</span></span></span><a class="headerlink" href="#_CPPv4N5arrow11TypeVisitorE" title="Permalink to this definition">#</a><br /></dt> |
| <dd><p>Abstract type visitor class. </p> |
| <p>Subclass this to create a visitor that can be used with the <a class="reference internal" href="#classarrow_1_1_data_type_1a97571c4039e363f7ebcb09f7c789064a"><span class="std std-ref">DataType::Accept()</span></a> method. </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="_CPPv4N5arrow11TypeVisitorD0Ev"> |
| <span id="_CPPv3N5arrow11TypeVisitorD0Ev"></span><span id="_CPPv2N5arrow11TypeVisitorD0Ev"></span><span id="arrow::TypeVisitor::~TypeVisitor"></span><span class="target" id="classarrow_1_1_type_visitor_1a2806c10b0d7d76452254b70a397a05fc"></span><span class="k"><span class="pre">virtual</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">~TypeVisitor</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="k"><span class="pre">default</span></span><a class="headerlink" href="#_CPPv4N5arrow11TypeVisitorD0Ev" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK8NullType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK8NullType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK8NullType"></span><span id="arrow::TypeVisitor::Visit__NullTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a7c55beece55f9c82a191a3667f2ca582"></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">Visit</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="#_CPPv4N5arrow8NullTypeE" title="arrow::NullType"><span class="n"><span class="pre">NullType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK8NullType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK11BooleanType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK11BooleanType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK11BooleanType"></span><span id="arrow::TypeVisitor::Visit__BooleanTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a75d237292ffd1aad443fa1bcb79a16e4"></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">Visit</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="#_CPPv4N5arrow11BooleanTypeE" title="arrow::BooleanType"><span class="n"><span class="pre">BooleanType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK11BooleanType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK8Int8Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK8Int8Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK8Int8Type"></span><span id="arrow::TypeVisitor::Visit__Int8TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a7554d90b64f1583d20dd1ca36a09e319"></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">Visit</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="#_CPPv4N5arrow8Int8TypeE" title="arrow::Int8Type"><span class="n"><span class="pre">Int8Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK8Int8Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK9Int16Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK9Int16Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK9Int16Type"></span><span id="arrow::TypeVisitor::Visit__Int16TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a9b5b2ce448c2ba06a621d55465fc7aca"></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">Visit</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="#_CPPv4N5arrow9Int16TypeE" title="arrow::Int16Type"><span class="n"><span class="pre">Int16Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK9Int16Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK9Int32Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK9Int32Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK9Int32Type"></span><span id="arrow::TypeVisitor::Visit__Int32TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a3f592131b2c8b45893e904b72d278c04"></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">Visit</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="#_CPPv4N5arrow9Int32TypeE" title="arrow::Int32Type"><span class="n"><span class="pre">Int32Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK9Int32Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK9Int64Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK9Int64Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK9Int64Type"></span><span id="arrow::TypeVisitor::Visit__Int64TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a9754b5521554749cd2d67994c573d12c"></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">Visit</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="#_CPPv4N5arrow9Int64TypeE" title="arrow::Int64Type"><span class="n"><span class="pre">Int64Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK9Int64Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK9UInt8Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK9UInt8Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK9UInt8Type"></span><span id="arrow::TypeVisitor::Visit__UInt8TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a610cb0e5794fb0b324db6664aed591ad"></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">Visit</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="#_CPPv4N5arrow9UInt8TypeE" title="arrow::UInt8Type"><span class="n"><span class="pre">UInt8Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK9UInt8Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10UInt16Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10UInt16Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10UInt16Type"></span><span id="arrow::TypeVisitor::Visit__UInt16TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a660f001dc52d76dc4789292afc961ab9"></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">Visit</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="#_CPPv4N5arrow10UInt16TypeE" title="arrow::UInt16Type"><span class="n"><span class="pre">UInt16Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10UInt16Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10UInt32Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10UInt32Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10UInt32Type"></span><span id="arrow::TypeVisitor::Visit__UInt32TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a757e01f2d6f9a9f313f78cbf40a3d6ec"></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">Visit</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="#_CPPv4N5arrow10UInt32TypeE" title="arrow::UInt32Type"><span class="n"><span class="pre">UInt32Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10UInt32Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10UInt64Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10UInt64Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10UInt64Type"></span><span id="arrow::TypeVisitor::Visit__UInt64TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a9906824e27db9450efe4d7dc0434cdaa"></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">Visit</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="#_CPPv4N5arrow10UInt64TypeE" title="arrow::UInt64Type"><span class="n"><span class="pre">UInt64Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10UInt64Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK13HalfFloatType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK13HalfFloatType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK13HalfFloatType"></span><span id="arrow::TypeVisitor::Visit__HalfFloatTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1af4bacd2a7bc7b23beaacf9d514331aae"></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">Visit</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="#_CPPv4N5arrow13HalfFloatTypeE" title="arrow::HalfFloatType"><span class="n"><span class="pre">HalfFloatType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK13HalfFloatType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK9FloatType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK9FloatType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK9FloatType"></span><span id="arrow::TypeVisitor::Visit__FloatTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1abb80399a36d5f71cd873e27be0eb9b0c"></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">Visit</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="#_CPPv4N5arrow9FloatTypeE" title="arrow::FloatType"><span class="n"><span class="pre">FloatType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK9FloatType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10DoubleType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10DoubleType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10DoubleType"></span><span id="arrow::TypeVisitor::Visit__DoubleTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a43dd889fa552c04dab46ffbdaf38d306"></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">Visit</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="#_CPPv4N5arrow10DoubleTypeE" title="arrow::DoubleType"><span class="n"><span class="pre">DoubleType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10DoubleType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10StringType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10StringType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10StringType"></span><span id="arrow::TypeVisitor::Visit__StringTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1afe6e1a71b799e21722635b316d2a3b11"></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">Visit</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="#_CPPv4N5arrow10StringTypeE" title="arrow::StringType"><span class="n"><span class="pre">StringType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10StringType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14StringViewType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14StringViewType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14StringViewType"></span><span id="arrow::TypeVisitor::Visit__StringViewTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a61cc4f33e6ddb641bd4232a4ed5031d3"></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">Visit</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="#_CPPv4N5arrow14StringViewTypeE" title="arrow::StringViewType"><span class="n"><span class="pre">StringViewType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14StringViewType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10BinaryType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10BinaryType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10BinaryType"></span><span id="arrow::TypeVisitor::Visit__BinaryTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ab948afdb6a5dcb1e382455c22cff1a99"></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">Visit</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="#_CPPv4N5arrow10BinaryTypeE" title="arrow::BinaryType"><span class="n"><span class="pre">BinaryType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10BinaryType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14BinaryViewType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14BinaryViewType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14BinaryViewType"></span><span id="arrow::TypeVisitor::Visit__BinaryViewTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a704775cd2d01ee0aa53e71c8633b6baf"></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">Visit</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="#_CPPv4N5arrow14BinaryViewTypeE" title="arrow::BinaryViewType"><span class="n"><span class="pre">BinaryViewType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14BinaryViewType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK15LargeStringType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK15LargeStringType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK15LargeStringType"></span><span id="arrow::TypeVisitor::Visit__LargeStringTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a7bd8e6f4160f8005d5598e2bfa3dbc89"></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">Visit</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="#_CPPv4N5arrow15LargeStringTypeE" title="arrow::LargeStringType"><span class="n"><span class="pre">LargeStringType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK15LargeStringType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK15LargeBinaryType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK15LargeBinaryType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK15LargeBinaryType"></span><span id="arrow::TypeVisitor::Visit__LargeBinaryTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a61d9c2e5fb66396fba285d16e1923e29"></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">Visit</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="#_CPPv4N5arrow15LargeBinaryTypeE" title="arrow::LargeBinaryType"><span class="n"><span class="pre">LargeBinaryType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK15LargeBinaryType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK19FixedSizeBinaryType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK19FixedSizeBinaryType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK19FixedSizeBinaryType"></span><span id="arrow::TypeVisitor::Visit__FixedSizeBinaryTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ae7e95a1aa7024caa8c6ec22a42f9f2be"></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">Visit</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="#_CPPv4N5arrow19FixedSizeBinaryTypeE" title="arrow::FixedSizeBinaryType"><span class="n"><span class="pre">FixedSizeBinaryType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK19FixedSizeBinaryType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10Date64Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10Date64Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10Date64Type"></span><span id="arrow::TypeVisitor::Visit__Date64TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a2d4c7137cf9fdb186be9b1a52fd9e6a4"></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">Visit</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="#_CPPv4N5arrow10Date64TypeE" title="arrow::Date64Type"><span class="n"><span class="pre">Date64Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10Date64Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10Date32Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10Date32Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10Date32Type"></span><span id="arrow::TypeVisitor::Visit__Date32TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1adf7180c5ca418c893a017339b77ff56d"></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">Visit</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="#_CPPv4N5arrow10Date32TypeE" title="arrow::Date32Type"><span class="n"><span class="pre">Date32Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10Date32Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10Time32Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10Time32Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10Time32Type"></span><span id="arrow::TypeVisitor::Visit__Time32TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a3d68e6a3afa0754f7694cd3804448285"></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">Visit</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="#_CPPv4N5arrow10Time32TypeE" title="arrow::Time32Type"><span class="n"><span class="pre">Time32Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10Time32Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10Time64Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10Time64Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10Time64Type"></span><span id="arrow::TypeVisitor::Visit__Time64TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ad4e28817644add206439ac542cda4d5f"></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">Visit</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="#_CPPv4N5arrow10Time64TypeE" title="arrow::Time64Type"><span class="n"><span class="pre">Time64Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10Time64Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK13TimestampType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK13TimestampType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK13TimestampType"></span><span id="arrow::TypeVisitor::Visit__TimestampTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ab4285cbc9d8bc9fad2095258ebf2f8b1"></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">Visit</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="#_CPPv4N5arrow13TimestampTypeE" title="arrow::TimestampType"><span class="n"><span class="pre">TimestampType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK13TimestampType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK24MonthDayNanoIntervalType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK24MonthDayNanoIntervalType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK24MonthDayNanoIntervalType"></span><span id="arrow::TypeVisitor::Visit__MonthDayNanoIntervalTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ae29c53238615e568d9a1553207a8c9a4"></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">Visit</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="#_CPPv4N5arrow24MonthDayNanoIntervalTypeE" title="arrow::MonthDayNanoIntervalType"><span class="n"><span class="pre">MonthDayNanoIntervalType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK24MonthDayNanoIntervalType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK17MonthIntervalType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK17MonthIntervalType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK17MonthIntervalType"></span><span id="arrow::TypeVisitor::Visit__MonthIntervalTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ab15c03d9e8271a6a965e9b9787cbf8c9"></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">Visit</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="#_CPPv4N5arrow17MonthIntervalTypeE" title="arrow::MonthIntervalType"><span class="n"><span class="pre">MonthIntervalType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK17MonthIntervalType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK19DayTimeIntervalType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK19DayTimeIntervalType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK19DayTimeIntervalType"></span><span id="arrow::TypeVisitor::Visit__DayTimeIntervalTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1acac40cabb66d600edc6faf8b4cb5a875"></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">Visit</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="#_CPPv4N5arrow19DayTimeIntervalTypeE" title="arrow::DayTimeIntervalType"><span class="n"><span class="pre">DayTimeIntervalType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK19DayTimeIntervalType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK12DurationType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK12DurationType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK12DurationType"></span><span id="arrow::TypeVisitor::Visit__DurationTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a6a21d056a92040e78c43c257a5e69cbb"></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">Visit</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="#_CPPv4N5arrow12DurationTypeE" title="arrow::DurationType"><span class="n"><span class="pre">DurationType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK12DurationType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14Decimal128Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14Decimal128Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14Decimal128Type"></span><span id="arrow::TypeVisitor::Visit__Decimal128TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1aa09848f2b9edf5cec9df14e8272cf307"></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">Visit</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="#_CPPv4N5arrow14Decimal128TypeE" title="arrow::Decimal128Type"><span class="n"><span class="pre">Decimal128Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14Decimal128Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14Decimal256Type"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14Decimal256Type"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14Decimal256Type"></span><span id="arrow::TypeVisitor::Visit__Decimal256TypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a0ba2624cfb751177b1b5d14fe0372712"></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">Visit</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="#_CPPv4N5arrow14Decimal256TypeE" title="arrow::Decimal256Type"><span class="n"><span class="pre">Decimal256Type</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14Decimal256Type" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK8ListType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK8ListType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK8ListType"></span><span id="arrow::TypeVisitor::Visit__ListTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a7395ff74033bc86501e70c4a5be3fbf7"></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">Visit</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="#_CPPv4N5arrow8ListTypeE" title="arrow::ListType"><span class="n"><span class="pre">ListType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK8ListType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK13LargeListType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK13LargeListType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK13LargeListType"></span><span id="arrow::TypeVisitor::Visit__LargeListTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1abac7da56f3b2e959506fa9b5538ae1de"></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">Visit</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="#_CPPv4N5arrow13LargeListTypeE" title="arrow::LargeListType"><span class="n"><span class="pre">LargeListType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK13LargeListType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK12ListViewType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK12ListViewType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK12ListViewType"></span><span id="arrow::TypeVisitor::Visit__ListViewTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ad9fc44cf457a026ba7b9af027ab35f08"></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">Visit</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="#_CPPv4N5arrow12ListViewTypeE" title="arrow::ListViewType"><span class="n"><span class="pre">ListViewType</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="#_CPPv4N5arrow11TypeVisitor5VisitERK12ListViewType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK17LargeListViewType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK17LargeListViewType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK17LargeListViewType"></span><span id="arrow::TypeVisitor::Visit__LargeListViewTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a2889a50e5a455b1ce732bf6a47082b67"></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">Visit</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="#_CPPv4N5arrow17LargeListViewTypeE" title="arrow::LargeListViewType"><span class="n"><span class="pre">LargeListViewType</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="#_CPPv4N5arrow11TypeVisitor5VisitERK17LargeListViewType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK7MapType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK7MapType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK7MapType"></span><span id="arrow::TypeVisitor::Visit__MapTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1ac1f32029422a922ae2e4a113de4cd5cc"></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">Visit</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="#_CPPv4N5arrow7MapTypeE" title="arrow::MapType"><span class="n"><span class="pre">MapType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK7MapType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK17FixedSizeListType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK17FixedSizeListType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK17FixedSizeListType"></span><span id="arrow::TypeVisitor::Visit__FixedSizeListTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a98230ee04a2ec59b2dfc2ea305c6ad24"></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">Visit</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="#_CPPv4N5arrow17FixedSizeListTypeE" title="arrow::FixedSizeListType"><span class="n"><span class="pre">FixedSizeListType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK17FixedSizeListType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK10StructType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK10StructType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK10StructType"></span><span id="arrow::TypeVisitor::Visit__StructTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a7389dfe51ae4f987de7a2eff92821265"></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">Visit</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="#_CPPv4N5arrow10StructTypeE" title="arrow::StructType"><span class="n"><span class="pre">StructType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK10StructType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK15SparseUnionType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK15SparseUnionType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK15SparseUnionType"></span><span id="arrow::TypeVisitor::Visit__SparseUnionTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a6b4cbd41e0f94680bff92da1a7e904e5"></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">Visit</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="#_CPPv4N5arrow15SparseUnionTypeE" title="arrow::SparseUnionType"><span class="n"><span class="pre">SparseUnionType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK15SparseUnionType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14DenseUnionType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14DenseUnionType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14DenseUnionType"></span><span id="arrow::TypeVisitor::Visit__DenseUnionTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a3823e9593b57ec51c1008490f8ab28c5"></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">Visit</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="#_CPPv4N5arrow14DenseUnionTypeE" title="arrow::DenseUnionType"><span class="n"><span class="pre">DenseUnionType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14DenseUnionType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK14DictionaryType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK14DictionaryType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK14DictionaryType"></span><span id="arrow::TypeVisitor::Visit__DictionaryTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a8847aa924097ea61f3e4db49a30aa0a2"></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">Visit</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="#_CPPv4N5arrow14DictionaryTypeE" title="arrow::DictionaryType"><span class="n"><span class="pre">DictionaryType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK14DictionaryType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK17RunEndEncodedType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK17RunEndEncodedType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK17RunEndEncodedType"></span><span id="arrow::TypeVisitor::Visit__RunEndEncodedTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a9883d71a9994c9ea8d9081315a8a7ca9"></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">Visit</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="#_CPPv4N5arrow17RunEndEncodedTypeE" title="arrow::RunEndEncodedType"><span class="n"><span class="pre">RunEndEncodedType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK17RunEndEncodedType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| <dl class="cpp function"> |
| <dt class="sig sig-object cpp" id="_CPPv4N5arrow11TypeVisitor5VisitERK13ExtensionType"> |
| <span id="_CPPv3N5arrow11TypeVisitor5VisitERK13ExtensionType"></span><span id="_CPPv2N5arrow11TypeVisitor5VisitERK13ExtensionType"></span><span id="arrow::TypeVisitor::Visit__ExtensionTypeCR"></span><span class="target" id="classarrow_1_1_type_visitor_1a6b283d91a65cf8cde5d317bae9306b16"></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">Visit</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="#_CPPv4N5arrow13ExtensionTypeE" title="arrow::ExtensionType"><span class="n"><span class="pre">ExtensionType</span></span></a><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="#_CPPv4N5arrow11TypeVisitor5VisitERK13ExtensionType" title="Permalink to this definition">#</a><br /></dt> |
| <dd></dd></dl> |
| |
| </div> |
| </dd></dl> |
| |
| </section> |
| </section> |
| |
| |
| </article> |
| |
| |
| |
| |
| |
| <footer class="prev-next-footer"> |
| |
| <div class="prev-next-area"> |
| <a class="left-prev" |
| href="thread.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">Thread (management)</p> |
| </div> |
| </a> |
| <a class="right-next" |
| href="array.html" |
| title="next page"> |
| <div class="prev-next-info"> |
| <p class="prev-next-subtitle">next</p> |
| <p class="prev-next-title">Arrays</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="#factory-functions">Factory functions</a></li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#concrete-type-subclasses">Concrete type 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> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#extension-types">Extension types</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#fields-and-schemas">Fields and Schemas</a><ul class="visible nav section-nav flex-column"> |
| <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#helpers-for-looking-up-fields">Helpers for looking up fields</a></li> |
| </ul> |
| </li> |
| <li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#utilities">Utilities</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/datatype.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> |
